org.apache.tiles.context
Class TilesRequestContextWrapper

Package class diagram package TilesRequestContextWrapper
java.lang.Object
  extended by org.apache.tiles.context.TilesRequestContextWrapper
All Implemented Interfaces:
TilesRequestContext

public class TilesRequestContextWrapper
extends java.lang.Object
implements TilesRequestContext

Delegate for ease of customization.

Since:
Tiles 2.0

Constructor Summary
TilesRequestContextWrapper(TilesRequestContext context)
           
 
Method Summary
 void dispatch(java.lang.String path)
          Dispatches the request to a specified path.
 java.util.Map getHeader()
          Return an immutable Map that maps header names to the first (or only) header value (as a String).
 java.util.Map 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 getParam()
          Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
 java.util.Map getParamValues()
          Return an immutable Map that maps request parameter names to the set of all values (as a String array).
 java.lang.Object getRequest()
          Get the underlying request.
 java.util.Locale getRequestLocale()
          Return the preferred Locale in which the client will accept content.
 java.util.Map getRequestScope()
          Return a mutable Map that maps request scope attribute names to their values.
 java.lang.Object getResponse()
          Get the underlying response.
 java.util.Map 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.
 boolean isUserInRole(java.lang.String role)
          Determine whether or not the specified user is in the given role
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TilesRequestContextWrapper

public TilesRequestContextWrapper(TilesRequestContext context)
Method Detail

getHeader

public java.util.Map getHeader()
Description copied from interface: TilesRequestContext
Return an immutable Map that maps header names to the first (or only) header value (as a String).

Specified by:
getHeader in interface TilesRequestContext

getHeaderValues

public java.util.Map getHeaderValues()
Description copied from interface: TilesRequestContext
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

getRequestScope

public java.util.Map getRequestScope()
Description copied from interface: TilesRequestContext
Return a mutable Map that maps request scope attribute names to their values.

Specified by:
getRequestScope in interface TilesRequestContext

getSessionScope

public java.util.Map getSessionScope()
Description copied from interface: TilesRequestContext
Return a mutable Map that maps session scope attribute names to their values.

Specified by:
getSessionScope in interface TilesRequestContext

dispatch

public void dispatch(java.lang.String path)
              throws java.io.IOException
Description copied from interface: TilesRequestContext
Dispatches the request to a specified path.

Specified by:
dispatch in interface TilesRequestContext
Throws:
java.io.IOException

include

public void include(java.lang.String path)
             throws java.io.IOException
Description copied from interface: TilesRequestContext
Includes the response from the specified URL in the current response output.

Specified by:
include in interface TilesRequestContext
Throws:
java.io.IOException

getParam

public java.util.Map getParam()
Description copied from interface: TilesRequestContext
Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Specified by:
getParam in interface TilesRequestContext

getParamValues

public java.util.Map getParamValues()
Description copied from interface: TilesRequestContext
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

getRequestLocale

public java.util.Locale getRequestLocale()
Description copied from interface: TilesRequestContext
Return the preferred Locale in which the client will accept content.

Specified by:
getRequestLocale in interface TilesRequestContext

isUserInRole

public boolean isUserInRole(java.lang.String role)
Description copied from interface: TilesRequestContext
Determine whether or not the specified user is in the given role

Specified by:
isUserInRole in interface TilesRequestContext
Returns:

getResponse

public java.lang.Object getResponse()
Description copied from interface: TilesRequestContext
Get the underlying response.

Specified by:
getResponse in interface TilesRequestContext

getRequest

public java.lang.Object getRequest()
Description copied from interface: TilesRequestContext
Get the underlying request.

Specified by:
getRequest in interface TilesRequestContext