Package org.jboss.resteasy.spi
Interface HttpRequest
-
- All Known Implementing Classes:
BaseHttpRequest
,DelegatingHttpRequest
,HttpServletInputMessage
,MockHttpRequest
,PrefixedFormFieldsHttpRequest
,Servlet3AsyncHttpRequest
public interface HttpRequest
Bridge interface between the base Resteasy JAX-RS implementation and the actual HTTP transport (i.e. a servlet container)- Version:
- $Revision: 1 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
forward(java.lang.String path)
ResteasyAsynchronousContext
getAsyncContext()
java.lang.Object
getAttribute(java.lang.String attribute)
Map of contextual data.java.util.Enumeration<java.lang.String>
getAttributeNames()
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String>
getDecodedFormParameters()
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String>
getFormParameters()
application/x-www-form-urlencoded parametersjavax.ws.rs.core.HttpHeaders
getHttpHeaders()
java.lang.String
getHttpMethod()
java.io.InputStream
getInputStream()
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String>
getMutableHeaders()
ResteasyUriInfo
getUri()
This method *MUST* always return the same instance.boolean
isInitial()
void
removeAttribute(java.lang.String name)
void
setAttribute(java.lang.String name, java.lang.Object value)
void
setHttpMethod(java.lang.String method)
void
setInputStream(java.io.InputStream stream)
If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream().void
setRequestUri(java.net.URI requestUri)
Updates the object returned bygetUri()
.void
setRequestUri(java.net.URI baseUri, java.net.URI requestUri)
Updates the object returned bygetUri()
.boolean
wasForwarded()
-
-
-
Method Detail
-
getHttpHeaders
javax.ws.rs.core.HttpHeaders getHttpHeaders()
-
getMutableHeaders
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getMutableHeaders()
-
getInputStream
java.io.InputStream getInputStream()
-
setInputStream
void setInputStream(java.io.InputStream stream)
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
-
-
getUri
ResteasyUriInfo getUri()
This method *MUST* always return the same instance.
-
getHttpMethod
java.lang.String getHttpMethod()
-
setHttpMethod
void setHttpMethod(java.lang.String method)
-
setRequestUri
void setRequestUri(java.net.URI requestUri) throws java.lang.IllegalStateException
Updates the object returned bygetUri()
.- Throws:
java.lang.IllegalStateException
-
setRequestUri
void setRequestUri(java.net.URI baseUri, java.net.URI requestUri) throws java.lang.IllegalStateException
Updates the object returned bygetUri()
.- Throws:
java.lang.IllegalStateException
-
getFormParameters
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.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- Returns:
- null if no parameters, this is encoded map
-
getDecodedFormParameters
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getDecodedFormParameters()
-
getAttribute
java.lang.Object getAttribute(java.lang.String attribute)
Map of contextual data. Similar to HttpServletRequest attributes- Returns:
-
setAttribute
void setAttribute(java.lang.String name, java.lang.Object value)
-
removeAttribute
void removeAttribute(java.lang.String name)
-
getAttributeNames
java.util.Enumeration<java.lang.String> getAttributeNames()
-
getAsyncContext
ResteasyAsynchronousContext getAsyncContext()
-
isInitial
boolean isInitial()
-
forward
void forward(java.lang.String path)
-
wasForwarded
boolean wasForwarded()
-
-