PortletRequestImpl (Liferay 7.4.3.63-ga63 portal-impl API)

Object
- com.liferay.portlet.internal.PortletRequestImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientDataRequestImpl, EventRequestImpl, RenderRequestImpl
```
public abstract class PortletRequestImpl
extends Object
implements com.liferay.portal.kernel.portlet.LiferayPortletRequest
```
Author:

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

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, HEADER_PHASE, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors
Constructor and Description

PortletRequestImpl()

Constructors
Constructor and Description
`PortletRequestImpl()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cleanUp()`
`Map<String,String[]>`	`clearRenderParameters()`
`void`	`defineObjects(javax.portlet.PortletConfig portletConfig, javax.portlet.PortletResponse portletResponse)`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`Object`	`getCCPPProfile()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`String`	`getETag()`
`javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()`
`abstract String`	`getLifecycle()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getMethod()`
`javax.servlet.http.HttpServletRequest`	`getOriginalHttpServletRequest()`
`String`	`getParameter(String name)` Deprecated. As of Judson (7.1.x)
`Map<String,String[]>`	`getParameterMap()` Deprecated. As of Judson (7.1.x)
`Enumeration<String>`	`getParameterNames()` Deprecated. As of Judson (7.1.x)
`String[]`	`getParameterValues(String name)` Deprecated. As of Judson (7.1.x)
`long`	`getPlid()`
`javax.portlet.PortalContext`	`getPortalContext()`
`com.liferay.portal.kernel.model.Portlet`	`getPortlet()`
`javax.portlet.PortletContext`	`getPortletContext()`
`javax.portlet.PortletMode`	`getPortletMode()`
`String`	`getPortletName()`
`javax.servlet.http.HttpServletRequest`	`getPortletRequestDispatcherRequest()`
`javax.portlet.PortletSession`	`getPortletSession()`
`javax.portlet.PortletSession`	`getPortletSession(boolean create)`
`protected int`	`getPortletSpecMajorVersion()`
`javax.portlet.PortletPreferences`	`getPreferences()`
`PortletPreferencesImpl`	`getPreferencesImpl()`
`Map<String,String[]>`	`getPrivateParameterMap()` Deprecated. As of Judson (7.1.x)
`Enumeration<String>`	`getProperties(String name)`
`String`	`getProperty(String name)`
`Enumeration<String>`	`getPropertyNames()`
`Map<String,String[]>`	`getPublicParameterMap()` Deprecated. As of Judson (7.1.x)
`String`	`getRemoteUser()`
`javax.portlet.RenderParameters`	`getRenderParameters()`
`String`	`getRequestedSessionId()`
`String`	`getResponseContentType()`
`Enumeration<String>`	`getResponseContentTypes()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`String`	`getUserAgent()`
`LinkedHashMap<String,String>`	`getUserInfo()`
`Principal`	`getUserPrincipal()`
`String`	`getWindowID()`
`javax.portlet.WindowState`	`getWindowState()`
`void`	`init(javax.servlet.http.HttpServletRequest httpServletRequest, 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`	`isPortletModeAllowed(javax.portlet.PortletMode portletMode)`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isTriggeredByActionURL()`
`boolean`	`isUserInRole(String role)`
`boolean`	`isWindowStateAllowed(javax.portlet.WindowState windowState)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`void`	`setPortletMode(javax.portlet.PortletMode portletMode)`
`void`	`setPortletRequestDispatcherRequest(javax.servlet.http.HttpServletRequest httpServletRequest)`
`void`	`setWindowState(javax.portlet.WindowState windowState)`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PortletRequestImpl
```
public PortletRequestImpl()
```
- Method Detail
  - cleanUp
```
public void cleanUp()
```
    Specified by:
    
    cleanUp in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - clearRenderParameters
```
public Map<String,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 Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.portlet.PortletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.portlet.PortletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.portlet.PortletRequest
  - getCCPPProfile
```
public Object getCCPPProfile()
```
  - getContextPath
```
public 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 String getETag()
```
  - getHttpServletRequest
```
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    Specified by:
    
    getHttpServletRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - getLifecycle
```
public abstract String getLifecycle()
```
    Specified by:
    
    getLifecycle in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.portlet.PortletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.portlet.PortletRequest
  - getMethod
```
public String getMethod()
```
  - getOriginalHttpServletRequest
```
public javax.servlet.http.HttpServletRequest getOriginalHttpServletRequest()
```
    Specified by:
    
    getOriginalHttpServletRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - getParameter
```
@Deprecated
public String getParameter(String name)
```
    Deprecated. As of Judson (7.1.x)
    
    Specified by:
    
    getParameter in interface javax.portlet.PortletRequest
  - getParameterMap
```
@Deprecated
public Map<String,String[]> getParameterMap()
```
    Deprecated. As of Judson (7.1.x)
    
    Specified by:
    
    getParameterMap in interface javax.portlet.PortletRequest
  - getParameterNames
```
@Deprecated
public Enumeration<String> getParameterNames()
```
    Deprecated. As of Judson (7.1.x)
    
    Specified by:
    
    getParameterNames in interface javax.portlet.PortletRequest
  - getParameterValues
```
@Deprecated
public String[] getParameterValues(String name)
```
    Deprecated. As of Judson (7.1.x)
    
    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()
```
    Specified by:
    
    getPortletContext in interface javax.portlet.PortletRequest
  - getPortletMode
```
public javax.portlet.PortletMode getPortletMode()
```
    Specified by:
    
    getPortletMode in interface javax.portlet.RenderState
  - getPortletName
```
public String getPortletName()
```
    Specified by:
    
    getPortletName in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - getPortletRequestDispatcherRequest
```
public javax.servlet.http.HttpServletRequest getPortletRequestDispatcherRequest()
```
    Specified by:
    
    getPortletRequestDispatcherRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - 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
```
@Deprecated
public Map<String,String[]> getPrivateParameterMap()
```
    Deprecated. As of Judson (7.1.x)
    
    Specified by:
    
    getPrivateParameterMap in interface javax.portlet.PortletRequest
  - getProperties
```
public Enumeration<String> getProperties(String name)
```
    Specified by:
    
    getProperties in interface javax.portlet.PortletRequest
  - getProperty
```
public String getProperty(String name)
```
    Specified by:
    
    getProperty in interface javax.portlet.PortletRequest
  - getPropertyNames
```
public Enumeration<String> getPropertyNames()
```
    Specified by:
    
    getPropertyNames in interface javax.portlet.PortletRequest
  - getPublicParameterMap
```
@Deprecated
public Map<String,String[]> getPublicParameterMap()
```
    Deprecated. As of Judson (7.1.x)
    
    Specified by:
    
    getPublicParameterMap in interface javax.portlet.PortletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.portlet.PortletRequest
  - getRenderParameters
```
public javax.portlet.RenderParameters getRenderParameters()
```
    Specified by:
    
    getRenderParameters in interface javax.portlet.RenderState
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId 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
  - 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
  - getUserAgent
```
public String getUserAgent()
```
    Specified by:
    
    getUserAgent in interface javax.portlet.PortletRequest
  - getUserInfo
```
public LinkedHashMap<String,String> getUserInfo()
```
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.portlet.PortletRequest
  - getWindowID
```
public String getWindowID()
```
    Specified by:
    
    getWindowID in interface javax.portlet.PortletRequest
  - getWindowState
```
public javax.portlet.WindowState getWindowState()
```
    Specified by:
    
    getWindowState in interface javax.portlet.RenderState
  - init
```
public void init(javax.servlet.http.HttpServletRequest httpServletRequest,
                 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)
```
  - invalidateSession
```
public void invalidateSession()
```
    Specified by:
    
    invalidateSession in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - isPortletModeAllowed
```
public boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)
```
    Specified by:
    
    isPortletModeAllowed in interface javax.portlet.PortletRequest
  - 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(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(String name)
```
    Specified by:
    
    removeAttribute in interface javax.portlet.PortletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    Specified by:
    
    setAttribute in interface javax.portlet.PortletRequest
  - setPortletMode
```
public void setPortletMode(javax.portlet.PortletMode portletMode)
```
  - setPortletRequestDispatcherRequest
```
public void setPortletRequestDispatcherRequest(javax.servlet.http.HttpServletRequest httpServletRequest)
```
    Specified by:
    
    setPortletRequestDispatcherRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
  - setWindowState
```
public void setWindowState(javax.portlet.WindowState windowState)
```
  - getPortletSpecMajorVersion
```
protected int getPortletSpecMajorVersion()
```

Class PortletRequestImpl

Nested Class Summary

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

Field Summary

Fields inherited from interface javax.portlet.PortletRequest

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

PortletRequestImpl

Method Detail

cleanUp

clearRenderParameters

defineObjects

getAttribute

getAttributeNames

getAuthType

getCCPPProfile

getContextPath

getCookies

getETag

getHttpServletRequest

getLifecycle

getLocale

getLocales

getMethod

getOriginalHttpServletRequest

getParameter

getParameterMap

getParameterNames

getParameterValues

getPlid

getPortalContext

getPortlet

getPortletContext

getPortletMode

getPortletName

getPortletRequestDispatcherRequest

getPortletSession

getPortletSession

getPreferences

getPreferencesImpl

getPrivateParameterMap

getProperties

getProperty

getPropertyNames

getPublicParameterMap

getRemoteUser

getRenderParameters

getRequestedSessionId

getResponseContentType

getResponseContentTypes

getScheme

getServerName

getServerPort

getUserAgent

getUserInfo

getUserPrincipal

getWindowID

getWindowState

init

invalidateSession

isPortletModeAllowed

isRequestedSessionIdValid

isSecure

isTriggeredByActionURL

isUserInRole

isWindowStateAllowed

removeAttribute

setAttribute

setPortletMode

setPortletRequestDispatcherRequest

setWindowState

getPortletSpecMajorVersion