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

Class PortletRequestAttributes

java.lang.Object

org.gatein.pc.portlet.impl.jsr168.PortletRequestAttributes

public class PortletRequestAttributes
extends Object

Hold the portlet request attributes and holds only the modified state. That is the reason motivating the presence of an HttpServletRequest on the methods returning data reading the state. The object can be used either during the render request where the dispatched request will be used. It can also be used during a request dispatch made from the portlet to a servlet, in that situation the request provided will be the one valid during the dispatching operation. The other motivation of this class is to hold the state of the attributes that have been modified by the request to the portlet container, so it will not write in the portal request attributes.

Version:

$Revision: 1.1 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field	Description
protected static Object	REMOVED_ATTRIBUTE	Constant object to mark that a request attribute is removed.

Constructor Summary

Constructors

Constructor	Description
PortletRequestAttributes(org.gatein.pc.api.spi.SecurityContext securityContext, PortletContainer container, org.gatein.pc.api.spi.UserContext userContext, javax.servlet.http.HttpServletRequestWrapper wreq)

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)
Map<String,Object>	getAttributeMap()
Iterator<String>	getAttributeNames()
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setAttributeMap(Map<String,Object> map)

Methods inherited from class java.lang.Object

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

Field Detail

REMOVED_ATTRIBUTE

protected static final Object REMOVED_ATTRIBUTE

Constant object to mark that a request attribute is removed.

Constructor Detail

PortletRequestAttributes

public PortletRequestAttributes(org.gatein.pc.api.spi.SecurityContext securityContext,
                                PortletContainer container,
                                org.gatein.pc.api.spi.UserContext userContext,
                                javax.servlet.http.HttpServletRequestWrapper wreq)

Method Detail

getAttribute

public Object getAttribute(String name)

getAttributeNames

public Iterator<String> getAttributeNames()

setAttribute

public void setAttribute(String name,
                         Object value)

removeAttribute

public void removeAttribute(String name)

setAttributeMap

public void setAttributeMap(Map<String,Object> map)

getAttributeMap

public Map<String,Object> getAttributeMap()