org.apache.tiles.context
Interface TilesRequestContext

All Known Implementing Classes:
JspTilesRequestContext, ServletTilesRequestContext, TilesRequestContextWrapper

public interface TilesRequestContext

Encapsulation of request information.

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

Method Summary
 void dispatch(java.lang.String path)
          Dispatches the request to a specified path.
 java.util.Map<java.lang.String,java.lang.String> getHeader()
          Return an immutable Map that maps header names to the first (or only) header value (as a String).
 java.util.Map<java.lang.String,java.lang.String[]> 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<java.lang.String,java.lang.String> getParam()
          Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
 java.util.Map<java.lang.String,java.lang.String[]> 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<java.lang.String,java.lang.Object> 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<java.lang.String,java.lang.Object> 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.
 

Method Detail

getHeader

java.util.Map<java.lang.String,java.lang.String> getHeader()
Return an immutable Map that maps header names to the first (or only) header value (as a String).

Returns:
The header map.

getHeaderValues

java.util.Map<java.lang.String,java.lang.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.

Returns:
The header values map.

getRequestScope

java.util.Map<java.lang.String,java.lang.Object> getRequestScope()
Return a mutable Map that maps request scope attribute names to their values.

Returns:
The request scope map.

getSessionScope

java.util.Map<java.lang.String,java.lang.Object> getSessionScope()
Return a mutable Map that maps session scope attribute names to their values.

Returns:
The request scope map.

dispatch

void dispatch(java.lang.String path)
              throws java.io.IOException
Dispatches the request to a specified path.

Parameters:
path - The path to dispatch to.
Throws:
java.io.IOException - If something goes wrong during dispatching.

include

void include(java.lang.String path)
             throws java.io.IOException
Includes the response from the specified URL in the current response output.

Parameters:
path - The path to include.
Throws:
java.io.IOException - If something goes wrong during inclusion.

getParam

java.util.Map<java.lang.String,java.lang.String> getParam()
Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Returns:
The parameter map.

getParamValues

java.util.Map<java.lang.String,java.lang.String[]> getParamValues()
Return an immutable Map that maps request parameter names to the set of all values (as a String array).

Returns:
The parameter values map.

getRequestLocale

java.util.Locale getRequestLocale()
Return the preferred Locale in which the client will accept content.

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

boolean isUserInRole(java.lang.String role)
Determine whether or not the specified user is in the given role.

Parameters:
role - the role to check against.
Returns:
true if the user is in the given role.

getRequest

java.lang.Object getRequest()
Get the underlying request.

Returns:
The current request object.

getResponse

java.lang.Object getResponse()
Get the underlying response.

Returns:
The current request object.