ServletTilesRequestContext (Tiles 2 2.2.2 API)

java.lang.Object
- org.apache.tiles.context.TilesApplicationContextWrapper
- - org.apache.tiles.servlet.context.ServletTilesRequestContext

All Implemented Interfaces:

TilesRequestContext, TilesApplicationContext
```
public class ServletTilesRequestContext
extends TilesApplicationContextWrapper
implements TilesRequestContext
```
Servlet-based implementation of the TilesApplicationContext interface.

Version:

$Rev: 769961 $ $Date: 2009-04-30 00:07:34 +0200 (gio, 30 apr 2009) $

Constructor Summary

Constructors
Constructor and Description
`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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`javax.servlet.http.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.
`javax.servlet.http.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(javax.servlet.http.HttpServletRequest request, javax.servlet.http.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(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(String contentType)` Sets the content type when rendering the result.
`protected IOException`	`wrapServletException(javax.servlet.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
  - ServletTilesRequestContext
```
public ServletTilesRequestContext(TilesApplicationContext applicationContext,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
```
    Creates a new instance of ServletTilesRequestContext.
    
    Parameters:
    
    applicationContext - The application context.
    
    request - The request object.
    
    response - The response object.
    
    Since:
    
    2.1.1
  - ServletTilesRequestContext
```
@Deprecated
public ServletTilesRequestContext(javax.servlet.ServletContext servletContext,
                                              javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
```
    Deprecated. Use ServletTilesRequestContext(TilesApplicationContext, HttpServletRequest, HttpServletResponse) .
    
    Creates a new instance of ServletTilesRequestContext.
    
    Parameters:
    
    servletContext - The servlet context.
    
    request - The request object.
    
    response - The response object.
- Method Detail
  - getHeader
```
public Map<String,String> getHeader()
```
    Return an immutable Map that maps header names to the first (or only) header value (as a String).
    
    Specified by:
    
    getHeader in interface TilesRequestContext
    
    Returns:
    
    The header map.
  - getHeaderValues
```
public 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). Header names must be matched in a case-insensitive manner.
    
    Specified by:
    
    getHeaderValues in interface TilesRequestContext
    
    Returns:
    
    The header values map.
  - getParam
```
public Map<String,String> getParam()
```
    Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
    
    Specified by:
    
    getParam in interface TilesRequestContext
    
    Returns:
    
    The parameter map.
  - getParamValues
```
public Map<String,String[]> getParamValues()
```
    Return an immutable Map that maps request parameter names to the set of all values (as a String array).
    
    Specified by:
    
    getParamValues in interface TilesRequestContext
    
    Returns:
    
    The parameter values map.
  - getRequestScope
```
public Map<String,Object> getRequestScope()
```
    Return a mutable Map that maps request scope attribute names to their values.
    
    Specified by:
    
    getRequestScope in interface TilesRequestContext
    
    Returns:
    
    The request scope map.
  - getSessionScope
```
public Map<String,Object> getSessionScope()
```
    Return a mutable Map that maps session scope attribute names to their values.
    
    Specified by:
    
    getSessionScope in interface TilesRequestContext
    
    Returns:
    
    The request scope map.
  - getApplicationContext
```
public TilesApplicationContext getApplicationContext()
```
    Returns the associated application context.
    
    Specified by:
    
    getApplicationContext in interface TilesRequestContext
    
    Returns:
    
    The application context associated to this request.
  - dispatch
```
public void dispatch(String path)
              throws IOException
```
    Dispatches the request to a specified path.
    
    Specified by:
    
    dispatch in interface TilesRequestContext
    
    Parameters:
    
    path - The path to dispatch to.
    
    Throws:
    
    IOException - If something goes wrong during dispatching.
  - forward
```
protected void forward(String path)
                throws IOException
```
    Forwards to a path.
    
    Parameters:
    
    path - The path to forward to.
    
    Throws:
    
    IOException - If something goes wrong during the operation.
  - include
```
public void include(String path)
             throws IOException
```
    Includes the response from the specified URL in the current response output.
    
    Specified by:
    
    include in interface TilesRequestContext
    
    Parameters:
    
    path - The path to include.
    
    Throws:
    
    IOException - If something goes wrong during inclusion.
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Returns an output stream to be used to write directly in the response.
    
    Specified by:
    
    getOutputStream in interface TilesRequestContext
    
    Returns:
    
    The output stream that writes in the response.
    
    Throws:
    
    IOException - If something goes wrong when getting the output stream.
  - getWriter
```
public Writer getWriter()
                 throws IOException
```
    Returns a writer to be used to write directly in the response.
    
    Specified by:
    
    getWriter in interface TilesRequestContext
    
    Returns:
    
    The writer that writes in the response.
    
    Throws:
    
    IOException - If something goes wrong when getting the writer.
  - getPrintWriter
```
public PrintWriter getPrintWriter()
                           throws IOException
```
    Returns a print writer to be used to write directly in the response.
    
    Specified by:
    
    getPrintWriter in interface TilesRequestContext
    
    Returns:
    
    The print writer that writes in the response.
    
    Throws:
    
    IOException - If something goes wrong when getting the print writer.
  - isResponseCommitted
```
public boolean isResponseCommitted()
```
    Checks if the response has been committed.
    
    Specified by:
    
    isResponseCommitted in interface TilesRequestContext
    
    Returns:
    
    true only if the response has been committed.
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the content type when rendering the result.
    
    Specified by:
    
    setContentType in interface TilesRequestContext
    
    Parameters:
    
    contentType - The content type. It should follow the specifications from W3C about content types.
  - getRequestLocale
```
public Locale getRequestLocale()
```
    Return the preferred Locale in which the client will accept content.
    
    Specified by:
    
    getRequestLocale in interface TilesRequestContext
    
    Returns:
    
    The current request locale. It is the locale of the request object itself and it is NOT the locale that the user wants to use. See LocaleResolver to implement strategies to resolve locales.
  - getRequestObjects
```
public Object[] getRequestObjects()
```
    Returns the original request objects used to create this request.
    
    Specified by:
    
    getRequestObjects in interface TilesRequestContext
    
    Returns:
    
    The request objects.
  - getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
    Get the underlying request.
    
    Specified by:
    
    getRequest in interface TilesRequestContext
    
    Returns:
    
    The current request object.
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Get the underlying response.
    
    Specified by:
    
    getResponse in interface TilesRequestContext
    
    Returns:
    
    The current request object.
  - initialize
```
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.
    
    Parameters:
    
    request - The HttpServletRequest for this request
    
    response - The HttpServletResponse for this request
  - release
```
public 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.
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Determine whether or not the specified user is in the given role.
    
    Specified by:
    
    isUserInRole in interface TilesRequestContext
    
    Parameters:
    
    role - the role to check against.
    
    Returns:
    
    true if the user is in the given role.
  - wrapServletException
```
@Deprecated
protected IOException wrapServletException(javax.servlet.ServletException ex,
                                                       String message)
```
    Deprecated. Use ServletUtil.wrapServletException(ServletException,String) instead.
    
    Wraps a ServletException to create an IOException with the root cause if present.
    
    Parameters:
    
    ex - The exception to wrap.
    
    message - The message of the exception.
    
    Returns:
    
    The wrapped exception.
    
    Since:
    
    2.0.6

Class ServletTilesRequestContext

Constructor Summary

Method Summary

Methods inherited from class org.apache.tiles.context.TilesApplicationContextWrapper

Methods inherited from class java.lang.Object

Constructor Detail

ServletTilesRequestContext

ServletTilesRequestContext

Method Detail

getHeader

getHeaderValues

getParam

getParamValues

getRequestScope

getSessionScope

getApplicationContext

dispatch

forward

include

getOutputStream

getWriter

getPrintWriter

isResponseCommitted

setContentType

getRequestLocale

getRequestObjects

getRequest

getResponse

initialize

release

isUserInRole

wrapServletException