org.jboss.resteasy.plugins.server.servlet

Class HttpServletInputMessage

java.lang.Object

org.jboss.resteasy.plugins.server.servlet.HttpServletInputMessage

All Implemented Interfaces:

HttpRequest

Direct Known Subclasses:

Servlet3AsyncHttpRequest

public class HttpServletInputMessage
extends Object
implements HttpRequest

Abstraction for an inbound http request on the server, or a response from a server to a client

We have this abstraction so that we can reuse marshalling objects in a client framework and serverside framework

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected MultivaluedMap<String,String>	decodedFormParameters
protected SynchronousDispatcher	dispatcher
protected SynchronousExecutionContext	executionContext
protected MultivaluedMap<String,String>	formParameters
protected ResteasyHttpHeaders	httpHeaders
protected String	httpMethod
protected HttpResponse	httpResponse
protected InputStream	overridenStream
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.ServletContext	servletContext
protected javax.servlet.http.HttpServletResponse	servletResponse
protected ResteasyUriInfo	uri
protected boolean	wasForwarded

Constructor Summary

Constructors

Constructor and Description
HttpServletInputMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse servletResponse, javax.servlet.ServletContext servletContext, HttpResponse httpResponse, ResteasyHttpHeaders httpHeaders, ResteasyUriInfo uri, String httpMethod, SynchronousDispatcher dispatcher)

Method Summary

Methods

Modifier and Type	Method and Description
void	forward(String path)
ResteasyAsynchronousContext	getAsyncContext()
Object	getAttribute(String attribute) Map of contextual data.
Enumeration<String>	getAttributeNames()
MultivaluedMap<String,String>	getDecodedFormParameters()
MultivaluedMap<String,String>	getFormParameters() application/x-www-form-urlencoded parameters This is here because @FormParam needs it and for when there are servlet filters that eat up the input stream
HttpHeaders	getHttpHeaders()
String	getHttpMethod()
InputStream	getInputStream()
MultivaluedMap<String,String>	getMutableHeaders()
MultivaluedMap<String,String>	getPutDecodedFormParameters()
MultivaluedMap<String,String>	getPutFormParameters()
ResteasyUriInfo	getUri()
boolean	isInitial()
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setHttpMethod(String method)
void	setInputStream(InputStream stream) If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream().
void	setRequestUri(URI requestUri)
void	setRequestUri(URI baseUri, URI requestUri)
boolean	wasForwarded()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpHeaders

protected ResteasyHttpHeaders httpHeaders

request

protected javax.servlet.http.HttpServletRequest request

servletResponse

protected javax.servlet.http.HttpServletResponse servletResponse

servletContext

protected javax.servlet.ServletContext servletContext

dispatcher

protected SynchronousDispatcher dispatcher

httpResponse

protected HttpResponse httpResponse

uri

protected ResteasyUriInfo uri

httpMethod

protected String httpMethod

formParameters

protected MultivaluedMap<String,String> formParameters

decodedFormParameters

protected MultivaluedMap<String,String> decodedFormParameters

overridenStream

protected InputStream overridenStream

executionContext

protected SynchronousExecutionContext executionContext

wasForwarded

protected boolean wasForwarded

Constructor Detail

HttpServletInputMessage

public HttpServletInputMessage(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse servletResponse,
                       javax.servlet.ServletContext servletContext,
                       HttpResponse httpResponse,
                       ResteasyHttpHeaders httpHeaders,
                       ResteasyUriInfo uri,
                       String httpMethod,
                       SynchronousDispatcher dispatcher)

Method Detail

getMutableHeaders

public MultivaluedMap<String,String> getMutableHeaders()

Specified by:

getMutableHeaders in interface HttpRequest

setRequestUri

public void setRequestUri(URI requestUri)
                   throws IllegalStateException

Specified by:

setRequestUri in interface HttpRequest

Throws:

IllegalStateException

setRequestUri

public void setRequestUri(URI baseUri,
                 URI requestUri)
                   throws IllegalStateException

Specified by:

setRequestUri in interface HttpRequest

Throws:

IllegalStateException

getPutFormParameters

public MultivaluedMap<String,String> getPutFormParameters()

getPutDecodedFormParameters

public MultivaluedMap<String,String> getPutDecodedFormParameters()

getAttribute

public Object getAttribute(String attribute)

Description copied from interface: HttpRequest

Map of contextual data. Similar to HttpServletRequest attributes

Specified by:

getAttribute in interface HttpRequest

Returns:

setAttribute

public void setAttribute(String name,
                Object value)

Specified by:

setAttribute in interface HttpRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface HttpRequest

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface HttpRequest

getFormParameters

public MultivaluedMap<String,String> getFormParameters()

Description copied from interface: HttpRequest

application/x-www-form-urlencoded parameters

This is here because @FormParam needs it and for when there are servlet filters that eat up the input stream

Specified by:

getFormParameters in interface HttpRequest

Returns:

null if no parameters, this is encoded map

getDecodedFormParameters

public MultivaluedMap<String,String> getDecodedFormParameters()

Specified by:

getDecodedFormParameters in interface HttpRequest

getHttpHeaders

public HttpHeaders getHttpHeaders()

Specified by:

getHttpHeaders in interface HttpRequest

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface HttpRequest

setInputStream

public void setInputStream(InputStream stream)

Description copied from interface: HttpRequest

If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream(). It will only override it for the resteasy HttpRequest

Specified by:

setInputStream in interface HttpRequest

getUri

public ResteasyUriInfo getUri()

Specified by:

getUri in interface HttpRequest

getHttpMethod

public String getHttpMethod()

Specified by:

getHttpMethod in interface HttpRequest

setHttpMethod

public void setHttpMethod(String method)

Specified by:

setHttpMethod in interface HttpRequest

getAsyncContext

public ResteasyAsynchronousContext getAsyncContext()

Specified by:

getAsyncContext in interface HttpRequest

isInitial

public boolean isInitial()

Specified by:

isInitial in interface HttpRequest

forward

public void forward(String path)

Specified by:

forward in interface HttpRequest

wasForwarded

public boolean wasForwarded()

Specified by:

wasForwarded in interface HttpRequest