com.liferay.portlet

Class PortletRequestImpl

java.lang.Object

com.liferay.portlet.PortletRequestImpl

All Implemented Interfaces:

com.liferay.portal.kernel.portlet.LiferayPortletRequest, javax.portlet.PortletRequest

Direct Known Subclasses:

ClientDataRequestImpl, EventRequestImpl, RenderRequestImpl

public abstract class PortletRequestImpl
extends java.lang.Object
implements com.liferay.portal.kernel.portlet.LiferayPortletRequest

Author:

Brian Wing Shun Chan, Brian Myunghun Kim, Sergey Ponomarev, Raymond Augé

Nested Class Summary

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

javax.portlet.PortletRequest.P3PUserInfos

Field Summary

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()

Method Summary

Modifier and Type	Method and Description
void	cleanUp()
java.util.Map<java.lang.String,java.lang.String[]>	clearRenderParameters()
void	defineObjects(javax.portlet.PortletConfig portletConfig, javax.portlet.PortletResponse portletResponse)
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>	getAttributeNames()
java.lang.String	getAuthType()
javax.ccpp.Profile	getCCPPProfile()
java.lang.String	getContextPath()
javax.servlet.http.Cookie[]	getCookies()
java.lang.String	getETag()
javax.servlet.http.HttpServletRequest	getHttpServletRequest()
abstract java.lang.String	getLifecycle()
java.util.Locale	getLocale()
java.util.Enumeration<java.util.Locale>	getLocales()
java.lang.String	getMethod()
javax.servlet.http.HttpServletRequest	getOriginalHttpServletRequest()
java.lang.String	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap()
java.util.Enumeration<java.lang.String>	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
long	getPlid()
javax.portlet.PortalContext	getPortalContext()
com.liferay.portal.kernel.model.Portlet	getPortlet()
javax.portlet.PortletContext	getPortletContext()
javax.portlet.PortletMode	getPortletMode()
java.lang.String	getPortletName()
javax.servlet.http.HttpServletRequest	getPortletRequestDispatcherRequest()
static PortletRequestImpl	getPortletRequestImpl(javax.portlet.PortletRequest portletRequest)
javax.portlet.PortletSession	getPortletSession()
javax.portlet.PortletSession	getPortletSession(boolean create)
javax.portlet.PortletPreferences	getPreferences()
PortletPreferencesImpl	getPreferencesImpl()
java.util.Map<java.lang.String,java.lang.String[]>	getPrivateParameterMap()
java.util.Enumeration<java.lang.String>	getProperties(java.lang.String name)
java.lang.String	getProperty(java.lang.String name)
java.util.Enumeration<java.lang.String>	getPropertyNames()
java.util.Map<java.lang.String,java.lang.String[]>	getPublicParameterMap()
java.lang.String	getRemoteUser()
java.lang.String	getRequestedSessionId()
java.lang.String	getResponseContentType()
java.util.Enumeration<java.lang.String>	getResponseContentTypes()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getUserInfo()
java.security.Principal	getUserPrincipal()
java.lang.String	getWindowID()
javax.portlet.WindowState	getWindowState()
protected void	init(javax.servlet.http.HttpServletRequest request, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.portlet.InvokerPortlet invokerPortlet, javax.portlet.PortletContext portletContext, javax.portlet.WindowState windowState, javax.portlet.PortletMode portletMode, javax.portlet.PortletPreferences preferences, long plid)
void	invalidateSession()
boolean	isInvalidParameter(java.lang.String name)
boolean	isPortletModeAllowed(javax.portlet.PortletMode portletMode)
boolean	isPrivateRequestAttributes()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isTriggeredByActionURL()
boolean	isUserInRole(java.lang.String role)
boolean	isWindowStateAllowed(javax.portlet.WindowState windowState)
protected void	mergePublicRenderParameters(com.liferay.portal.kernel.servlet.DynamicServletRequest dynamicRequest, javax.portlet.PortletPreferences preferences, long plid) Deprecated. As of Judson (7.1.x), replaced by _mergePublicRenderParameters(DynamicServletRequest, Map, PortletPreferences, String)
void	removeAttribute(java.lang.String name)
protected java.lang.String	removePortletNamespace(java.lang.String portletNamespace, java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object obj)
void	setPortletMode(javax.portlet.PortletMode portletMode)
void	setPortletRequestDispatcherRequest(javax.servlet.http.HttpServletRequest request)
void	setWindowState(javax.portlet.WindowState windowState)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletRequestImpl

public PortletRequestImpl()

Method Detail

getPortletRequestImpl

public static PortletRequestImpl getPortletRequestImpl(javax.portlet.PortletRequest portletRequest)

cleanUp

public void cleanUp()

clearRenderParameters

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

Specified by:

clearRenderParameters in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

defineObjects

public void defineObjects(javax.portlet.PortletConfig portletConfig,
                          javax.portlet.PortletResponse portletResponse)

Specified by:

defineObjects in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.portlet.PortletRequest

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.portlet.PortletRequest

getAuthType

public java.lang.String getAuthType()

Specified by:

getAuthType in interface javax.portlet.PortletRequest

getCCPPProfile

public javax.ccpp.Profile getCCPPProfile()

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface javax.portlet.PortletRequest

getCookies

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

Specified by:

getCookies in interface javax.portlet.PortletRequest

getETag

public java.lang.String getETag()

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Specified by:

getHttpServletRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getLifecycle

public abstract java.lang.String getLifecycle()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.portlet.PortletRequest

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

Specified by:

getLocales in interface javax.portlet.PortletRequest

getMethod

public java.lang.String getMethod()

getOriginalHttpServletRequest

public javax.servlet.http.HttpServletRequest getOriginalHttpServletRequest()

Specified by:

getOriginalHttpServletRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getParameter

public java.lang.String getParameter(java.lang.String name)

Specified by:

getParameter in interface javax.portlet.PortletRequest

getParameterMap

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

Specified by:

getParameterMap in interface javax.portlet.PortletRequest

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

Specified by:

getParameterNames in interface javax.portlet.PortletRequest

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Specified by:

getParameterValues in interface javax.portlet.PortletRequest

getPlid

public long getPlid()

Specified by:

getPlid in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getPortalContext

public javax.portlet.PortalContext getPortalContext()

Specified by:

getPortalContext in interface javax.portlet.PortletRequest

getPortlet

public com.liferay.portal.kernel.model.Portlet getPortlet()

Specified by:

getPortlet in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getPortletContext

public javax.portlet.PortletContext getPortletContext()

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Specified by:

getPortletMode in interface javax.portlet.PortletRequest

getPortletName

public java.lang.String getPortletName()

Specified by:

getPortletName in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest

getPortletRequestDispatcherRequest

public javax.servlet.http.HttpServletRequest getPortletRequestDispatcherRequest()

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

getPreferences

public javax.portlet.PortletPreferences getPreferences()

Specified by:

getPreferences in interface javax.portlet.PortletRequest

getPreferencesImpl

public PortletPreferencesImpl getPreferencesImpl()

getPrivateParameterMap

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

Specified by:

getPrivateParameterMap in interface javax.portlet.PortletRequest

getProperties

public java.util.Enumeration<java.lang.String> getProperties(java.lang.String name)

Specified by:

getProperties in interface javax.portlet.PortletRequest

getProperty

public java.lang.String getProperty(java.lang.String name)

Specified by:

getProperty in interface javax.portlet.PortletRequest

getPropertyNames

public java.util.Enumeration<java.lang.String> getPropertyNames()

Specified by:

getPropertyNames in interface javax.portlet.PortletRequest

getPublicParameterMap

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

Specified by:

getPublicParameterMap in interface javax.portlet.PortletRequest

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.portlet.PortletRequest

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.portlet.PortletRequest

getResponseContentType

public java.lang.String getResponseContentType()

Specified by:

getResponseContentType in interface javax.portlet.PortletRequest

getResponseContentTypes

public java.util.Enumeration<java.lang.String> getResponseContentTypes()

Specified by:

getResponseContentTypes in interface javax.portlet.PortletRequest

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface javax.portlet.PortletRequest

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface javax.portlet.PortletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.portlet.PortletRequest

getUserInfo

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getUserInfo()

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.portlet.PortletRequest

getWindowID

public java.lang.String getWindowID()

Specified by:

getWindowID in interface javax.portlet.PortletRequest

getWindowState

public javax.portlet.WindowState getWindowState()

Specified by:

getWindowState in interface javax.portlet.PortletRequest

invalidateSession

public void invalidateSession()

isInvalidParameter

public boolean isInvalidParameter(java.lang.String name)

isPortletModeAllowed

public boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)

Specified by:

isPortletModeAllowed in interface javax.portlet.PortletRequest

isPrivateRequestAttributes

public boolean isPrivateRequestAttributes()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface javax.portlet.PortletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.portlet.PortletRequest

isTriggeredByActionURL

public boolean isTriggeredByActionURL()

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface javax.portlet.PortletRequest

isWindowStateAllowed

public boolean isWindowStateAllowed(javax.portlet.WindowState windowState)

Specified by:

isWindowStateAllowed in interface javax.portlet.PortletRequest

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface javax.portlet.PortletRequest

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object obj)

Specified by:

setAttribute in interface javax.portlet.PortletRequest

setPortletMode

public void setPortletMode(javax.portlet.PortletMode portletMode)

setPortletRequestDispatcherRequest

public void setPortletRequestDispatcherRequest(javax.servlet.http.HttpServletRequest request)

setWindowState

public void setWindowState(javax.portlet.WindowState windowState)

init

protected void init(javax.servlet.http.HttpServletRequest request,
                    com.liferay.portal.kernel.model.Portlet portlet,
                    com.liferay.portal.kernel.portlet.InvokerPortlet invokerPortlet,
                    javax.portlet.PortletContext portletContext,
                    javax.portlet.WindowState windowState,
                    javax.portlet.PortletMode portletMode,
                    javax.portlet.PortletPreferences preferences,
                    long plid)

mergePublicRenderParameters

@Deprecated
protected void mergePublicRenderParameters(com.liferay.portal.kernel.servlet.DynamicServletRequest dynamicRequest,
                                                       javax.portlet.PortletPreferences preferences,
                                                       long plid)

Deprecated. As of Judson (7.1.x), replaced by _mergePublicRenderParameters(DynamicServletRequest, Map, PortletPreferences, String)

removePortletNamespace

protected java.lang.String removePortletNamespace(java.lang.String portletNamespace,
                                                  java.lang.String name)