org.apache.cocoon.environment.portlet
Class PortletObjectModelHelper

java.lang.Object
  org.apache.cocoon.environment.portlet.PortletObjectModelHelper

public final class PortletObjectModelHelper
extends Object

A set of constants and methods to access the JSR-168 (Portlet) specific objects from the object model. The object model is a Map used to pass information about the calling environment to the sitemap and its components (matchers, actions, transformers, etc).

Version:

CVS $Id: PortletObjectModelHelper.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Alex Rudnev

Field Summary

static String	ACTION_REQUEST_OBJECT Key for the environment ActionRequest in the object model.
static String	ACTION_RESPONSE_OBJECT Key for the environment ActionResponse in the object model.
static String	PORTLET_CONTEXT_OBJECT Key for the environment PortletContext in the object model.
static String	PORTLET_REQUEST_OBJECT Key for the environment PortletRequest in the object model.
static String	PORTLET_RESPONSE_OBJECT Key for the environment PortletResponse in the object model.
static String	RENDER_REQUEST_OBJECT Key for the environment RenderRequest in the object model.
static String	RENDER_RESPONSE_OBJECT Key for the environment RenderResponse in the object model.

Method Summary

static javax.portlet.ActionRequest	getActionRequest(Map objectModel)
static javax.portlet.ActionResponse	getActionResponse(Map objectModel)
static javax.portlet.PortletContext	getPortletContext(Map objectModel)
static javax.portlet.PortletRequest	getPortletRequest(Map objectModel)
static javax.portlet.PortletResponse	getPortletResponse(Map objectModel)
static javax.portlet.RenderRequest	getRenderRequest(Map objectModel)
static javax.portlet.RenderResponse	getRenderResponse(Map objectModel)
static void	setPortletContext(Map objectModel, javax.portlet.PortletContext object)
static void	setPortletRequest(Map objectModel, javax.portlet.PortletRequest object)
static void	setPortletResponse(Map objectModel, javax.portlet.PortletResponse object)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RENDER_REQUEST_OBJECT

public static final String RENDER_REQUEST_OBJECT

Key for the environment RenderRequest in the object model.

See Also:

Constant Field Values

ACTION_REQUEST_OBJECT

public static final String ACTION_REQUEST_OBJECT

Key for the environment ActionRequest in the object model.

See Also:

Constant Field Values

RENDER_RESPONSE_OBJECT

public static final String RENDER_RESPONSE_OBJECT

Key for the environment RenderResponse in the object model.

See Also:

Constant Field Values

ACTION_RESPONSE_OBJECT

public static final String ACTION_RESPONSE_OBJECT

Key for the environment ActionResponse in the object model.

See Also:

Constant Field Values

PORTLET_REQUEST_OBJECT

public static final String PORTLET_REQUEST_OBJECT

Key for the environment PortletRequest in the object model.

See Also:

Constant Field Values

PORTLET_RESPONSE_OBJECT

public static final String PORTLET_RESPONSE_OBJECT

Key for the environment PortletResponse in the object model.

See Also:

Constant Field Values

PORTLET_CONTEXT_OBJECT

public static final String PORTLET_CONTEXT_OBJECT

Key for the environment PortletContext in the object model.

See Also:

Constant Field Values

Method Detail

getRenderRequest

public static final javax.portlet.RenderRequest getRenderRequest(Map objectModel)

getRenderResponse

public static final javax.portlet.RenderResponse getRenderResponse(Map objectModel)

getActionRequest

public static final javax.portlet.ActionRequest getActionRequest(Map objectModel)

getActionResponse

public static final javax.portlet.ActionResponse getActionResponse(Map objectModel)

getPortletRequest

public static final javax.portlet.PortletRequest getPortletRequest(Map objectModel)

getPortletResponse

public static final javax.portlet.PortletResponse getPortletResponse(Map objectModel)

getPortletContext

public static final javax.portlet.PortletContext getPortletContext(Map objectModel)

setPortletRequest

public static final void setPortletRequest(Map objectModel,
                                           javax.portlet.PortletRequest object)

setPortletResponse

public static final void setPortletResponse(Map objectModel,
                                            javax.portlet.PortletResponse object)

setPortletContext

public static final void setPortletContext(Map objectModel,
                                           javax.portlet.PortletContext object)