MockHttpRequest (Red Hat JBoss Enterprise Application Platform 6.4.19.GA public API)

java.lang.Object
- org.jboss.resteasy.mock.MockHttpRequest

All Implemented Interfaces:

HttpRequest
```
public class MockHttpRequest
extends Object
implements HttpRequest
```
Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`attributes`
`protected MultivaluedMap<String,String>`	`decodedFormParameters`
`protected static URI`	`EMPTY_URI`
`protected MultivaluedMap<String,String>`	`formParameters`
`protected HttpHeadersImpl`	`httpHeaders`
`protected String`	`httpMethod`
`protected InputStream`	`inputStream`
`protected String`	`preprocessedPath`
`protected UriInfo`	`uri`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MockHttpRequest()

Constructors
Modifier	Constructor and Description
`protected`	`MockHttpRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`MockHttpRequest`	`accept(List<MediaType> accepts)`
`MockHttpRequest`	`accept(String type)`
`MockHttpRequest`	`addFormHeader(String name, String value)` Set CONTENT-TYPE to ""application/x-www-form-urlencoded"
`void`	`complete()`
`MockHttpRequest`	`content(byte[] bytes)`
`MockHttpRequest`	`content(InputStream stream)`
`MockHttpRequest`	`contentType(MediaType type)`
`MockHttpRequest`	`contentType(String type)`
`MockHttpRequest`	`cookie(String name, String value)`
`static MockHttpRequest`	`create(String httpMethod, String uri)`
`static MockHttpRequest`	`create(String httpMethod, URI uriObj, URI baseUri)`
`AsynchronousResponse`	`createAsynchronousResponse(long suspendTimeout)` This method will create an asynchronous response and prepare the request to be issued asynchronously
`static MockHttpRequest`	`deepCopy(HttpRequest request)`
`static MockHttpRequest`	`delete(String uri)`
`static MockHttpRequest`	`get(String uri)`
`AsynchronousResponse`	`getAsynchronousResponse()` Returns the AsynchronousResponse created by createAsynchronousResponse
`Object`	`getAttribute(String attribute)` Map of contextual data.
`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()`
`String`	`getPreprocessedPath()` Encoded preprocessed path with extension mappings and matrix parameters removed
`UriInfo`	`getUri()`
`static MockHttpRequest`	`head(String uri)`
`MockHttpRequest`	`header(String name, String value)`
`void`	`initialRequestThreadFinished()` Callback by the initial calling thread.
`protected static MockHttpRequest`	`initWithUri(String uri)`
`boolean`	`isInitial()` Asynchronous HTTP support.
`boolean`	`isSuspended()` Asynchronous HTTP support.
`boolean`	`isTimeout()`
`MockHttpRequest`	`language(String language)`
`static MockHttpRequest`	`post(String uri)`
`static MockHttpRequest`	`put(String uri)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setInputStream(InputStream stream)` If you are using a servlet container, this will NOT override the HttpServletRequest.getInputStream().
`void`	`setPreprocessedPath(String path)`
`void`	`suspend()`
`void`	`suspend(long timeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpHeaders
```
protected HttpHeadersImpl httpHeaders
```

inputStream
```
protected InputStream inputStream
```

uri
```
protected UriInfo uri
```

httpMethod
```
protected String httpMethod
```

preprocessedPath
```
protected String preprocessedPath
```

formParameters

protected MultivaluedMap<String,String> formParameters

decodedFormParameters

protected MultivaluedMap<String,String> decodedFormParameters

attributes

protected Map<String,Object> attributes

EMPTY_URI
```
protected static final URI EMPTY_URI
```

Constructor Detail
- MockHttpRequest
```
protected MockHttpRequest()
```

Method Detail
- initWithUri
```
protected static MockHttpRequest initWithUri(String uri)
                                      throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- create
```
public static MockHttpRequest create(String httpMethod,
                     String uri)
                              throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- create
```
public static MockHttpRequest create(String httpMethod,
                     URI uriObj,
                     URI baseUri)
```
- get
```
public static MockHttpRequest get(String uri)
                           throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- post
```
public static MockHttpRequest post(String uri)
                            throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- put
```
public static MockHttpRequest put(String uri)
                           throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- delete
```
public static MockHttpRequest delete(String uri)
                              throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- head
```
public static MockHttpRequest head(String uri)
                            throws URISyntaxException
```
  Throws:
  
  URISyntaxException
- deepCopy
```
public static MockHttpRequest deepCopy(HttpRequest request)
                                throws IOException
```
  Throws:
  
  IOException
- header
```
public MockHttpRequest header(String name,
                     String value)
```
- accept
```
public MockHttpRequest accept(List<MediaType> accepts)
```
- accept
```
public MockHttpRequest accept(String type)
```
- language
```
public MockHttpRequest language(String language)
```
- cookie
```
public MockHttpRequest cookie(String name,
                     String value)
```
- contentType
```
public MockHttpRequest contentType(String type)
```
- contentType
```
public MockHttpRequest contentType(MediaType type)
```
- content
```
public MockHttpRequest content(byte[] bytes)
```
- content
```
public MockHttpRequest content(InputStream stream)
```
- addFormHeader
```
public MockHttpRequest addFormHeader(String name,
                            String value)
```
  Set CONTENT-TYPE to ""application/x-www-form-urlencoded"
  
  Parameters:
  name -
  value -
  
  Returns:
- 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 UriInfo getUri()
```
  Specified by:
  
  getUri in interface HttpRequest
- getHttpMethod
```
public String getHttpMethod()
```
  Specified by:
  
  getHttpMethod 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
- getPreprocessedPath
```
public String getPreprocessedPath()
```
  Description copied from interface: HttpRequest
  
  Encoded preprocessed path with extension mappings and matrix parameters removed
  
  Specified by:
  
  getPreprocessedPath in interface HttpRequest
  
  Returns:
- setPreprocessedPath
```
public void setPreprocessedPath(String path)
```
  Specified by:
  
  setPreprocessedPath in interface HttpRequest
- suspend
```
public void suspend()
```
- suspend
```
public void suspend(long timeout)
```
- complete
```
public void complete()
```
- isInitial
```
public boolean isInitial()
```
  Description copied from interface: HttpRequest
  
  Asynchronous HTTP support. Mirrors Servlet 3.0 API
  
  Specified by:
  
  isInitial in interface HttpRequest
- isSuspended
```
public boolean isSuspended()
```
  Description copied from interface: HttpRequest
  
  Asynchronous HTTP support. Mirrors Servlet 3.0 API
  
  Specified by:
  
  isSuspended in interface HttpRequest
- isTimeout
```
public boolean isTimeout()
```
- createAsynchronousResponse
```
public AsynchronousResponse createAsynchronousResponse(long suspendTimeout)
```
  Description copied from interface: HttpRequest
  
  This method will create an asynchronous response and prepare the request to be issued asynchronously
  
  Specified by:
  
  createAsynchronousResponse in interface HttpRequest
  
  Returns:
- getAsynchronousResponse
```
public AsynchronousResponse getAsynchronousResponse()
```
  Description copied from interface: HttpRequest
  
  Returns the AsynchronousResponse created by createAsynchronousResponse
  
  Specified by:
  
  getAsynchronousResponse in interface HttpRequest
  
  Returns:
- initialRequestThreadFinished
```
public void initialRequestThreadFinished()
```
  Description copied from interface: HttpRequest
  
  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.
  
  Specified by:
  
  initialRequestThreadFinished in interface HttpRequest
- 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

Class MockHttpRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpHeaders

inputStream

uri

httpMethod

preprocessedPath

formParameters

decodedFormParameters

attributes

EMPTY_URI

Constructor Detail

MockHttpRequest

Method Detail

initWithUri

create

create

get

post

put

delete

head

deepCopy

header

accept

accept

language

cookie

contentType

contentType

content

content

addFormHeader

getHttpHeaders

getInputStream

setInputStream

getUri

getHttpMethod

getFormParameters

getDecodedFormParameters

getPreprocessedPath

setPreprocessedPath

suspend

suspend

complete

isInitial

isSuspended

isTimeout

createAsynchronousResponse

getAsynchronousResponse

initialRequestThreadFinished

getAttribute

setAttribute

removeAttribute