Package org.gatein.pc.portlet.impl.jsr168

Class PortletRequestParameterMap

java.lang.Object

org.gatein.pc.portlet.impl.jsr168.PortletRequestParameterMap

Direct Known Subclasses:

ResourceRequestParameterMap

public class PortletRequestParameterMap
extends Object

The main responsibility of this class is to combine the different parameter sources (private navigational state, public navigational state, interaction state, form) into the private map, public map and parameter map.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.gatein.common.util.ParameterMap.AccessMode	COPY_MODE	.
protected final org.gatein.common.util.ParameterMap	parameters	.
protected final org.gatein.common.util.ParameterMap	privateParameters	.
protected final org.gatein.common.util.ParameterMap	publicParameters	.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PortletRequestParameterMap(Map<String,String[]> parameters, Map<String,String[]> privateParameters, Map<String,String[]> publicParameters)

Method Summary

Modifier and Type	Method	Description
static PortletRequestParameterMap	create(org.gatein.pc.api.info.NavigationInfo navigationInfo, org.gatein.pc.api.invocation.ActionInvocation invocation)	- interaction parameter : always - form parameter : if it is a POST with the content type set to application/...
static PortletRequestParameterMap	create(org.gatein.pc.api.info.NavigationInfo navigationInfo, org.gatein.pc.api.invocation.EventInvocation invocation)
static PortletRequestParameterMap	create(org.gatein.pc.api.info.NavigationInfo navigationInfo, org.gatein.pc.api.invocation.PortletInvocation invocation)	Factory method that will chose the right builder according to the context argument type.
static PortletRequestParameterMap	create(org.gatein.pc.api.info.NavigationInfo navigationInfo, org.gatein.pc.api.invocation.RenderInvocation context)
org.gatein.common.util.ParameterMap	getParameters()
org.gatein.common.util.ParameterMap	getPrivateParameters()
org.gatein.common.util.ParameterMap	getPublicParameters()
protected static Map<String,String[]>	safeBuildParameters(org.gatein.pc.api.StateString stateString)
protected static org.gatein.common.util.ParameterMap	safeBuildPublicParameters(org.gatein.pc.api.info.NavigationInfo navigationInfo, Map<String,String[]> publicNavigationalParameters)
protected static Map<String,String[]>	safeCombine(Map<String,String[]> privateParameters, Map<String,String[]> publicParameters)

Methods inherited from class java.lang.Object

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

Field Details

COPY_MODE

protected static final org.gatein.common.util.ParameterMap.AccessMode COPY_MODE

.

parameters

protected final org.gatein.common.util.ParameterMap parameters

.

privateParameters

protected final org.gatein.common.util.ParameterMap privateParameters

.

publicParameters

protected final org.gatein.common.util.ParameterMap publicParameters

.

Constructor Details

PortletRequestParameterMap

protected PortletRequestParameterMap(Map<String,String[]> parameters,
 Map<String,String[]> privateParameters,
 Map<String,String[]> publicParameters)

Method Details

create

public static PortletRequestParameterMap create(org.gatein.pc.api.info.NavigationInfo navigationInfo,
 org.gatein.pc.api.invocation.PortletInvocation invocation)

Factory method that will chose the right builder according to the context argument type.

create

public static PortletRequestParameterMap create(org.gatein.pc.api.info.NavigationInfo navigationInfo,
 org.gatein.pc.api.invocation.EventInvocation invocation)

create

public static PortletRequestParameterMap create(org.gatein.pc.api.info.NavigationInfo navigationInfo,
 org.gatein.pc.api.invocation.RenderInvocation context)

create

public static PortletRequestParameterMap create(org.gatein.pc.api.info.NavigationInfo navigationInfo,
 org.gatein.pc.api.invocation.ActionInvocation invocation)

- interaction parameter : always - form parameter : if it is a POST with the content type set to application/... - public render parameter : optionally sent by the consumer - getParameterMap() : the interaction parameter + form parameters if any + public render parameter - getPrivateParameterMap() : the interaction parameter + form parameter - getPublicParameterMap() : public render parameter

getParameters

public org.gatein.common.util.ParameterMap getParameters()

getPrivateParameters

public org.gatein.common.util.ParameterMap getPrivateParameters()

getPublicParameters

public org.gatein.common.util.ParameterMap getPublicParameters()

safeBuildPublicParameters

protected static org.gatein.common.util.ParameterMap safeBuildPublicParameters(org.gatein.pc.api.info.NavigationInfo navigationInfo,
 Map<String,String[]> publicNavigationalParameters)

safeBuildParameters

protected static Map<String,String[]> safeBuildParameters(org.gatein.pc.api.StateString stateString)

safeCombine

protected static Map<String,String[]> safeCombine(Map<String,String[]> privateParameters,
 Map<String,String[]> publicParameters)