FakeRequest (wisdom-test 0.6.2 API)

java.lang.Object
- org.wisdom.api.http.RequestHeader
- - org.wisdom.api.http.Request
  - - org.wisdom.test.parents.FakeRequest

public class FakeRequest
extends org.wisdom.api.http.Request

A fake implementation of request.

Field Summary

Fields
Modifier and Type Field and Description

private FakeContext context

private Map<String,Object> data

Fields
Modifier and Type	Field and Description
`private FakeContext`	`context`
`private Map<String,Object>`	`data`

Constructor Summary

Constructors
Constructor and Description

FakeRequest(FakeContext fakeContext)

Constructors
Constructor and Description
`FakeRequest(FakeContext fakeContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accepts(String mimeType)` Checks if this request accepts a given media type.
`String`	`charset()` Get the charset that is acceptable for the client.
`String`	`contentType()` The Content-Type header field indicates the media type of the request body sent to the recipient.
`org.wisdom.api.cookies.Cookies`	`cookies()`
`Map<String,Object>`	`data()` Retrieves the data shared by all the entities participating to the request resolution (i.e.
`String`	`encoding()` Get the encoding that is acceptable for the client.
`Map<String,List<String>>`	`headers()` Retrieves all headers.
`String`	`host()`
`String`	`language()` Get the language that is acceptable for the client.
`com.google.common.net.MediaType`	`mediaType()`
`Collection<com.google.common.net.MediaType>`	`mediaTypes()`
`String`	`method()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`parameter(String name)` Get the parameter with the given key from the request.
`String`	`parameter(String name, String defaultValue)` Same like `parameter(String)`, but returns given defaultValue instead of null in case parameter cannot be found.
`Boolean`	`parameterAsBoolean(String name)` Same like `parameter(String)`, but converts the parameter to Boolean if found.
`Boolean`	`parameterAsBoolean(String name, boolean defaultValue)` Same like `parameter(String)`, but converts the parameter to Boolean if found.
`Integer`	`parameterAsInteger(String name)` Same like `parameter(String)`, but converts the parameter to Integer if found.
`Integer`	`parameterAsInteger(String name, Integer defaultValue)` Same like `parameter(String, String)`, but converts the parameter to Integer if found.
`List<String>`	`parameterMultipleValues(String name)` Get the parameter with the given key from the request.
`Map<String,List<String>>`	`parameters()` Get all the parameters from the request.
`String`	`path()`
`String`	`remoteAddress()` The client IP address.
`String`	`uri()`

Methods inherited from class org.wisdom.api.http.Request
setUsername, username

Methods inherited from class org.wisdom.api.http.RequestHeader
cookie, getHeader, getLocaleList, languages

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

- Field Detail
  - context
```
private final FakeContext context
```
  - data
```
private final Map<String,Object> data
```
- Constructor Detail
  - FakeRequest
```
public FakeRequest(FakeContext fakeContext)
```
- Method Detail
  - contentType
```
public String contentType()
```
    The Content-Type header field indicates the media type of the request body sent to the recipient. E.g. Content-Type: text/html; charset=ISO-8859-4
    
    Specified by:
    
    contentType in class org.wisdom.api.http.Request
    
    Returns:
    
    the content type of the incoming request.
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - method
```
public String method()
```
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
    
    Specified by:
    
    method in class org.wisdom.api.http.Request
    
    Returns:
    
    null as it's a fake request.
  - parameter
```
public String parameter(String name)
```
    Get the parameter with the given key from the request. The parameter may either be a query parameter, or in the case of form submissions, may be a form parameter.
    When the parameter is multivalued, returns the first value.
    The parameter is decoded by default.
    
    Specified by:
    
    parameter in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The key of the parameter
    
    Returns:
    
    The value, or null if no parameter was found.
    
    See Also:
    
    parameterMultipleValues(java.lang.String)
  - parameterMultipleValues
```
public List<String> parameterMultipleValues(String name)
```
    Get the parameter with the given key from the request. The parameter may either be a query parameter, or in the case of form submissions, may be a form parameter.
    The parameter is decoded by default.
    
    Specified by:
    
    parameterMultipleValues in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The key of the parameter
    
    Returns:
    
    The values, possibly an empty list.
  - parameter
```
public String parameter(String name,
                        String defaultValue)
```
    Same like parameter(String), but returns given defaultValue instead of null in case parameter cannot be found.
    The parameter is decoded by default.
    
    Specified by:
    
    parameter in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The name of the post or query parameter
    
    defaultValue - A default value if parameter not found.
    
    Returns:
    
    The value of the parameter of the defaultValue if not found.
  - parameterAsInteger
```
public Integer parameterAsInteger(String name)
```
    Same like parameter(String), but converts the parameter to Integer if found.
    The parameter is decoded by default.
    
    Specified by:
    
    parameterAsInteger in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The name of the post or query parameter
    
    Returns:
    
    The value of the parameter or null if not found.
  - parameterAsInteger
```
public Integer parameterAsInteger(String name,
                                  Integer defaultValue)
```
    Same like parameter(String, String), but converts the parameter to Integer if found.
    The parameter is decoded by default.
    
    Specified by:
    
    parameterAsInteger in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The name of the post or query parameter
    
    defaultValue - A default value if parameter not found.
    
    Returns:
    
    The value of the parameter of the defaultValue if not found.
  - parameterAsBoolean
```
public Boolean parameterAsBoolean(String name)
```
    Same like parameter(String), but converts the parameter to Boolean if found.
    The parameter is decoded by default.
    
    Specified by:
    
    parameterAsBoolean in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The name of the post or query parameter
    
    Returns:
    
    The value of the parameter or false if not found.
  - parameterAsBoolean
```
public Boolean parameterAsBoolean(String name,
                                  boolean defaultValue)
```
    Same like parameter(String), but converts the parameter to Boolean if found.
    The parameter is decoded by default.
    
    Specified by:
    
    parameterAsBoolean in class org.wisdom.api.http.Request
    
    Parameters:
    
    name - The name of the post or query parameter
    
    defaultValue - A default value if parameter not found.
    
    Returns:
    
    The value of the parameter or the defaultValue if not found.
  - parameters
```
public Map<String,List<String>> parameters()
```
    Get all the parameters from the request.
    
    Specified by:
    
    parameters in class org.wisdom.api.http.Request
    
    Returns:
    
    The parameters
  - data
```
public Map<String,Object> data()
```
    Retrieves the data shared by all the entities participating to the request resolution (i.e. computation of the response). This method returns a live map, meaning that modification impacts all other participants. It can be used to let filters or interceptors passing objects to action methods or templates.
    
    Specified by:
    
    data in class org.wisdom.api.http.Request
    
    Returns:
    
    the map storing the data. Unlike session or flash, these data are not stored in cookies, and are cleared once the response is sent back to the client.
  - uri
```
public String uri()
```
    Specified by:
    
    uri in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    null as this is a fake request.
  - remoteAddress
```
public String remoteAddress()
```
    The client IP address.
    
    Specified by:
    
    remoteAddress in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    null as this is a fake request.
  - host
```
public String host()
```
    Specified by:
    
    host in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    null as this is a fake request.
  - path
```
public String path()
```
    Specified by:
    
    path in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    The URI path (without the query).
  - mediaType
```
public com.google.common.net.MediaType mediaType()
```
    Specified by:
    
    mediaType in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    null as this is a fake request.
  - mediaTypes
```
public Collection<com.google.common.net.MediaType> mediaTypes()
```
    Specified by:
    
    mediaTypes in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    empty as this is a fake request.
  - accepts
```
public boolean accepts(String mimeType)
```
    Checks if this request accepts a given media type.
    
    Specified by:
    
    accepts in class org.wisdom.api.http.RequestHeader
    
    Parameters:
    
    mimeType - the mime type to check.
    
    Returns:
    
    null as this is a fake request.
  - cookies
```
public org.wisdom.api.cookies.Cookies cookies()
```
    Specified by:
    
    cookies in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    the request cookies
  - headers
```
public Map<String,List<String>> headers()
```
    Retrieves all headers.
    
    Specified by:
    
    headers in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    headers
  - encoding
```
public String encoding()
```
    Get the encoding that is acceptable for the client. E.g. Accept-Encoding: compress, gzip
    The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings that are acceptable in the response.
    
    Specified by:
    
    encoding in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    the encoding that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - language
```
public String language()
```
    Get the language that is acceptable for the client. E.g. Accept-Language: da, en-gb;q=0.8, en;q=0.7
    The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are preferred as a response to the request.
    
    Specified by:
    
    language in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    the language that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - charset
```
public String charset()
```
    Get the charset that is acceptable for the client. E.g. Accept-Charset: iso-8859-5, unicode-1-1;q=0.8
    The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets.
    
    Specified by:
    
    charset in class org.wisdom.api.http.RequestHeader
    
    Returns:
    
    the charset that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

Class FakeRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.wisdom.api.http.Request

Methods inherited from class org.wisdom.api.http.RequestHeader

Methods inherited from class java.lang.Object

Field Detail

context

data

Constructor Detail

FakeRequest

Method Detail

contentType

method

parameter

parameterMultipleValues

parameter

parameterAsInteger

parameterAsInteger

parameterAsBoolean

parameterAsBoolean

parameters

data

uri

remoteAddress

host

path

mediaType

mediaTypes

accepts

cookies

headers

encoding

language

charset