ninja.servlet

Class NinjaServletContext

java.lang.Object

ninja.utils.AbstractContext

ninja.servlet.NinjaServletContext

All Implemented Interfaces:

Context, Context.Impl

public class NinjaServletContext
extends AbstractContext

Ninja context for servlet environments. When modifying functionality for this class please carefully consider adding it to AbstractContext first. For example, instead of relying on httpServletRequest.getHeader() you could reuse the existing this.getHeader() and be able to implement your feature entirely in AbstractContext.

Nested Class Summary

Nested classes/interfaces inherited from interface ninja.Context

Context.HTTP_STATUS, Context.Impl

Field Summary

Fields inherited from class ninja.utils.AbstractContext

bodyParserEngineManager, flashScope, injector, ninjaProperties, paramParsers, route, session, validation

Fields inherited from interface ninja.Context

CONTENT_TYPE, NINJA_PROPERTIES_X_FORWARDED_FOR, X_FORWARD_HEADER

Constructor Summary

Constructors

Constructor and Description
NinjaServletContext(BodyParserEngineManager bodyParserEngineManager, FlashScope flashScope, NinjaProperties ninjaProperties, ResultHandler resultHandler, Session session, Validation validation, com.google.inject.Injector injector, ParamParsers paramParsers)

Method Summary

Modifier and Type	Method and Description
void	addCookie(Cookie cookie)
void	cleanup()
Result	controllerReturned() Used to indicate that the controller has finished executing
protected ResponseStreams	finalizeHeaders(Result result, Boolean handleFlashAndSessionCookie)
Object	getAttribute(String name)
Map<String,Object>	getAttributes()
Cookie	getCookie(String cookieName)
List<Cookie>	getCookies()
org.apache.commons.fileupload.FileItemIterator	getFileItemIterator()
String	getHeader(String name)
Map<String,List<String>>	getHeaders()
List<String>	getHeaders(String name)
String	getHostname()
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Convenience method to access HttpServletRequest of this context.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Convenience method to access HttpServletResponse of this context.
InputStream	getInputStream()
String	getMethod()
String	getParameter(String key)
FileItem	getParameterAsFileItem(String key)
List<FileItem>	getParameterAsFileItems(String key)
Map<String,List<FileItem>>	getParameterFileItems()
Map<String,String[]>	getParameters()
List<String>	getParameterValues(String name)
BufferedReader	getReader()
String	getRealRemoteAddr()
String	getRequestContentType()
String	getRequestUri() Deprecated.
String	getScheme()
javax.servlet.ServletContext	getServletContext() Convenience method to access ServletContext of this context.
void	handleAsync()
boolean	hasCookie(String cookieName)
void	init(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
boolean	isAsync()
boolean	isMultipart()
void	returnResultAsync(Result result)
void	setAttribute(String name, Object value)

Methods inherited from class ninja.utils.AbstractContext

asyncRequestComplete, finalizeHeaders, finalizeHeadersWithoutFlashAndSessionCookie, getAcceptCharset, getAcceptContentType, getAcceptEncoding, getAcceptLanguage, getAttribute, getContextPath, getCookieValue, getFlashCookie, getFlashScope, getParameter, getParameterAs, getParameterAs, getParameterAsInteger, getParameterAsInteger, getPathParameter, getPathParameterAsInteger, getPathParameterEncoded, getRemoteAddr, getRequestPath, getRoute, getSession, getSessionCookie, getValidation, init, isRequestJson, isRequestXml, parseBody, setRoute, unsetCookie

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NinjaServletContext

@Inject
public NinjaServletContext(BodyParserEngineManager bodyParserEngineManager,
                                   FlashScope flashScope,
                                   NinjaProperties ninjaProperties,
                                   ResultHandler resultHandler,
                                   Session session,
                                   Validation validation,
                                   com.google.inject.Injector injector,
                                   ParamParsers paramParsers)

Method Detail

init

public void init(javax.servlet.ServletContext servletContext,
                 javax.servlet.http.HttpServletRequest httpServletRequest,
                 javax.servlet.http.HttpServletResponse httpServletResponse)

getMethod

public String getMethod()

getRequestUri

@Deprecated
public String getRequestUri()

Deprecated.

getHostname

public String getHostname()

getParameter

public String getParameter(String key)

getParameterValues

public List<String> getParameterValues(String name)

getScheme

public String getScheme()

getRealRemoteAddr

public String getRealRemoteAddr()

Specified by:

getRealRemoteAddr in class AbstractContext

getAttribute

public Object getAttribute(String name)

setAttribute

public void setAttribute(String name,
                         Object value)

getAttributes

public Map<String,Object> getAttributes()

getParameterAsFileItem

public FileItem getParameterAsFileItem(String key)

getParameterAsFileItems

public List<FileItem> getParameterAsFileItems(String key)

getParameterFileItems

public Map<String,List<FileItem>> getParameterFileItems()

getParameters

public Map<String,String[]> getParameters()

getHeader

public String getHeader(String name)

getHeaders

public List<String> getHeaders(String name)

getHeaders

public Map<String,List<String>> getHeaders()

getCookie

public Cookie getCookie(String cookieName)

hasCookie

public boolean hasCookie(String cookieName)

getCookies

public List<Cookie> getCookies()

addCookie

public void addCookie(Cookie cookie)

isAsync

public boolean isAsync()

returnResultAsync

public void returnResultAsync(Result result)

handleAsync

public void handleAsync()

controllerReturned

public Result controllerReturned()

Used to indicate that the controller has finished executing

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getReader

public BufferedReader getReader()
                         throws IOException

Throws:

IOException

finalizeHeaders

protected ResponseStreams finalizeHeaders(Result result,
                                          Boolean handleFlashAndSessionCookie)

Overrides:

finalizeHeaders in class AbstractContext

getRequestContentType

public String getRequestContentType()

isMultipart

public boolean isMultipart()

getFileItemIterator

public org.apache.commons.fileupload.FileItemIterator getFileItemIterator()

getServletContext

public javax.servlet.ServletContext getServletContext()

Convenience method to access ServletContext of this context.

Returns:

ServletContext of this Context

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Convenience method to access HttpServletRequest of this context.

Returns:

HttpServletRequest of this Context

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Convenience method to access HttpServletResponse of this context. Usually you don't want to do that.

Returns:

HttpServletResponse of this Context.

cleanup

public void cleanup()