public class ServletTilesRequestContext extends TilesApplicationContextWrapper implements TilesRequestContext
Constructor and Description |
---|
ServletTilesRequestContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response)
|
ServletTilesRequestContext(TilesApplicationContext applicationContext,
HttpServletRequest request,
HttpServletResponse response)
Creates a new instance of ServletTilesRequestContext.
|
Modifier and Type | Method and Description |
---|---|
void |
dispatch(java.lang.String path)
Dispatches the request to a specified path.
|
protected void |
forward(java.lang.String path)
Forwards to a path.
|
TilesApplicationContext |
getApplicationContext()
Returns the associated application context.
|
java.util.Map<java.lang.String,java.lang.String> |
getHeader()
Return an immutable Map that maps header names to the first (or only)
header value (as a String).
|
java.util.Map<java.lang.String,java.lang.String[]> |
getHeaderValues()
Return an immutable Map that maps header names to the set of all values
specified in the request (as a String array).
|
java.io.OutputStream |
getOutputStream()
Returns an output stream to be used to write directly in the response.
|
java.util.Map<java.lang.String,java.lang.String> |
getParam()
Return an immutable Map that maps request parameter names to the first
(or only) value (as a String).
|
java.util.Map<java.lang.String,java.lang.String[]> |
getParamValues()
Return an immutable Map that maps request parameter names to the set of
all values (as a String array).
|
java.io.PrintWriter |
getPrintWriter()
Returns a print writer to be used to write directly in the response.
|
HttpServletRequest |
getRequest()
Get the underlying request.
|
java.util.Locale |
getRequestLocale()
Return the preferred Locale in which the client will accept content.
|
java.lang.Object[] |
getRequestObjects()
Returns the original request objects used to create this request.
|
java.util.Map<java.lang.String,java.lang.Object> |
getRequestScope()
Return a mutable Map that maps request scope attribute names to their
values.
|
HttpServletResponse |
getResponse()
Get the underlying response.
|
java.util.Map<java.lang.String,java.lang.Object> |
getSessionScope()
Return a mutable Map that maps session scope attribute names to their
values.
|
java.io.Writer |
getWriter()
Returns a writer to be used to write directly in the response.
|
void |
include(java.lang.String path)
Includes the response from the specified URL in the current response output.
|
void |
initialize(HttpServletRequest request,
HttpServletResponse response)
Initialize (or reinitialize) this
ServletTilesRequestContext instance
for the specified Servlet API objects. |
boolean |
isResponseCommitted()
Checks if the response has been committed.
|
boolean |
isUserInRole(java.lang.String role)
Determine whether or not the specified user is in the given role.
|
void |
release()
Release references to allocated resources acquired in
initialize() of via subsequent processing. |
void |
setContentType(java.lang.String contentType)
Sets the content type when rendering the result.
|
protected java.io.IOException |
wrapServletException(ServletException ex,
java.lang.String message)
Deprecated.
|
getApplicationScope, getContext, getInitParams, getResource, getResources, getWrappedApplicationContext
public ServletTilesRequestContext(TilesApplicationContext applicationContext, HttpServletRequest request, HttpServletResponse response)
applicationContext
- The application context.request
- The request object.response
- The response object.@Deprecated public ServletTilesRequestContext(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response)
ServletTilesRequestContext(TilesApplicationContext, HttpServletRequest, HttpServletResponse)
.servletContext
- The servlet context.request
- The request object.response
- The response object.public java.util.Map<java.lang.String,java.lang.String> getHeader()
getHeader
in interface TilesRequestContext
public java.util.Map<java.lang.String,java.lang.String[]> getHeaderValues()
getHeaderValues
in interface TilesRequestContext
public java.util.Map<java.lang.String,java.lang.String> getParam()
getParam
in interface TilesRequestContext
public java.util.Map<java.lang.String,java.lang.String[]> getParamValues()
getParamValues
in interface TilesRequestContext
public java.util.Map<java.lang.String,java.lang.Object> getRequestScope()
getRequestScope
in interface TilesRequestContext
public java.util.Map<java.lang.String,java.lang.Object> getSessionScope()
getSessionScope
in interface TilesRequestContext
public TilesApplicationContext getApplicationContext()
getApplicationContext
in interface TilesRequestContext
public void dispatch(java.lang.String path) throws java.io.IOException
dispatch
in interface TilesRequestContext
path
- The path to dispatch to.java.io.IOException
- If something goes wrong during dispatching.protected void forward(java.lang.String path) throws java.io.IOException
path
- The path to forward to.java.io.IOException
- If something goes wrong during the operation.public void include(java.lang.String path) throws java.io.IOException
include
in interface TilesRequestContext
path
- The path to include.java.io.IOException
- If something goes wrong during inclusion.public java.io.OutputStream getOutputStream() throws java.io.IOException
getOutputStream
in interface TilesRequestContext
java.io.IOException
- If something goes wrong when getting the output stream.public java.io.Writer getWriter() throws java.io.IOException
getWriter
in interface TilesRequestContext
java.io.IOException
- If something goes wrong when getting the writer.public java.io.PrintWriter getPrintWriter() throws java.io.IOException
getPrintWriter
in interface TilesRequestContext
java.io.IOException
- If something goes wrong when getting the print
writer.public boolean isResponseCommitted()
isResponseCommitted
in interface TilesRequestContext
true
only if the response has been committed.public void setContentType(java.lang.String contentType)
setContentType
in interface TilesRequestContext
contentType
- The content type. It should follow the specifications
from W3C about content types.public java.util.Locale getRequestLocale()
getRequestLocale
in interface TilesRequestContext
LocaleResolver
to implement strategies to
resolve locales.public java.lang.Object[] getRequestObjects()
getRequestObjects
in interface TilesRequestContext
public HttpServletRequest getRequest()
getRequest
in interface TilesRequestContext
public HttpServletResponse getResponse()
getResponse
in interface TilesRequestContext
public void initialize(HttpServletRequest request, HttpServletResponse response)
Initialize (or reinitialize) this ServletTilesRequestContext
instance
for the specified Servlet API objects.
request
- The HttpServletRequest
for this requestresponse
- The HttpServletResponse
for this requestpublic void release()
Release references to allocated resources acquired in
initialize()
of via subsequent processing. After this
method is called, subsequent calls to any other method than
initialize()
will return undefined results.
public boolean isUserInRole(java.lang.String role)
isUserInRole
in interface TilesRequestContext
role
- the role to check against.true
if the user is in the given role.@Deprecated protected java.io.IOException wrapServletException(ServletException ex, java.lang.String message)
ServletUtil.wrapServletException(ServletException,String)
instead.ex
- The exception to wrap.message
- The message of the exception.