Package com.liferay.portlet.internal
Class PortletURLImpl
Object
com.liferay.portlet.internal.PortletURLImpl
- All Implemented Interfaces:
com.liferay.portal.kernel.portlet.LiferayPortletURL,jakarta.portlet.BaseURL,jakarta.portlet.Mutable,jakarta.portlet.MutableRenderState,jakarta.portlet.PortletURL,jakarta.portlet.RenderState,jakarta.portlet.ResourceURL,Serializable
- Direct Known Subclasses:
ActionURLImpl,RenderURLImpl
public class PortletURLImpl
extends Object
implements com.liferay.portal.kernel.portlet.LiferayPortletURL, jakarta.portlet.PortletURL, jakarta.portlet.ResourceURL, Serializable
- Author:
- Brian Wing Shun Chan, Jorge Ferrer, Connor McKay, Neil Griffin
- See Also:
-
Field Summary
Fields inherited from interface jakarta.portlet.ResourceURL
FULL, PAGE, PORTLET, SHARED -
Constructor Summary
ConstructorsConstructorDescriptionPortletURLImpl(jakarta.portlet.PortletRequest portletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, jakarta.portlet.MimeResponse.Copy copy) PortletURLImpl(jakarta.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, jakarta.portlet.MimeResponse.Copy copy) -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidaddProperty(String key, String value) append(Appendable appendable) append(Appendable appendable, boolean escapeXml) protected voidprotected Stringjakarta.portlet.MutableActionParametersjakarta.servlet.http.HttpServletRequestcom.liferay.portal.kernel.model.LayoutgetParameter(String name) Deprecated.As of Judson (7.1.x)Deprecated.As of Judson (7.1.x)longgetPlid()com.liferay.portal.kernel.model.Portletjakarta.portlet.PortletModejakarta.portlet.PortletRequestprotected Stringjakarta.portlet.MutableRenderParametersjakarta.portlet.MutableResourceParametersjakarta.portlet.WindowStatebooleanisAnchor()booleanbooleanbooleanbooleanbooleanisSecure()protected StringprocessValue(Key key, long value) protected StringprocessValue(Key key, String value) voidDeprecated.As of Judson (7.1.x)voidsetAnchor(boolean anchor) voidsetBeanParameter(jakarta.portlet.annotations.PortletSerializable portletSerializable) voidsetCacheability(String cacheability) voidsetCopyCurrentRenderParameters(boolean copyCurrentRenderParameters) voidsetDoAsGroupId(long doAsGroupId) voidsetDoAsUserId(long doAsUserId) voidsetDoAsUserLanguageId(String doAsUserLanguageId) voidsetEncrypt(boolean encrypt) voidsetEscapeXml(boolean escapeXml) voidsetLifecycle(String lifecycle) voidsetParameter(String name, String value) Deprecated.As of Judson (7.1.x)voidsetParameter(String name, String... values) Deprecated.As of Judson (7.1.x)voidsetParameter(String name, String[] values, boolean append) Deprecated.As of Judson (7.1.x)voidsetParameter(String name, String value, boolean append) Deprecated.As of Judson (7.1.x)voidsetParameters(Map<String, String[]> params) Deprecated.As of Judson (7.1.x)voidsetPlid(long plid) voidsetPortletId(String portletId) voidsetPortletMode(jakarta.portlet.PortletMode portletMode) voidsetPortletMode(String portletMode) voidsetProperty(String key, String value) voidsetRefererGroupId(long refererGroupId) voidsetRefererPlid(long refererPlid) voidsetRemovedParameterNames(Set<String> removedParameterNames) voidsetResourceID(String resourceID) voidsetSecure(boolean secure) voidsetWindowState(jakarta.portlet.WindowState windowState) voidsetWindowState(String windowState) voidsetWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView) toString()voidvisitReservedParameters(BiConsumer<String, String> biConsumer) voidvoid
-
Constructor Details
-
PortletURLImpl
public PortletURLImpl(jakarta.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, jakarta.portlet.MimeResponse.Copy copy) -
PortletURLImpl
public PortletURLImpl(jakarta.portlet.PortletRequest portletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, jakarta.portlet.MimeResponse.Copy copy)
-
-
Method Details
-
addParameterIncludedInPath
- Specified by:
addParameterIncludedInPathin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
addProperty
- Specified by:
addPropertyin interfacejakarta.portlet.BaseURL
-
append
- Specified by:
appendin interfacejakarta.portlet.BaseURL- Throws:
IOException
-
append
- Specified by:
appendin interfacejakarta.portlet.BaseURL- Throws:
IOException
-
getActionParameters
public jakarta.portlet.MutableActionParameters getActionParameters() -
getCacheability
- Specified by:
getCacheabilityin interfacejakarta.portlet.ResourceURL
-
getHttpServletRequest
public jakarta.servlet.http.HttpServletRequest getHttpServletRequest() -
getLayout
public com.liferay.portal.kernel.model.Layout getLayout() -
getLayoutFriendlyURL
-
getLifecycle
- Specified by:
getLifecyclein interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getNamespace
-
getParameter
Deprecated.As of Judson (7.1.x)- Specified by:
getParameterin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getParameterMap
Deprecated.As of Judson (7.1.x)- Specified by:
getParameterMapin interfacejakarta.portlet.BaseURL
-
getParametersIncludedInPath
- Specified by:
getParametersIncludedInPathin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getPlid
public long getPlid()- Specified by:
getPlidin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getPortlet
public com.liferay.portal.kernel.model.Portlet getPortlet() -
getPortletFriendlyURLPath
-
getPortletId
- Specified by:
getPortletIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getPortletMode
public jakarta.portlet.PortletMode getPortletMode()- Specified by:
getPortletModein interfacejakarta.portlet.RenderState
-
getPortletRequest
public jakarta.portlet.PortletRequest getPortletRequest() -
getRemovedParameterNames
- Specified by:
getRemovedParameterNamesin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
getRenderParameters
public jakarta.portlet.MutableRenderParameters getRenderParameters()- Specified by:
getRenderParametersin interfacejakarta.portlet.MutableRenderState- Specified by:
getRenderParametersin interfacejakarta.portlet.RenderState
-
getResourceID
- Specified by:
getResourceIDin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL- Specified by:
getResourceIDin interfacejakarta.portlet.ResourceURL
-
getResourceParameters
public jakarta.portlet.MutableResourceParameters getResourceParameters()- Specified by:
getResourceParametersin interfacejakarta.portlet.ResourceURL
-
getWindowState
public jakarta.portlet.WindowState getWindowState()- Specified by:
getWindowStatein interfacejakarta.portlet.RenderState
-
isAnchor
public boolean isAnchor()- Specified by:
isAnchorin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
isCopyCurrentRenderParameters
public boolean isCopyCurrentRenderParameters()- Specified by:
isCopyCurrentRenderParametersin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
isEncrypt
public boolean isEncrypt()- Specified by:
isEncryptin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
isEscapeXml
public boolean isEscapeXml()- Specified by:
isEscapeXmlin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
isParameterIncludedInPath
- Specified by:
isParameterIncludedInPathin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
isSecure
public boolean isSecure()- Specified by:
isSecurein interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
removePublicRenderParameter
Deprecated.As of Judson (7.1.x)- Specified by:
removePublicRenderParameterin interfacejakarta.portlet.PortletURL
-
setAnchor
public void setAnchor(boolean anchor) - Specified by:
setAnchorin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setBeanParameter
public void setBeanParameter(jakarta.portlet.annotations.PortletSerializable portletSerializable) - Specified by:
setBeanParameterin interfacejakarta.portlet.PortletURL
-
setCacheability
- Specified by:
setCacheabilityin interfacejakarta.portlet.ResourceURL
-
setCopyCurrentRenderParameters
public void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters) - Specified by:
setCopyCurrentRenderParametersin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setDoAsGroupId
public void setDoAsGroupId(long doAsGroupId) - Specified by:
setDoAsGroupIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setDoAsUserId
public void setDoAsUserId(long doAsUserId) - Specified by:
setDoAsUserIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setDoAsUserLanguageId
- Specified by:
setDoAsUserLanguageIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setEncrypt
public void setEncrypt(boolean encrypt) - Specified by:
setEncryptin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setEscapeXml
public void setEscapeXml(boolean escapeXml) - Specified by:
setEscapeXmlin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setLifecycle
- Specified by:
setLifecyclein interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setParameter
Deprecated.As of Judson (7.1.x)- Specified by:
setParameterin interfacejakarta.portlet.BaseURL
-
setParameter
Deprecated.As of Judson (7.1.x)- Specified by:
setParameterin interfacejakarta.portlet.BaseURL
-
setParameter
Deprecated.As of Judson (7.1.x)- Specified by:
setParameterin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setParameter
Deprecated.As of Judson (7.1.x)- Specified by:
setParameterin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setParameters
Deprecated.As of Judson (7.1.x)- Specified by:
setParametersin interfacejakarta.portlet.BaseURL
-
setPlid
public void setPlid(long plid) - Specified by:
setPlidin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setPortletId
- Specified by:
setPortletIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setPortletMode
public void setPortletMode(jakarta.portlet.PortletMode portletMode) throws jakarta.portlet.PortletModeException - Specified by:
setPortletModein interfacejakarta.portlet.MutableRenderState- Throws:
jakarta.portlet.PortletModeException
-
setPortletMode
- Throws:
jakarta.portlet.PortletModeException
-
setProperty
- Specified by:
setPropertyin interfacejakarta.portlet.BaseURL
-
setRefererGroupId
public void setRefererGroupId(long refererGroupId) - Specified by:
setRefererGroupIdin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setRefererPlid
public void setRefererPlid(long refererPlid) - Specified by:
setRefererPlidin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setRemovedParameterNames
- Specified by:
setRemovedParameterNamesin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
setResourceID
- Specified by:
setResourceIDin interfacejakarta.portlet.ResourceURL
-
setSecure
public void setSecure(boolean secure) throws jakarta.portlet.PortletSecurityException - Specified by:
setSecurein interfacejakarta.portlet.BaseURL- Throws:
jakarta.portlet.PortletSecurityException
-
setWindowState
- Throws:
jakarta.portlet.WindowStateException
-
setWindowState
public void setWindowState(jakarta.portlet.WindowState windowState) throws jakarta.portlet.WindowStateException - Specified by:
setWindowStatein interfacejakarta.portlet.MutableRenderState- Throws:
jakarta.portlet.WindowStateException
-
setWindowStateRestoreCurrentView
public void setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView) - Specified by:
setWindowStateRestoreCurrentViewin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
toString
-
visitReservedParameters
- Specified by:
visitReservedParametersin interfacecom.liferay.portal.kernel.portlet.LiferayPortletURL
-
write
- Specified by:
writein interfacejakarta.portlet.BaseURL- Throws:
IOException
-
write
- Specified by:
writein interfacejakarta.portlet.BaseURL- Throws:
IOException
-
clearCache
protected void clearCache() -
generateToString
-
getPublicRenderParameterName
-
processValue
-
processValue
-