|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||

java.lang.Objectorg.apache.tiles.context.TilesApplicationContextWrapper
org.apache.tiles.servlet.context.ServletTilesRequestContext
public class ServletTilesRequestContext
Servlet-based implementation of the TilesApplicationContext interface.
| Constructor Summary | |
|---|---|
ServletTilesRequestContext(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Deprecated. Use ServletTilesRequestContext(TilesApplicationContext, HttpServletRequest, HttpServletResponse)
. |
|
ServletTilesRequestContext(TilesApplicationContext applicationContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Creates a new instance of ServletTilesRequestContext. |
|
| Method Summary | |
|---|---|
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.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). |
javax.servlet.http.HttpServletRequest |
getRequest()
Get the underlying request. |
java.util.Locale |
getRequestLocale()
Return the preferred Locale in which the client will accept content. |
java.util.Map<java.lang.String,java.lang.Object> |
getRequestScope()
Return a mutable Map that maps request scope attribute names to their values. |
javax.servlet.http.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. |
void |
include(java.lang.String path)
Includes the response from the specified URL in the current response output. |
void |
initialize(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Initialize (or reinitialize) this ServletTilesRequestContext instance
for the specified Servlet API objects. |
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. |
protected java.io.IOException |
wrapServletException(javax.servlet.ServletException ex,
java.lang.String message)
Deprecated. Use ServletUtil.wrapServletException(ServletException,String)
instead. |
| Methods inherited from class org.apache.tiles.context.TilesApplicationContextWrapper |
|---|
getApplicationScope, getContext, getInitParams, getResource, getResources, getWrappedApplicationContext |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ServletTilesRequestContext(TilesApplicationContext applicationContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
applicationContext - The application context.request - The request object.response - The response object.
@Deprecated
public ServletTilesRequestContext(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
ServletTilesRequestContext(TilesApplicationContext, HttpServletRequest, HttpServletResponse)
.
servletContext - The servlet context.request - The request object.response - The response object.| Method Detail |
|---|
public java.util.Map<java.lang.String,java.lang.String> getHeader()
getHeader in interface TilesRequestContextpublic java.util.Map<java.lang.String,java.lang.String[]> getHeaderValues()
getHeaderValues in interface TilesRequestContextpublic java.util.Map<java.lang.String,java.lang.String> getParam()
getParam in interface TilesRequestContextpublic java.util.Map<java.lang.String,java.lang.String[]> getParamValues()
getParamValues in interface TilesRequestContextpublic java.util.Map<java.lang.String,java.lang.Object> getRequestScope()
getRequestScope in interface TilesRequestContextpublic java.util.Map<java.lang.String,java.lang.Object> getSessionScope()
getSessionScope in interface TilesRequestContextpublic TilesApplicationContext getApplicationContext()
getApplicationContext in interface TilesRequestContext
public void dispatch(java.lang.String path)
throws java.io.IOException
dispatch in interface TilesRequestContextpath - 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 TilesRequestContextpath - The path to include.
java.io.IOException - If something goes wrong during inclusion.public java.util.Locale getRequestLocale()
getRequestLocale in interface TilesRequestContextLocaleResolver to implement strategies to
resolve locales.public javax.servlet.http.HttpServletRequest getRequest()
getRequest in interface TilesRequestContextpublic javax.servlet.http.HttpServletResponse getResponse()
getResponse in interface TilesRequestContext
public void initialize(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.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 TilesRequestContextrole - the role to check against.
true if the user is in the given role.
@Deprecated
protected java.io.IOException wrapServletException(javax.servlet.ServletException ex,
java.lang.String message)
ServletUtil.wrapServletException(ServletException,String)
instead.
ex - The exception to wrap.message - The message of the exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||