Context (ninja-core 3.2.0 API)

All Known Subinterfaces:

Context.Impl

All Known Implementing Classes:

WrappedContext
```
public interface Context
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Context.HTTP_STATUS` Deprecated.
`static interface`	`Context.Impl` Impl is used to hide stuff that a user should not see on code completion.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CONTENT_TYPE
Content-Type: ...

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONTENT_TYPE` Content-Type: ...

Method Summary

All Methods Instance Methods Abstract Methods Deprecated 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.
`ResponseStreams`	`finalizeHeadersWithoutFlashAndSessionCookie(Result result)` Finalizing the headers copies all stuff into the headers.
`java.lang.String`	`getAcceptCharset()` Get the charset that is acceptable for the client.
`java.lang.String`	`getAcceptContentType()` Get the content type that is acceptable for the client.
`java.lang.String`	`getAcceptEncoding()` Get the encoding that is acceptable for the client.
`java.lang.String`	`getAcceptLanguage()` Get the language that is acceptable for the client.
`java.lang.Object`	`getAttribute(java.lang.String name)` Gets an attribute value previously set by `setAttribute(java.lang.String, java.lang.Object)`.
`<T> T`	`getAttribute(java.lang.String name, java.lang.Class<T> clazz)` Gets an attribute value previously set by `setAttribute(java.lang.String, java.lang.Object)`.
`java.lang.String`	`getContextPath()` Get the context path on which the application is running That means: - when running on root the context path is empty - when running on context there is NEVER a trailing slash We conform to the following rules: Returns the portion of the request URI that indicates the context of the request.
`Cookie`	`getCookie(java.lang.String cookieName)` Get cookie from context.
`java.util.List<Cookie>`	`getCookies()` Get all cookies from the context.
`java.lang.String`	`getCookieValue(java.lang.String name)` Get the cookie value from the request, if defined
`org.apache.commons.fileupload.FileItemIterator`	`getFileItemIterator()` Gets the FileItemIterator of the input.
`FlashScope`	`getFlashCookie()` Deprecated.
`FlashScope`	`getFlashScope()` Returns the flash cookie.
`java.lang.String`	`getHeader(java.lang.String name)` Get the (first) request header with the given name
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaders()` Get all the headers from the request
`java.util.List<java.lang.String>`	`getHeaders(java.lang.String name)` Get all the request headers with the given name.
`java.lang.String`	`getHostname()` Returns the hostname as seen by the server.
`java.io.InputStream`	`getInputStream()` Get the input stream to read the request.
`java.lang.String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`java.lang.String`	`getParameter(java.lang.String name)` Get the parameter with the given key from the request.
`java.lang.String`	`getParameter(java.lang.String name, java.lang.String defaultValue)` Same like `getParameter(String)`, but returns given defaultValue instead of null in case parameter cannot be found.
`<T> T`	`getParameterAs(java.lang.String name, java.lang.Class<T> clazz)` Same like `getParameter(String)`, but converts the parameter to Class type if found.
`<T> T`	`getParameterAs(java.lang.String name, java.lang.Class<T> clazz, T defaultValue)` Same like `getParameter(String, String)`, but converts the parameter to Class type if found.
`java.lang.Integer`	`getParameterAsInteger(java.lang.String name)` Same like `getParameter(String)`, but converts the parameter to Integer if found.
`java.lang.Integer`	`getParameterAsInteger(java.lang.String name, java.lang.Integer defaultValue)` Same like `getParameter(String, String)`, but converts the parameter to Integer if found.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameters()` Get all the parameters from the request
`java.util.List<java.lang.String>`	`getParameterValues(java.lang.String name)` Get the parameter with the given key from the request.
`java.lang.String`	`getPathParameter(java.lang.String name)` Get the path parameter for the given key.
`java.lang.Integer`	`getPathParameterAsInteger(java.lang.String key)` Get the path parameter for the given key and convert it to Integer.
`java.lang.String`	`getPathParameterEncoded(java.lang.String name)` Get the path parameter for the given key.
`java.io.BufferedReader`	`getReader()` Get the reader to read the request.
`java.lang.String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`java.lang.String`	`getRequestContentType()` The Content-Type header field indicates the media type of the request body sent to the recipient.
`java.lang.String`	`getRequestPath()` Returns the path that Ninja should act upon.
`java.lang.String`	`getRequestUri()` Deprecated.
`Route`	`getRoute()` Get the route for this context
`Session`	`getSession()` Returns the client side session.
`Session`	`getSessionCookie()` Deprecated.
`Validation`	`getValidation()` Get the validation context
`void`	`handleAsync()` Indicate that this request is going to be handled asynchronously
`boolean`	`hasCookie(java.lang.String cookieName)` Checks whether the context contains a given cookie.
`boolean`	`isAsync()`
`boolean`	`isMultipart()` Check if request is of type multipart.
`<T> T`	`parseBody(java.lang.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(java.lang.String name, java.lang.Object value)` Sets an attribute value.

- Field Detail
  - CONTENT_TYPE
```
static final java.lang.String CONTENT_TYPE
```
    Content-Type: ... parameter for response.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRequestContentType
```
java.lang.String getRequestContentType()
```
    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
    
    Returns:
    
    the content type of the incoming request.
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getRequestUri
```
@Deprecated
java.lang.String getRequestUri()
```
    Deprecated.
    
    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
    
    Returns:
    
    the uri as seen by the server
  - getHostname
```
java.lang.String getHostname()
```
    Returns the hostname as seen by the server. http://example.com/index would return "example.com".
    
    Returns:
    
    the host name as seen by the server
  - getRemoteAddr
```
java.lang.String getRemoteAddr()
```
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
    
    Returns:
    
    a String containing the IP address of the client that sent the request
  - getRequestPath
```
java.lang.String getRequestPath()
```
    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
    
    Returns:
    
    The the path as seen by the server. Does exclude any container set context prefixes. Not decoded.
  - getFlashScope
```
FlashScope getFlashScope()
```
    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 FlashScope is usually not signed. Don't trust the content.
    
    Returns:
    
    the flash scope of that request.
  - getFlashCookie
```
@Deprecated
FlashScope getFlashCookie()
```
    Deprecated.
    
    Deprecated => please use getFlashScope()
    
    Returns:
    
    FlashScope of this request.
  - getSession
```
Session getSession()
```
    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.
    
    Returns:
    
    the Session of that request / response cycle.
  - getSessionCookie
```
@Deprecated
Session getSessionCookie()
```
    Deprecated.
    
    Deprecated => please use getSession();
    
    Returns:
    
    the Session of that request / response cycle.
  - getCookie
```
Cookie getCookie(java.lang.String cookieName)
```
    Get cookie from context.
    
    Parameters:
    
    cookieName - Name of the cookie to retrieve
    
    Returns:
    
    the cookie with that name or null.
  - hasCookie
```
boolean hasCookie(java.lang.String cookieName)
```
    Checks whether the context contains a given cookie.
    
    Parameters:
    
    cookieName - Name of the cookie to check for
    
    Returns:
    
    true if the context has a cookie with that name.
  - getCookies
```
java.util.List<Cookie> getCookies()
```
    Get all cookies from the context.
    
    Returns:
    
    the cookie with that name or null.
  - getContextPath
```
java.lang.String getContextPath()
```
    Get the context path on which the application is running That means: - when running on root the context path is empty - when running on context there is NEVER a trailing slash We conform to the following rules: Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string. As outlined by: http://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#getContextPath()
    
    Returns:
    
    the context-path with a leading "/" or "" if running on root
  - getParameter
```
java.lang.String getParameter(java.lang.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.
    
    Parameters:
    
    name - The key of the parameter
    
    Returns:
    
    The value, or null if no parameter was found.
    
    See Also:
    
    getParameterValues(java.lang.String)
  - getParameterValues
```
java.util.List<java.lang.String> getParameterValues(java.lang.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.
    
    Parameters:
    
    name - The key of the parameter
    
    Returns:
    
    The values, possibly an empty list.
  - getParameter
```
java.lang.String getParameter(java.lang.String name,
                              java.lang.String defaultValue)
```
    Same like getParameter(String), but returns given defaultValue instead of null in case parameter cannot be found. The parameter is decoded by default.
    
    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.
  - getParameterAsInteger
```
java.lang.Integer getParameterAsInteger(java.lang.String name)
```
    Same like getParameter(String), but converts the parameter to Integer if found. The parameter is decoded by default.
    
    Parameters:
    
    name - The name of the post or query parameter
    
    Returns:
    
    The value of the parameter or null if not found.
  - getParameterAsInteger
```
java.lang.Integer getParameterAsInteger(java.lang.String name,
                                        java.lang.Integer defaultValue)
```
    Same like getParameter(String, String), but converts the parameter to Integer if found. The parameter is decoded by default.
    
    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.
  - getParameterAs
```
<T> T getParameterAs(java.lang.String name,
                     java.lang.Class<T> clazz)
```
    Same like getParameter(String), but converts the parameter to Class type if found. The parameter is decoded by default.
    
    Parameters:
    
    name - The name of the post or query parameter
    
    Returns:
    
    The value of the parameter or null if not found.
  - getParameterAs
```
<T> T getParameterAs(java.lang.String name,
                     java.lang.Class<T> clazz,
                     T defaultValue)
```
    Same like getParameter(String, String), but converts the parameter to Class type if found. The parameter is decoded by default.
    
    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.
  - getPathParameter
```
java.lang.String getPathParameter(java.lang.String name)
```
    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.
    
    Parameters:
    
    name - 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.
  - getPathParameterEncoded
```
java.lang.String getPathParameterEncoded(java.lang.String name)
```
    Get the path parameter for the given key. Returns the raw path part. That means you can get stuff like: blue%2Fred%3Fand+green
    
    Parameters:
    
    name - 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.
  - getPathParameterAsInteger
```
java.lang.Integer getPathParameterAsInteger(java.lang.String key)
```
    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.
    
    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
```
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
```
    Get all the parameters from the request
    
    Returns:
    
    The parameters
  - getHeader
```
java.lang.String getHeader(java.lang.String name)
```
    Get the (first) request header with the given name
    
    Returns:
    
    The header value
  - getHeaders
```
java.util.List<java.lang.String> getHeaders(java.lang.String name)
```
    Get all the request headers with the given name.
    
    Returns:
    
    the header values
  - getHeaders
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
```
    Get all the headers from the request
    
    Returns:
    
    The headers
  - getCookieValue
```
java.lang.String getCookieValue(java.lang.String name)
```
    Get the cookie value from the request, if defined
    
    Parameters:
    
    name - The name of the cookie
    
    Returns:
    
    The cookie value, or null if the cookie was not found
  - parseBody
```
<T> T parseBody(java.lang.Class<T> classOfT)
```
    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
    
    Parameters:
    
    classOfT - The class of the result.
    
    Returns:
    
    The parsed request or null if something went wrong.
  - isAsync
```
boolean isAsync()
```
  - handleAsync
```
void handleAsync()
```
    Indicate that this request is going to be handled asynchronously
  - returnResultAsync
```
void returnResultAsync(Result result)
```
    Indicate that request processing of an async request is complete.
  - asyncRequestComplete
```
void asyncRequestComplete()
```
    Indicate that processing this request is complete.
  - controllerReturned
```
Result controllerReturned()
```
  - finalizeHeaders
```
ResponseStreams finalizeHeaders(Result result)
```
    Finalizing the headers copies all stuff into the headers. It of course also handles Ninja session and Flash information. After finalizing the headers you can access the responseStreams.
  - finalizeHeadersWithoutFlashAndSessionCookie
```
ResponseStreams finalizeHeadersWithoutFlashAndSessionCookie(Result result)
```
    Finalizing the headers copies all stuff into the headers. After finalizing the headers you can access the responseStreams. This method does not set any Ninja session of flash information. Eg. When serving static assets this is the method you may want to use. Otherwise you'd get a race condition with a lot of requests setting scopes and deleting them immediately.
  - getInputStream
```
java.io.InputStream getInputStream()
                            throws java.io.IOException
```
    Get the input stream to read the request. Must not be used if getReader has been called.
    
    Returns:
    
    The input stream
    
    Throws:
    
    java.io.IOException
  - getReader
```
java.io.BufferedReader getReader()
                          throws java.io.IOException
```
    Get the reader to read the request. Must not be used if getInputStream has been called.
    
    Returns:
    
    The reader
    
    Throws:
    
    java.io.IOException
  - getRoute
```
Route getRoute()
```
    Get the route for this context
    
    Returns:
    
    The route
  - isMultipart
```
boolean isMultipart()
```
    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
    
    Returns:
    
    true if request is of type multipart.
  - getFileItemIterator
```
org.apache.commons.fileupload.FileItemIterator getFileItemIterator()
```
    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
    
    Returns:
    
    the FileItemIterator of the request or null if there was an error.
  - getValidation
```
Validation getValidation()
```
    Get the validation context
    
    Returns:
    
    The validation context
  - getAcceptContentType
```
java.lang.String getAcceptContentType()
```
    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.
    
    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
```
java.lang.String getAcceptEncoding()
```
    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.
    
    Returns:
    
    the encoding that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getAcceptLanguage
```
java.lang.String getAcceptLanguage()
```
    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.
    
    Returns:
    
    the language that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getAcceptCharset
```
java.lang.String getAcceptCharset()
```
    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.
    
    Returns:
    
    the charset that is acceptable for the client
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
  - getMethod
```
java.lang.String getMethod()
```
    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.
    
    Returns:
    
    a String specifying the name of the method with which this request was made (eg GET, POST, PUT...)
  - getAttribute
```
java.lang.Object getAttribute(java.lang.String name)
```
    Gets an attribute value previously set by 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.
    
    Returns:
    
    the attribute value, or null if the attribute does not exist
  - getAttribute
```
<T> T getAttribute(java.lang.String name,
                   java.lang.Class<T> clazz)
```
    Gets an attribute value previously set by 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.
    Returns:
    
    the attribute value, or null if the attribute does not exist
  - setAttribute
```
void setAttribute(java.lang.String name,
                  java.lang.Object value)
```
    Sets an attribute value.
    Attributes are shared state for the duration of the request; useful to pass values between filters and controllers.
    
    See Also:
    
    getAttribute(String), getAttribute(String, Class)

Interface Context

Nested Class Summary

Field Summary

Method Summary

Field Detail

CONTENT_TYPE

Method Detail

getRequestContentType

getRequestUri

getHostname

getRemoteAddr

getRequestPath

getFlashScope

getFlashCookie

getSession

getSessionCookie

getCookie

hasCookie

getCookies

getContextPath

getParameter

getParameterValues

getParameter

getParameterAsInteger

getParameterAsInteger

getParameterAs

getParameterAs

getPathParameter

getPathParameterEncoded

getPathParameterAsInteger

getParameters

getHeader

getHeaders

getHeaders

getCookieValue

parseBody

isAsync

handleAsync

returnResultAsync

asyncRequestComplete

controllerReturned

finalizeHeaders

finalizeHeadersWithoutFlashAndSessionCookie

getInputStream

getReader

getRoute

isMultipart

getFileItemIterator

getValidation

getAcceptContentType

getAcceptEncoding

getAcceptLanguage

getAcceptCharset

getMethod

getAttribute

getAttribute

setAttribute