|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tiles.context.TilesApplicationContextWrapper org.apache.tiles.servlet.context.ServletTilesRequestContext
public class ServletTilesRequestContext
Servlet-based implementation of the TilesApplicationContext interface.
Constructor Summary | |
---|---|
ServletTilesRequestContext(ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response)
Deprecated. Use ServletTilesRequestContext(TilesApplicationContext, HttpServletRequest, HttpServletResponse)
. |
|
ServletTilesRequestContext(TilesApplicationContext applicationContext,
HttpServletRequest request,
HttpServletResponse response)
Creates a new instance of ServletTilesRequestContext. |
Method Summary | |
---|---|
void |
dispatch(String path)
Dispatches the request to a specified path. |
protected void |
forward(String path)
Forwards to a path. |
TilesApplicationContext |
getApplicationContext()
Returns the associated application context. |
Map<String,String> |
getHeader()
Return an immutable Map that maps header names to the first (or only) header value (as a String). |
Map<String,String[]> |
getHeaderValues()
Return an immutable Map that maps header names to the set of all values specified in the request (as a String array). |
OutputStream |
getOutputStream()
Returns an output stream to be used to write directly in the response. |
Map<String,String> |
getParam()
Return an immutable Map that maps request parameter names to the first (or only) value (as a String). |
Map<String,String[]> |
getParamValues()
Return an immutable Map that maps request parameter names to the set of all values (as a String array). |
PrintWriter |
getPrintWriter()
Returns a print writer to be used to write directly in the response. |
HttpServletRequest |
getRequest()
Get the underlying request. |
Locale |
getRequestLocale()
Return the preferred Locale in which the client will accept content. |
Object[] |
getRequestObjects()
Returns the original request objects used to create this request. |
Map<String,Object> |
getRequestScope()
Return a mutable Map that maps request scope attribute names to their values. |
HttpServletResponse |
getResponse()
Get the underlying response. |
Map<String,Object> |
getSessionScope()
Return a mutable Map that maps session scope attribute names to their values. |
Writer |
getWriter()
Returns a writer to be used to write directly in the response. |
void |
include(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 |
isUserInRole(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 IOException |
wrapServletException(ServletException ex,
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, 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.Method Detail |
---|
public Map<String,String> getHeader()
getHeader
in interface TilesRequestContext
public Map<String,String[]> getHeaderValues()
getHeaderValues
in interface TilesRequestContext
public Map<String,String> getParam()
getParam
in interface TilesRequestContext
public Map<String,String[]> getParamValues()
getParamValues
in interface TilesRequestContext
public Map<String,Object> getRequestScope()
getRequestScope
in interface TilesRequestContext
public Map<String,Object> getSessionScope()
getSessionScope
in interface TilesRequestContext
public TilesApplicationContext getApplicationContext()
getApplicationContext
in interface TilesRequestContext
public void dispatch(String path) throws IOException
dispatch
in interface TilesRequestContext
path
- The path to dispatch to.
IOException
- If something goes wrong during dispatching.protected void forward(String path) throws IOException
path
- The path to forward to.
IOException
- If something goes wrong during the operation.public void include(String path) throws IOException
include
in interface TilesRequestContext
path
- The path to include.
IOException
- If something goes wrong during inclusion.public OutputStream getOutputStream() throws IOException
getOutputStream
in interface TilesRequestContext
IOException
- If something goes wrong when getting the output stream.public Writer getWriter() throws IOException
getWriter
in interface TilesRequestContext
IOException
- If something goes wrong when getting the writer.public PrintWriter getPrintWriter() throws IOException
getPrintWriter
in interface TilesRequestContext
IOException
- If something goes wrong when getting the print
writer.public Locale getRequestLocale()
getRequestLocale
in interface TilesRequestContext
LocaleResolver
to implement strategies to
resolve locales.public 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(String role)
isUserInRole
in interface TilesRequestContext
role
- the role to check against.
true
if the user is in the given role.@Deprecated protected IOException wrapServletException(ServletException ex, 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 |