Class PortletRequestImpl

Object
com.liferay.portlet.internal.PortletRequestImpl
All Implemented Interfaces:
com.liferay.portal.kernel.portlet.LiferayPortletRequest, jakarta.portlet.PortletRequest, jakarta.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
  • Constructor Details

    • PortletRequestImpl

      public PortletRequestImpl()
  • Method Details

    • 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(jakarta.portlet.PortletConfig portletConfig, jakarta.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 jakarta.portlet.PortletRequest
    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Specified by:
      getAttributeNames in interface jakarta.portlet.PortletRequest
    • getAuthType

      public String getAuthType()
      Specified by:
      getAuthType in interface jakarta.portlet.PortletRequest
    • getCCPPProfile

      public Object getCCPPProfile()
    • getContextPath

      public String getContextPath()
      Specified by:
      getContextPath in interface jakarta.portlet.PortletRequest
    • getCookies

      public jakarta.servlet.http.Cookie[] getCookies()
      Specified by:
      getCookies in interface jakarta.portlet.PortletRequest
    • getETag

      public String getETag()
    • getHttpServletRequest

      public jakarta.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 jakarta.portlet.PortletRequest
    • getLocales

      public Enumeration<Locale> getLocales()
      Specified by:
      getLocales in interface jakarta.portlet.PortletRequest
    • getMethod

      public String getMethod()
    • getOriginalHttpServletRequest

      public jakarta.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 jakarta.portlet.PortletRequest
    • getParameterMap

      @Deprecated public Map<String,String[]> getParameterMap()
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      getParameterMap in interface jakarta.portlet.PortletRequest
    • getParameterNames

      @Deprecated public Enumeration<String> getParameterNames()
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      getParameterNames in interface jakarta.portlet.PortletRequest
    • getParameterValues

      @Deprecated public String[] getParameterValues(String name)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      getParameterValues in interface jakarta.portlet.PortletRequest
    • getPlid

      public long getPlid()
      Specified by:
      getPlid in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • getPortalContext

      public jakarta.portlet.PortalContext getPortalContext()
      Specified by:
      getPortalContext in interface jakarta.portlet.PortletRequest
    • getPortlet

      public com.liferay.portal.kernel.model.Portlet getPortlet()
      Specified by:
      getPortlet in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • getPortletContext

      public jakarta.portlet.PortletContext getPortletContext()
      Specified by:
      getPortletContext in interface jakarta.portlet.PortletRequest
    • getPortletMode

      public jakarta.portlet.PortletMode getPortletMode()
      Specified by:
      getPortletMode in interface jakarta.portlet.RenderState
    • getPortletName

      public String getPortletName()
      Specified by:
      getPortletName in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • getPortletRequestDispatcherRequest

      public jakarta.servlet.http.HttpServletRequest getPortletRequestDispatcherRequest()
      Specified by:
      getPortletRequestDispatcherRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • getPortletSession

      public jakarta.portlet.PortletSession getPortletSession()
      Specified by:
      getPortletSession in interface jakarta.portlet.PortletRequest
    • getPortletSession

      public jakarta.portlet.PortletSession getPortletSession(boolean create)
      Specified by:
      getPortletSession in interface jakarta.portlet.PortletRequest
    • getPreferences

      public jakarta.portlet.PortletPreferences getPreferences()
      Specified by:
      getPreferences in interface jakarta.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 jakarta.portlet.PortletRequest
    • getProperties

      public Enumeration<String> getProperties(String name)
      Specified by:
      getProperties in interface jakarta.portlet.PortletRequest
    • getProperty

      public String getProperty(String name)
      Specified by:
      getProperty in interface jakarta.portlet.PortletRequest
    • getPropertyNames

      public Enumeration<String> getPropertyNames()
      Specified by:
      getPropertyNames in interface jakarta.portlet.PortletRequest
    • getPublicParameterMap

      @Deprecated public Map<String,String[]> getPublicParameterMap()
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      getPublicParameterMap in interface jakarta.portlet.PortletRequest
    • getRemoteUser

      public String getRemoteUser()
      Specified by:
      getRemoteUser in interface jakarta.portlet.PortletRequest
    • getRenderParameters

      public jakarta.portlet.RenderParameters getRenderParameters()
      Specified by:
      getRenderParameters in interface jakarta.portlet.RenderState
    • getRequestedSessionId

      public String getRequestedSessionId()
      Specified by:
      getRequestedSessionId in interface jakarta.portlet.PortletRequest
    • getResponseContentType

      public String getResponseContentType()
      Specified by:
      getResponseContentType in interface jakarta.portlet.PortletRequest
    • getResponseContentTypes

      public Enumeration<String> getResponseContentTypes()
      Specified by:
      getResponseContentTypes in interface jakarta.portlet.PortletRequest
    • getScheme

      public String getScheme()
      Specified by:
      getScheme in interface jakarta.portlet.PortletRequest
    • getServerName

      public String getServerName()
      Specified by:
      getServerName in interface jakarta.portlet.PortletRequest
    • getServerPort

      public int getServerPort()
      Specified by:
      getServerPort in interface jakarta.portlet.PortletRequest
    • getUserAgent

      public String getUserAgent()
      Specified by:
      getUserAgent in interface jakarta.portlet.PortletRequest
    • getUserInfo

      public LinkedHashMap<String,String> getUserInfo()
    • getUserPrincipal

      public Principal getUserPrincipal()
      Specified by:
      getUserPrincipal in interface jakarta.portlet.PortletRequest
    • getWindowID

      public String getWindowID()
      Specified by:
      getWindowID in interface jakarta.portlet.PortletRequest
    • getWindowState

      public jakarta.portlet.WindowState getWindowState()
      Specified by:
      getWindowState in interface jakarta.portlet.RenderState
    • init

      public void init(jakarta.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.portlet.InvokerPortlet invokerPortlet, jakarta.portlet.PortletContext portletContext, jakarta.portlet.WindowState windowState, jakarta.portlet.PortletMode portletMode, jakarta.portlet.PortletPreferences portletPreferences, long plid)
    • invalidateSession

      public void invalidateSession()
      Specified by:
      invalidateSession in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • isPortletModeAllowed

      public boolean isPortletModeAllowed(jakarta.portlet.PortletMode portletMode)
      Specified by:
      isPortletModeAllowed in interface jakarta.portlet.PortletRequest
    • isRequestedSessionIdValid

      public boolean isRequestedSessionIdValid()
      Specified by:
      isRequestedSessionIdValid in interface jakarta.portlet.PortletRequest
    • isSecure

      public boolean isSecure()
      Specified by:
      isSecure in interface jakarta.portlet.PortletRequest
    • isTriggeredByActionURL

      public boolean isTriggeredByActionURL()
    • isUserInRole

      public boolean isUserInRole(String role)
      Specified by:
      isUserInRole in interface jakarta.portlet.PortletRequest
    • isWindowStateAllowed

      public boolean isWindowStateAllowed(jakarta.portlet.WindowState windowState)
      Specified by:
      isWindowStateAllowed in interface jakarta.portlet.PortletRequest
    • removeAttribute

      public void removeAttribute(String name)
      Specified by:
      removeAttribute in interface jakarta.portlet.PortletRequest
    • setAttribute

      public void setAttribute(String name, Object object)
      Specified by:
      setAttribute in interface jakarta.portlet.PortletRequest
    • setPortletMode

      public void setPortletMode(jakarta.portlet.PortletMode portletMode)
    • setPortletRequestDispatcherRequest

      public void setPortletRequestDispatcherRequest(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Specified by:
      setPortletRequestDispatcherRequest in interface com.liferay.portal.kernel.portlet.LiferayPortletRequest
    • setWindowState

      public void setWindowState(jakarta.portlet.WindowState windowState)
    • getPortletSpecMajorVersion

      protected int getPortletSpecMajorVersion()