org.jboss.resteasy.spi
Interface HttpRequest

All Known Implementing Classes:
HttpRequestImpl, HttpServletInputMessage, JBossWebAsyncHttpRequest, MockHttpRequest, Servlet3AsyncHttpRequest, Tomcat6AsyncHttpRequest

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 $
Author:
Bill Burke

Method Summary
 AsynchronousResponse createAsynchronousResponse(long suspendTimeout)
          This method will create an asynchronous response and prepare the request to be issued asynchronously
 AsynchronousResponse getAsynchronousResponse()
          Returns the AsynchronousResponse created by createAsynchronousResponse
 java.lang.Object getAttribute(java.lang.String attribute)
          Map of contextual data.
 MultivaluedMap<java.lang.String,java.lang.String> getDecodedFormParameters()
           
 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

 HttpHeaders getHttpHeaders()
           
 java.lang.String getHttpMethod()
           
 java.io.InputStream getInputStream()
           
 java.lang.String getPreprocessedPath()
          Encoded preprocessed path with extension mappings and matrix parameters removed
 UriInfo getUri()
           
 void initialRequestThreadFinished()
          Callback by the initial calling thread.
 boolean isInitial()
          Asynchronous HTTP support.
 boolean isSuspended()
          Asynchronous HTTP support.
 void removeAttribute(java.lang.String name)
           
 void setAttribute(java.lang.String name, java.lang.Object value)
           
 void setInputStream(java.io.InputStream stream)
          If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream().
 void setPreprocessedPath(java.lang.String path)
           
 

Method Detail

getHttpHeaders

HttpHeaders getHttpHeaders()

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

UriInfo getUri()

getHttpMethod

java.lang.String getHttpMethod()

getPreprocessedPath

java.lang.String getPreprocessedPath()
Encoded preprocessed path with extension mappings and matrix parameters removed

Returns:

setPreprocessedPath

void setPreprocessedPath(java.lang.String path)

getFormParameters

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

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)

isInitial

boolean isInitial()
Asynchronous HTTP support. Mirrors Servlet 3.0 API


isSuspended

boolean isSuspended()
Asynchronous HTTP support. Mirrors Servlet 3.0 API


createAsynchronousResponse

AsynchronousResponse createAsynchronousResponse(long suspendTimeout)
This method will create an asynchronous response and prepare the request to be issued asynchronously

Returns:

getAsynchronousResponse

AsynchronousResponse getAsynchronousResponse()
Returns the AsynchronousResponse created by createAsynchronousResponse

Returns:

initialRequestThreadFinished

void initialRequestThreadFinished()
Callback by the initial calling thread. This callback will probably do nothing in an asynchronous environment but will be used to simulate AsynchronousResponse in vanilla Servlet containers that do not support asychronous HTTP.



Copyright © 2009. All Rights Reserved.