org.apache.tiles.portlet.context
Class PortletTilesRequestContext

java.lang.Object
  org.apache.tiles.context.TilesApplicationContextWrapper
      org.apache.tiles.portlet.context.PortletTilesRequestContext

All Implemented Interfaces:

TilesRequestContext, TilesApplicationContext

public class PortletTilesRequestContext
extends TilesApplicationContextWrapper
implements TilesRequestContext

Portlet-based TilesApplicationContext implementation.

Version:

$Rev: 769961 $ $Date: 2009-04-30 00:07:34 +0200 (gio, 30 apr 2009) $

Field Summary

protected java.util.Map<java.lang.String,java.lang.String>	param The lazily instantiated Map of request parameter name-value.
protected java.util.Map<java.lang.String,java.lang.String[]>	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.

Constructor Summary

PortletTilesRequestContext(javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
Deprecated. Use PortletTilesRequestContext(TilesApplicationContext, PortletContext, PortletRequest, PortletResponse) .

PortletTilesRequestContext(TilesApplicationContext applicationContext, 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)
TilesApplicationContext	getApplicationContext()
java.util.Map<java.lang.String,java.lang.String>	getHeader()
java.util.Map<java.lang.String,java.lang.String[]>	getHeaderValues()
java.io.OutputStream	getOutputStream()
java.util.Map<java.lang.String,java.lang.String>	getParam()
java.util.Map<java.lang.String,java.lang.String[]>	getParamValues()
java.io.PrintWriter	getPrintWriter()
javax.portlet.PortletRequest	getRequest() Return the PortletRequest for this context.
java.util.Locale	getRequestLocale()
java.lang.Object[]	getRequestObjects()
java.util.Map<java.lang.String,java.lang.Object>	getRequestScope()
javax.portlet.PortletResponse	getResponse() Return the PortletResponse for this context.
java.util.Map<java.lang.String,java.lang.Object>	getSessionScope()
java.io.Writer	getWriter()
void	include(java.lang.String path)
void	initialize(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Initialize (or reinitialize) this PortletTilesRequestContext instance for the specified Portlet API objects.
boolean	isResponseCommitted()
boolean	isUserInRole(java.lang.String role)
void	release() Release references to allocated resources acquired in initialize() of via subsequent processing.
void	setContentType(java.lang.String contentType)

Methods inherited from class org.apache.tiles.context.TilesApplicationContextWrapper

getApplicationScope, getContext, getInitParams, getResource, getResources, getWrappedApplicationContext

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

The lazily instantiated Map of request parameter name-value.

paramValues

protected java.util.Map<java.lang.String,java.lang.String[]> paramValues

The lazily instantiated Map of request parameter name-values.

Constructor Detail

PortletTilesRequestContext

public PortletTilesRequestContext(TilesApplicationContext applicationContext,
                                  javax.portlet.PortletContext context,
                                  javax.portlet.PortletRequest request,
                                  javax.portlet.PortletResponse response)

Creates a new instance of PortletTilesRequestContext.

Parameters:

applicationContext - The Tiles application context.

context - The portlet context to use.

request - The request object to use.

response - The response object to use.

Since:

2.1.1

PortletTilesRequestContext

@Deprecated
public PortletTilesRequestContext(javax.portlet.PortletContext context,
                                             javax.portlet.PortletRequest request,
                                             javax.portlet.PortletResponse response)

Deprecated. Use PortletTilesRequestContext(TilesApplicationContext, PortletContext, PortletRequest, PortletResponse) .

Creates a new instance of PortletTilesRequestContext.

Parameters:

context - The portlet context to use.

request - The request object to use.

response - The response object to use.

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.

getRequest

public javax.portlet.PortletRequest getRequest()

Return the PortletRequest for this context.

Specified by:

getRequest in interface TilesRequestContext

Returns:

The used portlet request.

getResponse

public javax.portlet.PortletResponse getResponse()

Return the PortletResponse for this context.

Specified by:

getResponse in interface TilesRequestContext

Returns:

The used portlet response.

getHeader

public java.util.Map<java.lang.String,java.lang.String> getHeader()

Specified by:

getHeader in interface TilesRequestContext

getHeaderValues

public java.util.Map<java.lang.String,java.lang.String[]> getHeaderValues()

Specified by:

getHeaderValues in interface TilesRequestContext

getParam

public java.util.Map<java.lang.String,java.lang.String> getParam()

Specified by:

getParam in interface TilesRequestContext

getParamValues

public java.util.Map<java.lang.String,java.lang.String[]> getParamValues()

Specified by:

getParamValues in interface TilesRequestContext

getRequestScope

public java.util.Map<java.lang.String,java.lang.Object> getRequestScope()

Specified by:

getRequestScope in interface TilesRequestContext

getSessionScope

public java.util.Map<java.lang.String,java.lang.Object> getSessionScope()

Specified by:

getSessionScope in interface TilesRequestContext

getApplicationContext

public TilesApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface TilesRequestContext

dispatch

public void dispatch(java.lang.String path)
              throws java.io.IOException

Specified by:

dispatch in interface TilesRequestContext

Throws:

java.io.IOException

include

public void include(java.lang.String path)
             throws java.io.IOException

Specified by:

include in interface TilesRequestContext

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Specified by:

getOutputStream in interface TilesRequestContext

Throws:

java.io.IOException

getPrintWriter

public java.io.PrintWriter getPrintWriter()
                                   throws java.io.IOException

Specified by:

getPrintWriter in interface TilesRequestContext

Throws:

java.io.IOException

getWriter

public java.io.Writer getWriter()
                         throws java.io.IOException

Specified by:

getWriter in interface TilesRequestContext

Throws:

java.io.IOException

isResponseCommitted

public boolean isResponseCommitted()

Specified by:

isResponseCommitted in interface TilesRequestContext

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface TilesRequestContext

getRequestObjects

public java.lang.Object[] getRequestObjects()

Specified by:

getRequestObjects in interface TilesRequestContext

getRequestLocale

public java.util.Locale getRequestLocale()

Specified by:

getRequestLocale in interface TilesRequestContext

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface TilesRequestContext