Class PortletURLImpl

Object
com.liferay.portlet.internal.PortletURLImpl
All Implemented Interfaces:
com.liferay.portal.kernel.portlet.LiferayPortletURL, Serializable, BaseURL, Mutable, MutableRenderState, PortletURL, RenderState, ResourceURL
Direct Known Subclasses:
ActionURLImpl, RenderURLImpl

public class PortletURLImpl extends Object implements com.liferay.portal.kernel.portlet.LiferayPortletURL, PortletURL, ResourceURL, Serializable
Author:
Brian Wing Shun Chan, Jorge Ferrer, Connor McKay, Neil Griffin
See Also:
  • Constructor Details

    • PortletURLImpl

      public PortletURLImpl(javax.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, MimeResponse.Copy copy)
    • PortletURLImpl

      public PortletURLImpl(PortletRequest portletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, MimeResponse.Copy copy)
  • Method Details

    • addParameterIncludedInPath

      public void addParameterIncludedInPath(String name)
      Specified by:
      addParameterIncludedInPath in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • addProperty

      public void addProperty(String key, String value)
      Specified by:
      addProperty in interface BaseURL
    • append

      public Appendable append(Appendable appendable) throws IOException
      Specified by:
      append in interface BaseURL
      Throws:
      IOException
    • append

      public Appendable append(Appendable appendable, boolean escapeXml) throws IOException
      Specified by:
      append in interface BaseURL
      Throws:
      IOException
    • getActionParameters

      public MutableActionParameters getActionParameters()
    • getCacheability

      public String getCacheability()
      Specified by:
      getCacheability in interface ResourceURL
    • getHttpServletRequest

      public javax.servlet.http.HttpServletRequest getHttpServletRequest()
    • getLayout

      public com.liferay.portal.kernel.model.Layout getLayout()
    • getLayoutFriendlyURL

      public String getLayoutFriendlyURL()
    • getLifecycle

      public String getLifecycle()
      Specified by:
      getLifecycle in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • getNamespace

      public String getNamespace()
    • getParameter

      @Deprecated public String getParameter(String name)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      getParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • getParameterMap

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

      public Set<String> getParametersIncludedInPath()
      Specified by:
      getParametersIncludedInPath in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • getPlid

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

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

      public String getPortletFriendlyURLPath()
    • getPortletId

      public String getPortletId()
      Specified by:
      getPortletId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • getPortletMode

      public PortletMode getPortletMode()
      Specified by:
      getPortletMode in interface RenderState
    • getPortletRequest

      public PortletRequest getPortletRequest()
    • getRemovedParameterNames

      public Set<String> getRemovedParameterNames()
      Specified by:
      getRemovedParameterNames in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • getRenderParameters

      public MutableRenderParameters getRenderParameters()
      Specified by:
      getRenderParameters in interface MutableRenderState
      Specified by:
      getRenderParameters in interface RenderState
    • getResourceID

      public String getResourceID()
      Specified by:
      getResourceID in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
      Specified by:
      getResourceID in interface ResourceURL
    • getResourceParameters

      public MutableResourceParameters getResourceParameters()
      Specified by:
      getResourceParameters in interface ResourceURL
    • getWindowState

      public WindowState getWindowState()
      Specified by:
      getWindowState in interface RenderState
    • isAnchor

      public boolean isAnchor()
      Specified by:
      isAnchor in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • isCopyCurrentRenderParameters

      public boolean isCopyCurrentRenderParameters()
      Specified by:
      isCopyCurrentRenderParameters in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • isEncrypt

      public boolean isEncrypt()
      Specified by:
      isEncrypt in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • isEscapeXml

      public boolean isEscapeXml()
      Specified by:
      isEscapeXml in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • isParameterIncludedInPath

      public boolean isParameterIncludedInPath(String name)
      Specified by:
      isParameterIncludedInPath in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • isSecure

      public boolean isSecure()
      Specified by:
      isSecure in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • removePublicRenderParameter

      @Deprecated public void removePublicRenderParameter(String name)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      removePublicRenderParameter in interface PortletURL
    • setAnchor

      public void setAnchor(boolean anchor)
      Specified by:
      setAnchor in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setBeanParameter

      public void setBeanParameter(PortletSerializable portletSerializable)
      Specified by:
      setBeanParameter in interface PortletURL
    • setCacheability

      public void setCacheability(String cacheability)
      Specified by:
      setCacheability in interface ResourceURL
    • setCopyCurrentRenderParameters

      public void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
      Specified by:
      setCopyCurrentRenderParameters in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setDoAsGroupId

      public void setDoAsGroupId(long doAsGroupId)
      Specified by:
      setDoAsGroupId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setDoAsUserId

      public void setDoAsUserId(long doAsUserId)
      Specified by:
      setDoAsUserId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setDoAsUserLanguageId

      public void setDoAsUserLanguageId(String doAsUserLanguageId)
      Specified by:
      setDoAsUserLanguageId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setEncrypt

      public void setEncrypt(boolean encrypt)
      Specified by:
      setEncrypt in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setEscapeXml

      public void setEscapeXml(boolean escapeXml)
      Specified by:
      setEscapeXml in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setLifecycle

      public void setLifecycle(String lifecycle)
      Specified by:
      setLifecycle in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setParameter

      @Deprecated public void setParameter(String name, String value)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      setParameter in interface BaseURL
    • setParameter

      @Deprecated public void setParameter(String name, String... values)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      setParameter in interface BaseURL
    • setParameter

      @Deprecated public void setParameter(String name, String value, boolean append)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      setParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setParameter

      @Deprecated public void setParameter(String name, String[] values, boolean append)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      setParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setParameters

      @Deprecated public void setParameters(Map<String,String[]> params)
      Deprecated.
      As of Judson (7.1.x)
      Specified by:
      setParameters in interface BaseURL
    • setPlid

      public void setPlid(long plid)
      Specified by:
      setPlid in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setPortletId

      public void setPortletId(String portletId)
      Specified by:
      setPortletId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setPortletMode

      public void setPortletMode(PortletMode portletMode) throws PortletModeException
      Specified by:
      setPortletMode in interface MutableRenderState
      Throws:
      PortletModeException
    • setPortletMode

      public void setPortletMode(String portletMode) throws PortletModeException
      Throws:
      PortletModeException
    • setProperty

      public void setProperty(String key, String value)
      Specified by:
      setProperty in interface BaseURL
    • setRefererGroupId

      public void setRefererGroupId(long refererGroupId)
      Specified by:
      setRefererGroupId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setRefererPlid

      public void setRefererPlid(long refererPlid)
      Specified by:
      setRefererPlid in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setRemovedParameterNames

      public void setRemovedParameterNames(Set<String> removedParameterNames)
      Specified by:
      setRemovedParameterNames in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • setResourceID

      public void setResourceID(String resourceID)
      Specified by:
      setResourceID in interface ResourceURL
    • setSecure

      public void setSecure(boolean secure) throws PortletSecurityException
      Specified by:
      setSecure in interface BaseURL
      Throws:
      PortletSecurityException
    • setWindowState

      public void setWindowState(String windowState) throws WindowStateException
      Throws:
      WindowStateException
    • setWindowState

      public void setWindowState(WindowState windowState) throws WindowStateException
      Specified by:
      setWindowState in interface MutableRenderState
      Throws:
      WindowStateException
    • setWindowStateRestoreCurrentView

      public void setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView)
      Specified by:
      setWindowStateRestoreCurrentView in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • toString

      public String toString()
      Specified by:
      toString in interface BaseURL
      Overrides:
      toString in class Object
    • visitReservedParameters

      public void visitReservedParameters(BiConsumer<String,String> biConsumer)
      Specified by:
      visitReservedParameters in interface com.liferay.portal.kernel.portlet.LiferayPortletURL
    • write

      public void write(Writer writer) throws IOException
      Specified by:
      write in interface BaseURL
      Throws:
      IOException
    • write

      public void write(Writer writer, boolean escapeXml) throws IOException
      Specified by:
      write in interface BaseURL
      Throws:
      IOException
    • clearCache

      protected void clearCache()
    • generateToString

      protected String generateToString()
    • getPublicRenderParameterName

      protected String getPublicRenderParameterName(String name)
    • processValue

      protected String processValue(Key key, long value)
    • processValue

      protected String processValue(Key key, String value)