org.apache.tiles.context
Interface TilesRequestContext

Package class diagram package TilesRequestContext
All Known Implementing Classes:
JspTilesRequestContext, PortletTilesRequestContext, ServletTilesRequestContext, TilesRequestContextWrapper

public interface TilesRequestContext

Encapsulation of request information.

Since:
2.0

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
 

Method Detail

getHeader

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


getHeaderValues

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). Header names must be matched in a case-insensitive manner.


getRequestScope

java.util.Map getRequestScope()
Return a mutable Map that maps request scope attribute names to their values.


getSessionScope

java.util.Map getSessionScope()
Return a mutable Map that maps session scope attribute names to their values.


dispatch

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

Throws:
java.io.IOException

include

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

Throws:
java.io.IOException

getParam

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


getParamValues

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


getRequestLocale

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


isUserInRole

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

Parameters:
role -
Returns:

getRequest

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


getResponse

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