This project has retired. For details please refer to its Attic page.

org.apache.tiles.context
Class TilesRequestContextWrapper

java.lang.Object
  org.apache.tiles.context.TilesRequestContextWrapper

All Implemented Interfaces:

TilesRequestContext

public class TilesRequestContextWrapper
extends Object
implements TilesRequestContext

Delegate for ease of customization.

Since:

Tiles 2.0

Version:

$Rev: 527536 $ $Date: 2007-04-11 17:44:51 +0200 (Wed, 11 Apr 2007) $

Constructor Summary

TilesRequestContextWrapper(TilesRequestContext context)
Constructor.

Method Summary

void	dispatch(String path) Dispatches the request to a specified path.
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).
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).
Object	getRequest() Get the underlying request.
Locale	getRequestLocale() Return the preferred Locale in which the client will accept content.
Map<String,Object>	getRequestScope() Return a mutable Map that maps request scope attribute names to their values.
Object	getResponse() Get the underlying response.
Map<String,Object>	getSessionScope() Return a mutable Map that maps session scope attribute names to their values.
void	include(String path) Includes the response from the specified URL in the current response output.
boolean	isUserInRole(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)

Constructor.

Parameters:

context - The request context to wrap.

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.

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.

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.

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.

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.

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.

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.

getResponse

public Object getResponse()

Get the underlying response.

Specified by:

getResponse in interface TilesRequestContext

Returns:

The current request object.

getRequest

public Object getRequest()

Get the underlying request.

Specified by:

getRequest in interface TilesRequestContext

Returns:

The current request object.