Package org.jboss.resteasy.plugins.server.servlet

Class HttpServletInputMessage

java.lang.Object

org.jboss.resteasy.plugins.server.BaseHttpRequest

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

All Implemented Interfaces:

HttpRequest

Direct Known Subclasses:

Servlet3AsyncHttpRequest

public class HttpServletInputMessage
extends BaseHttpRequest

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	Description
protected SynchronousDispatcher	dispatcher
protected SynchronousExecutionContext	executionContext
protected ResteasyHttpHeaders	httpHeaders
protected String	httpMethod
protected HttpResponse	httpResponse
protected InputStream	overridenStream
protected HttpServletRequest	request
protected ServletContext	servletContext
protected HttpServletResponse	servletResponse
protected boolean	wasForwarded

Fields inherited from class org.jboss.resteasy.plugins.server.BaseHttpRequest

decodedFormParameters, formParameters, uri

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	formParametersRead()	Were form parameters read before marshalling to body?
void	forward(String path)
ResteasyAsynchronousContext	getAsyncContext()
Object	getAttribute(String attribute)	Map of contextual data.
Enumeration<String>	getAttributeNames()
MultivaluedMap<String,String>	getDecodedFormParameters()
Optional<EntityPart>	getFormEntityPart(String name)	Returns the optional entity part for a multipart/form-data request.
List<EntityPart>	getFormEntityParts()	Returns for entity parts for a multipart/form-data request.
MultivaluedMap<String,String>	getFormParameters()	application/x-www-form-urlencoded parameters
HttpHeaders	getHttpHeaders()
String	getHttpMethod()
InputStream	getInputStream()
MultivaluedMap<String,String>	getMutableHeaders()
MultivaluedMap<String,String>	getPutDecodedFormParameters()
MultivaluedMap<String,String>	getPutFormParameters()
String	getRemoteAddress()	Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
String	getRemoteHost()	Returns the fully qualified name of the client or the last proxy that sent the request.
protected boolean	mapEquals(Map<String,String[]> parameterMap, MultivaluedMap<String,String> queryMap)
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().
boolean	wasForwarded()

Methods inherited from class org.jboss.resteasy.plugins.server.BaseHttpRequest

getUri, isInitial, setRequestUri, setRequestUri

Methods inherited from class java.lang.Object

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

Field Details

httpHeaders

protected ResteasyHttpHeaders httpHeaders

request

protected HttpServletRequest request

servletResponse

protected HttpServletResponse servletResponse

servletContext

protected ServletContext servletContext

dispatcher

protected SynchronousDispatcher dispatcher

httpResponse

protected HttpResponse httpResponse

httpMethod

protected String httpMethod

overridenStream

protected InputStream overridenStream

executionContext

protected SynchronousExecutionContext executionContext

wasForwarded

protected boolean wasForwarded

Constructor Details

HttpServletInputMessage

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

Method Details

getMutableHeaders

public MultivaluedMap<String,String> getMutableHeaders()

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

Parameters:

attribute - attribute name

Returns:

attribute

setAttribute

public void setAttribute(String name,
 Object value)

removeAttribute

public void removeAttribute(String name)

getAttributeNames

public Enumeration<String> getAttributeNames()

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

Overrides:

getFormParameters in class BaseHttpRequest

Returns:

null if no parameters, this is encoded map

getFormEntityPart

public Optional<EntityPart> getFormEntityPart(String name)

Description copied from interface: HttpRequest

Returns the optional entity part for a multipart/form-data request.

Parameters:

name - the name of the entity part

Returns:

an optional entity part for the name

getFormEntityParts

public List<EntityPart> getFormEntityParts()

Description copied from interface: HttpRequest

Returns for entity parts for a multipart/form-data request.

Returns:

the entity parts or an empty list

getDecodedFormParameters

public MultivaluedMap<String,String> getDecodedFormParameters()

Specified by:

getDecodedFormParameters in interface HttpRequest

Overrides:

getDecodedFormParameters in class BaseHttpRequest

formParametersRead

public boolean formParametersRead()

Description copied from interface: HttpRequest

Were form parameters read before marshalling to body?

Specified by:

formParametersRead in interface HttpRequest

Overrides:

formParametersRead in class BaseHttpRequest

Returns:

getHttpHeaders

public HttpHeaders getHttpHeaders()

getInputStream

public InputStream getInputStream()

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

Parameters:

stream - input stream

getHttpMethod

public String getHttpMethod()

setHttpMethod

public void setHttpMethod(String method)

getAsyncContext

public ResteasyAsynchronousContext getAsyncContext()

forward

public void forward(String path)

wasForwarded

public boolean wasForwarded()

mapEquals

protected boolean mapEquals(Map<String,String[]> parameterMap,
 MultivaluedMap<String,String> queryMap)

getRemoteHost

public String getRemoteHost()

Description copied from interface: HttpRequest

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address.

Returns:

a String containing the fully qualified name of the client

getRemoteAddress

public String getRemoteAddress()

Description copied from interface: HttpRequest

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.

Returns:

a String containing the IP address of the client that sent the request