WrappedContext (ninja web framework 1.3 API)

java.lang.Object
- ninja.WrappedContext

All Implemented Interfaces:

Context
```
public class WrappedContext
extends Object
implements Context
```
A wrapped context. Useful if filters want to modify the context before sending it on.

Author:

James Roper

Nested Class Summary
- Nested classes/interfaces inherited from interface ninja.Context
  Context.HTTP_STATUS, Context.Impl

Field Summary
- Fields inherited from interface ninja.Context
  CONTENT_TYPE

Constructor Summary

Constructors
Constructor and Description

WrappedContext(Context wrapped)

Constructors
Constructor and Description
`WrappedContext(Context wrapped)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`asyncRequestComplete()` Indicate that processing this request is complete.
`Result`	`controllerReturned()`
`ResponseStreams`	`finalizeHeaders(Result result)` Finalizing the headers copies all stuff into the headers.
`String`	`getAcceptCharset()` Get the charset that is acceptable for the client.
`String`	`getAcceptContentType()` Get the content type that is acceptable for the client.
`String`	`getAcceptEncoding()` Get the encoding that is acceptable for the client.
`String`	`getAcceptLanguage()` Get the language that is acceptable for the client.
`Object`	`getAttribute(String name)` Gets an attribute value previously set by `Context.setAttribute(java.lang.String, java.lang.Object)`.
`<T> T`	`getAttribute(String name, Class<T> clazz)` Gets an attribute value previously set by `Context.setAttribute(java.lang.String, java.lang.Object)`.
`Cookie`	`getCookie(String cookieName)` Get cookie from context.
`List<Cookie>`	`getCookies()` Get all cookies from the context.
`String`	`getCookieValue(String name)` Get the cookie value from the request, if defined
`org.apache.commons.fileupload.FileItemIterator`	`getFileItemIterator()` Gets the FileItemIterator of the input.
`FlashCookie`	`getFlashCookie()` Returns the flash cookie.
`String`	`getHeader(String name)` Get the (first) request header with the given name
`Map<String,List<String>>`	`getHeaders()` Get all the headers from the request
`List<String>`	`getHeaders(String name)` Get all the request headers with the given name.
`InputStream`	`getInputStream()` Get the input stream to read the request.
`String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getParameter(String key)` Get the parameter with the given key from the request.
`String`	`getParameter(String key, String defaultValue)` Same like `Context.getParameter(String)`, but returns given defaultValue instead of null in case parameter cannot be found.
`Integer`	`getParameterAsInteger(String key)` Same like `Context.getParameter(String)`, but converts the parameter to Integer if found.
`Integer`	`getParameterAsInteger(String key, Integer defaultValue)` Same like `Context.getParameter(String, String)`, but converts the parameter to Integer if found.
`Map<String,String[]>`	`getParameters()` Get all the parameters from the request
`List<String>`	`getParameterValues(String name)` Get the parameter with the given key from the request.
`String`	`getPathParameter(String key)` Get the path parameter for the given key.
`Integer`	`getPathParameterAsInteger(String key)` Get the path parameter for the given key and convert it to Integer.
`String`	`getPathParameterEncoded(String key)` Get the path parameter for the given key.
`BufferedReader`	`getReader()` Get the reader to read the request.
`String`	`getRequestContentType()` The Content-Type header field indicates the media type of the request body sent to the recipient.
`String`	`getRequestPath()` Returns the path that Ninja should act upon.
`String`	`getRequestUri()` Returns the uri as seen by the server.
`Route`	`getRoute()` Get the route for this context
`SessionCookie`	`getSessionCookie()` Returns the client side session.
`Validation`	`getValidation()` Get the validation context
`void`	`handleAsync()` Indicate that this request is going to be handled asynchronously
`boolean`	`hasCookie(String cookieName)` Checks whether the context contains a given cookie.
`boolean`	`isMultipart()` Check if request is of type multipart.
`<T> T`	`parseBody(Class<T> classOfT)` This will give you the request body nicely parsed.
`void`	`returnResultAsync(Result result)` Indicate that request processing of an async request is complete.
`void`	`setAttribute(String name, Object value)` Sets an attribute value.

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

- Constructor Detail
  - WrappedContext
```
public WrappedContext(Context wrapped)
```
- Method Detail
  - getRequestUri
```
public String getRequestUri()
```
    Description copied from interface: Context
    
    Returns the uri as seen by the server. http://example.com/index would return "/index". This is ambiguous. Please use the new method getRequestPath. It will also take care of any prefixes and contexts set by your servlet container
    
    Specified by:
    
    getRequestUri in interface Context
    
    Returns:
    the uri as seen by the server
  - getFlashCookie
```
public FlashCookie getFlashCookie()
```
    Description copied from interface: Context
    
    Returns the flash cookie. Flash cookies only live for one request. Good uses are error messages to display. Almost everything else is bad use of Flash Cookies. A FlashCookie is usually not signed. Don't trust the content.
    
    Specified by:
    
    getFlashCookie in interface Context
    
    Returns:
    the flash cookie of that request.
  - getSessionCookie
```
public SessionCookie getSessionCookie()
```
    Description copied from interface: Context
    
    Returns the client side session. It is a cookie. Therefore you cannot store a lot of information inside the cookie. This is by intention. If you have the feeling that the session cookie is too small for what you want to achieve thing again. Most likely your design is wrong.
    
    Specified by:
    
    getSessionCookie in interface Context
    
    Returns:
    the Session of that request / response cycle.
  - getParameter
```
public String getParameter(String key)
```
    Description copied from interface: Context
    
    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:
    
    getParameter in interface Context
    
    Parameters:
    key - The key of the parameter
    
    Returns:
    The value, or null if no parameter was found.
    See Also:
    Context.getParameterValues(java.lang.String)
  - getParameterValues
```
public List<String> getParameterValues(String name)
```
    Description copied from interface: Context
    
    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:
    
    getParameterValues in interface Context
    
    Parameters:
    name - The key of the parameter
    
    Returns:
    The values, possibly an empty list.
  - getParameter
```
public String getParameter(String key,
                  String defaultValue)
```
    Description copied from interface: Context
    
    Same like Context.getParameter(String), but returns given defaultValue instead of null in case parameter cannot be found. The parameter is decoded by default.
    
    Specified by:
    
    getParameter in interface Context
    
    Parameters:
    key - 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.
  - getParameterAsInteger
```
public Integer getParameterAsInteger(String key)
```
    Description copied from interface: Context
    
    Same like Context.getParameter(String), but converts the parameter to Integer if found. The parameter is decoded by default.
    
    Specified by:
    
    getParameterAsInteger in interface Context
    
    Parameters:
    key - The name of the post or query parameter
    
    Returns:
    The value of the parameter or null if not found.
  - getParameterAsInteger
```
public Integer getParameterAsInteger(String key,
                            Integer defaultValue)
```
    Description copied from interface: Context
    
    Same like Context.getParameter(String, String), but converts the parameter to Integer if found. The parameter is decoded by default.
    
    Specified by:
    
    getParameterAsInteger in interface Context
    
    Parameters:
    key - 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.
  - getPathParameter
```
public String getPathParameter(String key)
```
    Description copied from interface: Context
    
    Get the path parameter for the given key. The parameter will be decoded based on the RFCs. Check out http://docs.oracle.com/javase/6/docs/api/java/net/URI.html for more information.
    
    Specified by:
    
    getPathParameter in interface Context
    
    Parameters:
    key - The name of the path parameter in a route. Eg /{myName}/rest/of/url
    
    Returns:
    The decoded path parameter, or null if no such path parameter was found.
  - getPathParameterAsInteger
```
public Integer getPathParameterAsInteger(String key)
```
    Description copied from interface: Context
    
    Get the path parameter for the given key and convert it to Integer. The parameter will be decoded based on the RFCs. Check out http://docs.oracle.com/javase/6/docs/api/java/net/URI.html for more information.
    
    Specified by:
    
    getPathParameterAsInteger in interface Context
    
    Parameters:
    key - the key of the path parameter
    
    Returns:
    the numeric path parameter, or null of no such path parameter is defined, or if it cannot be parsed to int
  - getParameters
```
public Map<String,String[]> getParameters()
```
    Description copied from interface: Context
    
    Get all the parameters from the request
    
    Specified by:
    
    getParameters in interface Context
    
    Returns:
    The parameters
  - getHeader
```
public String getHeader(String name)
```
    Description copied from interface: Context
    
    Get the (first) request header with the given name
    
    Specified by:
    
    getHeader in interface Context
    
    Returns:
    The header value
  - getHeaders
```
public List<String> getHeaders(String name)
```
    Description copied from interface: Context
    
    Get all the request headers with the given name.
    
    Specified by:
    
    getHeaders in interface Context
    
    Returns:
    the header values
  - getHeaders
```
public Map<String,List<String>> getHeaders()
```
    Description copied from interface: Context
    
    Get all the headers from the request
    
    Specified by:
    
    getHeaders in interface Context
    
    Returns:
    The headers
  - getCookieValue
```
public String getCookieValue(String name)
```
    Description copied from interface: Context
    
    Get the cookie value from the request, if defined
    
    Specified by:
    
    getCookieValue in interface Context
    
    Parameters:
    name - The name of the cookie
    
    Returns:
    The cookie value, or null if the cookie was not found
  - parseBody
```
public <T> T parseBody(Class<T> classOfT)
```
    Description copied from interface: Context
    
    This will give you the request body nicely parsed. You can register your own parsers depending on the request type. Have a look at BodyParserEngine BodyParserEngineJson BodyParserEngineXml and BodyParserEngineManager
    
    Specified by:
    
    parseBody in interface Context
    
    Parameters:
    classOfT - The class of the result.
    
    Returns:
    The parsed request or null if something went wrong.
  - handleAsync
```
public void handleAsync()
```
    Description copied from interface: Context
    
    Indicate that this request is going to be handled asynchronously
    
    Specified by:
    
    handleAsync in interface Context
  - returnResultAsync
```
public void returnResultAsync(Result result)
```
    Description copied from interface: Context
    
    Indicate that request processing of an async request is complete.
    
    Specified by:
    
    returnResultAsync in interface Context
  - asyncRequestComplete
```
public void asyncRequestComplete()
```
    Description copied from interface: Context
    
    Indicate that processing this request is complete.
    
    Specified by:
    
    asyncRequestComplete in interface Context
  - controllerReturned
```
public Result controllerReturned()
```
    Specified by:
    
    controllerReturned in interface Context
  - finalizeHeaders
```
public ResponseStreams finalizeHeaders(Result result)
```
    Description copied from interface: Context
    
    Finalizing the headers copies all stuff into the headers. After finalizing the headers you can access the responseStreams.
    
    Specified by:
    
    finalizeHeaders in interface Context
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Description copied from interface: Context
    
    Get the input stream to read the request. Must not be used if getReader has been called.
    
    Specified by:
    
    getInputStream in interface Context
    
    Returns:
    The input stream
    
    Throws:
    
    IOException
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Description copied from interface: Context
    
    Get the reader to read the request. Must not be used if getInputStream has been called.
    
    Specified by:
    
    getReader in interface Context
    
    Returns:
    The reader
    
    Throws:
    
    IOException
  - getRequestContentType
```
public String getRequestContentType()
```
    Description copied from interface: Context
    
    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:
    
    getRequestContentType in interface Context
    
    Returns:
    the content type of the incoming request.
    See Also:
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getRoute
```
public Route getRoute()
```
    Description copied from interface: Context
    
    Get the route for this context
    
    Specified by:
    
    getRoute in interface Context
    
    Returns:
    The route
  - isMultipart
```
public boolean isMultipart()
```
    Description copied from interface: Context
    
    Check if request is of type multipart. Important when you want to process uploads for instance. Also check out: http://commons.apache.org/fileupload/streaming.html
    
    Specified by:
    
    isMultipart in interface Context
    
    Returns:
    true if request is of type multipart.
  - getFileItemIterator
```
public org.apache.commons.fileupload.FileItemIterator getFileItemIterator()
```
    Description copied from interface: Context
    
    Gets the FileItemIterator of the input. Can be used to process uploads in a streaming fashion. Check out: http://commons.apache.org/fileupload/streaming.html
    
    Specified by:
    
    getFileItemIterator in interface Context
    
    Returns:
    the FileItemIterator of the request or null if there was an error.
  - getRequestPath
```
public String getRequestPath()
```
    Description copied from interface: Context
    
    Returns the path that Ninja should act upon. For instance in servlets you could have soemthing like a context prefix. /myContext/app If your route only defines /app it will work as the requestpath will return only "/app". A context path is not returned. It does NOT decode any parts of the url. Interesting reads: - http://www.lunatech-research.com/archives/2009/02/03/ what-every-web-developer-must-know-about-url-encoding - http://stackoverflow .com/questions/966077/java-reading-undecoded-url-from-servlet
    
    Specified by:
    
    getRequestPath in interface Context
    
    Returns:
    The the path as seen by the server. Does exclude any container set context prefixes. Not decoded.
  - getValidation
```
public Validation getValidation()
```
    Description copied from interface: Context
    
    Get the validation context
    
    Specified by:
    
    getValidation in interface Context
    
    Returns:
    The validation context
  - getPathParameterEncoded
```
public String getPathParameterEncoded(String key)
```
    Description copied from interface: Context
    
    Get the path parameter for the given key. Returns the raw path part. That means you can get stuff like: blue%2Fred%3Fand+green
    
    Specified by:
    
    getPathParameterEncoded in interface Context
    
    Parameters:
    key - The name of the path parameter in a route. Eg /{myName}/rest/of/url
    
    Returns:
    The encoded (!) path parameter, or null if no such path parameter was found.
  - getAcceptContentType
```
public String getAcceptContentType()
```
    Description copied from interface: Context
    
    Get the content type that is acceptable for the client. (in this order : Result.TEXT_HTML > Result.APPLICATION_XML > Result.APPLICATION_JSON > Result.TEXT_PLAIN > Result.APPLICATION_OCTET_STREAM level- or quality-parameter are ignored with this method.) E.g. Accept: text/*;q=0.3, text/html;q=0.7, text/html;level=1,text/html;level=2;q=0.4 The Accept request-header field can be used to specify certain media types which are acceptable for the response. Accept headers can be used to indicate that the request is specifically limited to a small set of desired types, as in the case of a request for an in-line image.
    
    Specified by:
    
    getAcceptContentType in interface Context
    
    Returns:
    one of the Result mime types that is acceptable for the client or Result.TEXT_HTML if not set
    See Also:
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getAcceptEncoding
```
public String getAcceptEncoding()
```
    Description copied from interface: Context
    
    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:
    
    getAcceptEncoding in interface Context
    
    Returns:
    the encoding that is acceptable for the client
    See Also:
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getAcceptLanguage
```
public String getAcceptLanguage()
```
    Description copied from interface: Context
    
    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:
    
    getAcceptLanguage in interface Context
    
    Returns:
    the language that is acceptable for the client
    See Also:
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getAcceptCharset
```
public String getAcceptCharset()
```
    Description copied from interface: Context
    
    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:
    
    getAcceptCharset in interface Context
    
    Returns:
    the charset that is acceptable for the client
    See Also:
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getCookie
```
public Cookie getCookie(String cookieName)
```
    Description copied from interface: Context
    
    Get cookie from context.
    
    Specified by:
    
    getCookie in interface Context
    
    Parameters:
    cookieName - Name of the cookie to retrieve
    
    Returns:
    the cookie with that name or null.
  - hasCookie
```
public boolean hasCookie(String cookieName)
```
    Description copied from interface: Context
    
    Checks whether the context contains a given cookie.
    
    Specified by:
    
    hasCookie in interface Context
    
    Parameters:
    cookieName - Name of the cookie to check for
    
    Returns:
    true if the context has a cookie with that name.
  - getCookies
```
public List<Cookie> getCookies()
```
    Description copied from interface: Context
    
    Get all cookies from the context.
    
    Specified by:
    
    getCookies in interface Context
    
    Returns:
    the cookie with that name or null.
  - getMethod
```
public String getMethod()
```
    Description copied from interface: Context
    
    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:
    
    getMethod in interface Context
    
    Returns:
    a String specifying the name of the method with which this request was made (eg GET, POST, PUT...)
  - getAttribute
```
public Object getAttribute(String name)
```
    Description copied from interface: Context
    
    Gets an attribute value previously set by Context.setAttribute(java.lang.String, java.lang.Object).
    Attributes are shared state for the duration of the request; useful to pass values between filters and controllers.
    
    Specified by:
    
    getAttribute in interface Context
    
    Returns:
    the attribute value, or null if the attribute does not exist
  - getAttribute
```
public <T> T getAttribute(String name,
                 Class<T> clazz)
```
    Description copied from interface: Context
    Gets an attribute value previously set by Context.setAttribute(java.lang.String, java.lang.Object).
    This is a convenience method, equivalent to:
```
     return clazz.cast(getAttribute(name));
 
```
    Attributes are shared state for the duration of the request; useful to pass values between filters and controllers.
    Specified by:
    
    getAttribute in interface Context
    
    Returns:
    the attribute value, or null if the attribute does not exist
  - setAttribute
```
public void setAttribute(String name,
                Object value)
```
    Description copied from interface: Context
    
    Sets an attribute value.
    Attributes are shared state for the duration of the request; useful to pass values between filters and controllers.
    
    Specified by:
    
    setAttribute in interface Context
    
    See Also:
    Context.getAttribute(String), Context.getAttribute(String, Class)

Class WrappedContext

Nested Class Summary

Nested classes/interfaces inherited from interface ninja.Context

Field Summary

Fields inherited from interface ninja.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WrappedContext

Method Detail

getRequestUri

getFlashCookie

getSessionCookie

getParameter

getParameterValues

getParameter

getParameterAsInteger

getParameterAsInteger

getPathParameter

getPathParameterAsInteger

getParameters

getHeader

getHeaders

getHeaders

getCookieValue

parseBody

handleAsync

returnResultAsync

asyncRequestComplete

controllerReturned

finalizeHeaders

getInputStream

getReader

getRequestContentType

getRoute

isMultipart

getFileItemIterator

getRequestPath

getValidation

getPathParameterEncoded

getAcceptContentType

getAcceptEncoding

getAcceptLanguage

getAcceptCharset

getCookie

hasCookie

getCookies

getMethod

getAttribute

getAttribute

setAttribute