org.apache.tiles.servlet.context
Class ServletTilesRequestContext

java.lang.Object
  org.apache.tiles.servlet.context.ServletTilesApplicationContext
      org.apache.tiles.servlet.context.ServletTilesRequestContext

All Implemented Interfaces:

org.apache.tiles.context.TilesRequestContext, org.apache.tiles.TilesApplicationContext

public class ServletTilesRequestContext
extends ServletTilesApplicationContext
implements org.apache.tiles.context.TilesRequestContext

Servlet-based implementation of the TilesApplicationContext interface.

Constructor Summary

ServletTilesRequestContext(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Creates a new instance of ServletTilesRequestContext.

Method Summary

void	dispatch(java.lang.String path)
protected void	forward(java.lang.String path) Forwards to a path.
java.util.Map<java.lang.String,java.lang.String>	getHeader()
java.util.Map<java.lang.String,java.lang.String[]>	getHeaderValues()
java.util.Map<java.lang.String,java.lang.String>	getParam()
java.util.Map<java.lang.String,java.lang.String[]>	getParamValues()
javax.servlet.http.HttpServletRequest	getRequest()
java.util.Locale	getRequestLocale()
java.util.Map<java.lang.String,java.lang.Object>	getRequestScope()
javax.servlet.http.HttpServletResponse	getResponse()
java.util.Map<java.lang.String,java.lang.Object>	getSessionScope()
void	include(java.lang.String path)
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)
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) Wraps a ServletException to create an IOException with the root cause if present.

Methods inherited from class org.apache.tiles.servlet.context.ServletTilesApplicationContext

createRequestContext, getApplicationScope, getContext, getInitParams, getResource, getResources, getServletContext, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletTilesRequestContext

public ServletTilesRequestContext(javax.servlet.ServletContext servletContext,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Creates a new instance of ServletTilesRequestContext.

Parameters:

servletContext - The servlet context.

request - The request object.

response - The response object.

Method Detail

getHeader

public java.util.Map<java.lang.String,java.lang.String> getHeader()

Specified by:

getHeader in interface org.apache.tiles.context.TilesRequestContext

getHeaderValues

public java.util.Map<java.lang.String,java.lang.String[]> getHeaderValues()

Specified by:

getHeaderValues in interface org.apache.tiles.context.TilesRequestContext

getParam

public java.util.Map<java.lang.String,java.lang.String> getParam()

Specified by:

getParam in interface org.apache.tiles.context.TilesRequestContext

getParamValues

public java.util.Map<java.lang.String,java.lang.String[]> getParamValues()

Specified by:

getParamValues in interface org.apache.tiles.context.TilesRequestContext

getRequestScope

public java.util.Map<java.lang.String,java.lang.Object> getRequestScope()

Specified by:

getRequestScope in interface org.apache.tiles.context.TilesRequestContext

getSessionScope

public java.util.Map<java.lang.String,java.lang.Object> getSessionScope()

Specified by:

getSessionScope in interface org.apache.tiles.context.TilesRequestContext

dispatch

public void dispatch(java.lang.String path)
              throws java.io.IOException

Specified by:

dispatch in interface org.apache.tiles.context.TilesRequestContext

Throws:

java.io.IOException

forward

protected void forward(java.lang.String path)
                throws java.io.IOException

Forwards to a path.

Parameters:

path - The path to forward to.

Throws:

java.io.IOException - If something goes wrong during the operation.

include

public void include(java.lang.String path)
             throws java.io.IOException

Specified by:

include in interface org.apache.tiles.context.TilesRequestContext

Throws:

java.io.IOException

getRequestLocale

public java.util.Locale getRequestLocale()

Specified by:

getRequestLocale in interface org.apache.tiles.context.TilesRequestContext

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Specified by:

getRequest in interface org.apache.tiles.context.TilesRequestContext

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Specified by:

getResponse in interface org.apache.tiles.context.TilesRequestContext

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.

Overrides:

release in class ServletTilesApplicationContext

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface org.apache.tiles.context.TilesRequestContext

wrapServletException

protected java.io.IOException wrapServletException(javax.servlet.ServletException ex,
                                                   java.lang.String message)

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