org.gatein.pc.portlet.impl.jsr168.api

Class PortletRequestImpl

java.lang.Object

org.gatein.pc.portlet.impl.jsr168.api.PortletRequestImpl

All Implemented Interfaces:

javax.portlet.PortletRequest

Direct Known Subclasses:

ClientDataRequestImpl, EventRequestImpl, RenderRequestImpl

public abstract class PortletRequestImpl
extends Object
implements javax.portlet.PortletRequest

PortletRequest implemention. The parameter implementation is left to subclasses that can implement it differently.

Version:

$Revision: 7226 $

Author:

Julien Viet, Boleslaw Dawidowicz

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.PortletRequest

javax.portlet.PortletRequest.P3PUserInfos

Field Summary

Fields

Modifier and Type	Field and Description
protected PortletRequestAttributes	attributes .
protected ClientContext	clientContext .
protected PortletContainerImpl	container .
protected PortletInvocation	invocation .
protected static org.gatein.common.logging.Logger	log .
protected ContainerNavigationInfo	navigationInfo .
protected javax.portlet.PortalContext	portalContext .
protected javax.portlet.PortletPreferences	preferences .
protected PortletSessionImpl	psession .
protected PortletRequestParameterMap	requestParameterMap .
protected SecurityContext	securityContext .
protected ServerContext	serverContext .
protected int	sessionStatus .
protected Set<Mode>	supportedModes .
protected Set<WindowState>	supportedWindowStates .
protected UserContext	userContext .
protected WindowContext	windowContext .

Fields inherited from interface javax.portlet.PortletRequest

ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors

Constructor and Description
PortletRequestImpl(PortletContainerImpl container, PortletInvocation invocation)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
PortletRequestAttributes	getAttributes()
String	getAuthType()
String	getContextPath()
javax.servlet.http.Cookie[]	getCookies()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
javax.portlet.PortalContext	getPortalContext()
javax.portlet.PortletMode	getPortletMode()
javax.portlet.PortletSession	getPortletSession()
javax.portlet.PortletSession	getPortletSession(boolean create)
javax.portlet.PortletPreferences	getPreferences()
Map<String,String[]>	getPrivateParameterMap()
Enumeration<String>	getProperties(String name)
String	getProperty(String name)
Enumeration<String>	getPropertyNames()
Map<String,String[]>	getPublicParameterMap()
javax.servlet.http.HttpServletRequestWrapper	getRealRequest()
String	getRemoteUser()
String	getRequestedSessionId()
String	getResponseContentType()
Enumeration<String>	getResponseContentTypes()
String	getScheme()
String	getServerName()
int	getServerPort()
Principal	getUserPrincipal()
String	getWindowID()
javax.portlet.WindowState	getWindowState()
protected void	initProperties(org.gatein.common.util.MultiValuedPropertyMap<String> properties)
boolean	isPortletModeAllowed(javax.portlet.PortletMode portletMode)
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String roleName)
boolean	isWindowStateAllowed(javax.portlet.WindowState windowState)
void	removeAttribute(String name)
void	setAttribute(String name, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.gatein.common.logging.Logger log

.

invocation

protected PortletInvocation invocation

.

clientContext

protected ClientContext clientContext

.

userContext

protected UserContext userContext

.

securityContext

protected SecurityContext securityContext

.

serverContext

protected ServerContext serverContext

.

windowContext

protected WindowContext windowContext

.

preferences

protected javax.portlet.PortletPreferences preferences

.

container

protected PortletContainerImpl container

.

portalContext

protected javax.portlet.PortalContext portalContext

.

psession

protected PortletSessionImpl psession

.

sessionStatus

protected int sessionStatus

.

navigationInfo

protected ContainerNavigationInfo navigationInfo

.

attributes

protected final PortletRequestAttributes attributes

.

requestParameterMap

protected final PortletRequestParameterMap requestParameterMap

.

supportedModes

protected final Set<Mode> supportedModes

.

supportedWindowStates

protected final Set<WindowState> supportedWindowStates

.

Constructor Detail

PortletRequestImpl

public PortletRequestImpl(PortletContainerImpl container,
                  PortletInvocation invocation)

Method Detail

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface javax.portlet.PortletRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface javax.portlet.PortletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface javax.portlet.PortletRequest

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface javax.portlet.PortletRequest

getWindowState

public javax.portlet.WindowState getWindowState()

Specified by:

getWindowState in interface javax.portlet.PortletRequest

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Specified by:

getPortletMode in interface javax.portlet.PortletRequest

getAttribute

public Object getAttribute(String name)
                    throws IllegalArgumentException

Specified by:

getAttribute in interface javax.portlet.PortletRequest

Throws:

IllegalArgumentException

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.portlet.PortletRequest

setAttribute

public void setAttribute(String name,
                Object value)

Specified by:

setAttribute in interface javax.portlet.PortletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.portlet.PortletRequest

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface javax.portlet.PortletRequest

getProperties

public Enumeration<String> getProperties(String name)

Specified by:

getProperties in interface javax.portlet.PortletRequest

getPropertyNames

public Enumeration<String> getPropertyNames()

Specified by:

getPropertyNames in interface javax.portlet.PortletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface javax.portlet.PortletRequest

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface javax.portlet.PortletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface javax.portlet.PortletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.portlet.PortletRequest

isUserInRole

public boolean isUserInRole(String roleName)

Specified by:

isUserInRole in interface javax.portlet.PortletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.portlet.PortletRequest

getResponseContentType

public String getResponseContentType()

Specified by:

getResponseContentType in interface javax.portlet.PortletRequest

getResponseContentTypes

public Enumeration<String> getResponseContentTypes()

Specified by:

getResponseContentTypes in interface javax.portlet.PortletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.portlet.PortletRequest

isPortletModeAllowed

public boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)

Specified by:

isPortletModeAllowed in interface javax.portlet.PortletRequest

isWindowStateAllowed

public boolean isWindowStateAllowed(javax.portlet.WindowState windowState)

Specified by:

isWindowStateAllowed in interface javax.portlet.PortletRequest

getPortletSession

public javax.portlet.PortletSession getPortletSession()

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

getPortletSession

public javax.portlet.PortletSession getPortletSession(boolean create)

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

getPortalContext

public javax.portlet.PortalContext getPortalContext()

Specified by:

getPortalContext in interface javax.portlet.PortletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.portlet.PortletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface javax.portlet.PortletRequest

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface javax.portlet.PortletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface javax.portlet.PortletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface javax.portlet.PortletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.portlet.PortletRequest

getPreferences

public javax.portlet.PortletPreferences getPreferences()

Specified by:

getPreferences in interface javax.portlet.PortletRequest

getAttributes

public PortletRequestAttributes getAttributes()

getWindowID

public String getWindowID()

Specified by:

getWindowID in interface javax.portlet.PortletRequest

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface javax.portlet.PortletRequest

getPrivateParameterMap

public Map<String,String[]> getPrivateParameterMap()

Specified by:

getPrivateParameterMap in interface javax.portlet.PortletRequest

getPublicParameterMap

public Map<String,String[]> getPublicParameterMap()

Specified by:

getPublicParameterMap in interface javax.portlet.PortletRequest

getRealRequest

public final javax.servlet.http.HttpServletRequestWrapper getRealRequest()

initProperties

protected void initProperties(org.gatein.common.util.MultiValuedPropertyMap<String> properties)