org.apache.tiles.context.portlet
Class PortletTilesRequestContext

Package class diagram package PortletTilesRequestContext
java.lang.Object
  extended by org.apache.tiles.context.portlet.PortletTilesApplicationContext
      extended by org.apache.tiles.context.portlet.PortletTilesRequestContext
All Implemented Interfaces:
TilesRequestContext, org.apache.tiles.TilesApplicationContext

public class PortletTilesRequestContext
extends PortletTilesApplicationContext
implements TilesRequestContext

Portlet-based TilesApplicationContext implementation.


Field Summary
protected  java.util.Map param
          The lazily instantiated Map of request parameter name-value.
protected  java.util.Map paramValues
          The lazily instantiated Map of request parameter name-values.
protected  javax.portlet.PortletRequest request
          The PortletRequest for this request.
protected  javax.portlet.PortletResponse response
          The PortletResponse for this request.
 
Fields inherited from class org.apache.tiles.context.portlet.PortletTilesApplicationContext
context
 
Constructor Summary
PortletTilesRequestContext(javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
          Creates a new instance of PortletTilesRequestContext
 
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).
 javax.portlet.PortletRequest getRequest()
          Return the PortletRequest for this context.
 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.
 javax.portlet.PortletResponse getResponse()
          Return the PortletResponse for this context.
 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.
 void initialize(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
          Initialize (or reinitialize) this PortletTilesRequestContext instance for the specified Portlet API objects.
 boolean isUserInRole(java.lang.String role)
          Determine whether or not the specified user is in the given role
 void release()
          Release references to allocated resources acquired in initialize() of via subsequent processing.
 
Methods inherited from class org.apache.tiles.context.portlet.PortletTilesApplicationContext
createRequestContext, getApplicationScope, getInitParams, getPortletContext, getResource, getResources, initialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

request

protected javax.portlet.PortletRequest request

The PortletRequest for this request.


response

protected javax.portlet.PortletResponse response

The PortletResponse for this request.


param

protected java.util.Map param

The lazily instantiated Map of request parameter name-value.


paramValues

protected java.util.Map paramValues

The lazily instantiated Map of request parameter name-values.

Constructor Detail

PortletTilesRequestContext

public PortletTilesRequestContext(javax.portlet.PortletContext context,
                                  javax.portlet.PortletRequest request,
                                  javax.portlet.PortletResponse response)
Creates a new instance of PortletTilesRequestContext

Method Detail

initialize

public void initialize(javax.portlet.PortletRequest request,
                       javax.portlet.PortletResponse response)

Initialize (or reinitialize) this PortletTilesRequestContext instance for the specified Portlet API objects.

Parameters:
request - The PortletRequest for this request
response - The PortletResponse 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 PortletTilesApplicationContext

getRequest

public javax.portlet.PortletRequest getRequest()

Return the PortletRequest for this context.

Specified by:
getRequest in interface TilesRequestContext

getResponse

public javax.portlet.PortletResponse getResponse()

Return the PortletResponse for this context.

Specified by:
getResponse in interface TilesRequestContext

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

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

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

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: