com.liferay.portlet.internal

Class PortletURLImpl

Object

com.liferay.portlet.internal.PortletURLImpl

All Implemented Interfaces:

com.liferay.portal.kernel.portlet.LiferayPortletURL, Serializable, javax.portlet.BaseURL, javax.portlet.Mutable, javax.portlet.MutableRenderState, javax.portlet.PortletURL, javax.portlet.RenderState, javax.portlet.ResourceURL

Direct Known Subclasses:

ActionURLImpl, RenderURLImpl

public class PortletURLImpl
extends Object
implements com.liferay.portal.kernel.portlet.LiferayPortletURL, javax.portlet.PortletURL, javax.portlet.ResourceURL, Serializable

Author:

Brian Wing Shun Chan, Jorge Ferrer, Connor McKay, Neil Griffin

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.portlet.ResourceURL

FULL, PAGE, PORTLET, SHARED

Constructor Summary

Constructors

Constructor and Description
PortletURLImpl(javax.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, javax.portlet.MimeResponse.Copy copy)
PortletURLImpl(javax.portlet.PortletRequest portletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle, javax.portlet.MimeResponse.Copy copy)

Method Summary

Modifier and Type	Method and Description
void	addParameterIncludedInPath(String name)
void	addProperty(String key, String value)
Appendable	append(Appendable appendable)
Appendable	append(Appendable appendable, boolean escapeXml)
protected void	clearCache()
protected String	generateToString()
javax.portlet.MutableActionParameters	getActionParameters()
String	getCacheability()
javax.servlet.http.HttpServletRequest	getHttpServletRequest()
com.liferay.portal.kernel.model.Layout	getLayout()
String	getLayoutFriendlyURL()
String	getLifecycle()
String	getNamespace()
String	getParameter(String name) Deprecated. As of Judson (7.1.x)
Map<String,String[]>	getParameterMap() Deprecated. As of Judson (7.1.x)
Set<String>	getParametersIncludedInPath()
long	getPlid()
com.liferay.portal.kernel.model.Portlet	getPortlet()
String	getPortletFriendlyURLPath()
String	getPortletId()
javax.portlet.PortletMode	getPortletMode()
javax.portlet.PortletRequest	getPortletRequest()
protected String	getPublicRenderParameterName(String name)
Set<String>	getRemovedParameterNames()
javax.portlet.MutableRenderParameters	getRenderParameters()
String	getResourceID()
javax.portlet.MutableResourceParameters	getResourceParameters()
javax.portlet.WindowState	getWindowState()
boolean	isAnchor()
boolean	isCopyCurrentRenderParameters()
boolean	isEncrypt()
boolean	isEscapeXml()
boolean	isParameterIncludedInPath(String name)
boolean	isSecure()
protected String	processValue(Key key, long value)
protected String	processValue(Key key, String value)
void	removePublicRenderParameter(String name) Deprecated. As of Judson (7.1.x)
void	setAnchor(boolean anchor)
void	setBeanParameter(javax.portlet.annotations.PortletSerializable portletSerializable)
void	setCacheability(String cacheability)
void	setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
void	setDoAsGroupId(long doAsGroupId)
void	setDoAsUserId(long doAsUserId)
void	setDoAsUserLanguageId(String doAsUserLanguageId)
void	setEncrypt(boolean encrypt)
void	setEscapeXml(boolean escapeXml)
void	setLifecycle(String lifecycle)
void	setParameter(String name, String... values) Deprecated. As of Judson (7.1.x)
void	setParameter(String name, String value) Deprecated. As of Judson (7.1.x)
void	setParameter(String name, String[] values, boolean append) Deprecated. As of Judson (7.1.x)
void	setParameter(String name, String value, boolean append) Deprecated. As of Judson (7.1.x)
void	setParameters(Map<String,String[]> params) Deprecated. As of Judson (7.1.x)
void	setPlid(long plid)
void	setPortletId(String portletId)
void	setPortletMode(javax.portlet.PortletMode portletMode)
void	setPortletMode(String portletMode)
void	setProperty(String key, String value)
void	setRefererGroupId(long refererGroupId)
void	setRefererPlid(long refererPlid)
void	setRemovedParameterNames(Set<String> removedParameterNames)
void	setResourceID(String resourceID)
void	setSecure(boolean secure)
void	setWindowState(String windowState)
void	setWindowState(javax.portlet.WindowState windowState)
void	setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView)
String	toString()
void	visitReservedParameters(BiConsumer<String,String> biConsumer)
void	write(Writer writer)
void	write(Writer writer, boolean escapeXml)

Methods inherited from class Object

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

Constructor Detail

PortletURLImpl

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

PortletURLImpl

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

Method Detail

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 javax.portlet.BaseURL

append

public Appendable append(Appendable appendable)
                  throws IOException

Specified by:

append in interface javax.portlet.BaseURL

Throws:

IOException

append

public Appendable append(Appendable appendable,
                         boolean escapeXml)
                  throws IOException

Specified by:

append in interface javax.portlet.BaseURL

Throws:

IOException

getActionParameters

public javax.portlet.MutableActionParameters getActionParameters()

getCacheability

public String getCacheability()

Specified by:

getCacheability in interface javax.portlet.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 javax.portlet.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 javax.portlet.PortletMode getPortletMode()

Specified by:

getPortletMode in interface javax.portlet.RenderState

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

getRemovedParameterNames

public Set<String> getRemovedParameterNames()

Specified by:

getRemovedParameterNames in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getRenderParameters

public javax.portlet.MutableRenderParameters getRenderParameters()

Specified by:

getRenderParameters in interface javax.portlet.MutableRenderState

Specified by:

getRenderParameters in interface javax.portlet.RenderState

getResourceID

public String getResourceID()

Specified by:

getResourceID in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

Specified by:

getResourceID in interface javax.portlet.ResourceURL

getResourceParameters

public javax.portlet.MutableResourceParameters getResourceParameters()

Specified by:

getResourceParameters in interface javax.portlet.ResourceURL

getWindowState

public javax.portlet.WindowState getWindowState()

Specified by:

getWindowState in interface javax.portlet.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 javax.portlet.PortletURL

setAnchor

public void setAnchor(boolean anchor)

Specified by:

setAnchor in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setBeanParameter

public void setBeanParameter(javax.portlet.annotations.PortletSerializable portletSerializable)

Specified by:

setBeanParameter in interface javax.portlet.PortletURL

setCacheability

public void setCacheability(String cacheability)

Specified by:

setCacheability in interface javax.portlet.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 javax.portlet.BaseURL

setParameter

@Deprecated
public void setParameter(String name,
                                     String... values)

Deprecated. As of Judson (7.1.x)

Specified by:

setParameter in interface javax.portlet.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 javax.portlet.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(javax.portlet.PortletMode portletMode)
                    throws javax.portlet.PortletModeException

Specified by:

setPortletMode in interface javax.portlet.MutableRenderState

Throws:

javax.portlet.PortletModeException

setPortletMode

public void setPortletMode(String portletMode)
                    throws javax.portlet.PortletModeException

Throws:

javax.portlet.PortletModeException

setProperty

public void setProperty(String key,
                        String value)

Specified by:

setProperty in interface javax.portlet.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 javax.portlet.ResourceURL

setSecure

public void setSecure(boolean secure)
               throws javax.portlet.PortletSecurityException

Specified by:

setSecure in interface javax.portlet.BaseURL

Throws:

javax.portlet.PortletSecurityException

setWindowState

public void setWindowState(String windowState)
                    throws javax.portlet.WindowStateException

Throws:

javax.portlet.WindowStateException

setWindowState

public void setWindowState(javax.portlet.WindowState windowState)
                    throws javax.portlet.WindowStateException

Specified by:

setWindowState in interface javax.portlet.MutableRenderState

Throws:

javax.portlet.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 javax.portlet.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 javax.portlet.BaseURL

Throws:

IOException

write

public void write(Writer writer,
                  boolean escapeXml)
           throws IOException

Specified by:

write in interface javax.portlet.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)