com.liferay.portlet

Class PortletURLImpl

Object

com.liferay.portlet.PortletURLImpl

All Implemented Interfaces:

com.liferay.portal.kernel.portlet.LiferayPortletURL, Serializable, BaseURL, PortletURL, ResourceURL

Direct Known Subclasses:

PortletURLImplWrapper

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

Author:

Brian Wing Shun Chan, Jorge Ferrer, Connor McKay

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.portlet.ResourceURL

FULL, PAGE, PORTLET, SHARED

Constructor Summary

Constructors

Modifier	Constructor and Description
	PortletURLImpl(javax.servlet.http.HttpServletRequest request, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle)
	PortletURLImpl(javax.servlet.http.HttpServletRequest request, String portletId, com.liferay.portal.kernel.model.Layout layout, String lifecycle) Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, Portlet, Layout, String)
	PortletURLImpl(javax.servlet.http.HttpServletRequest request, String portletId, long plid, String lifecycle) Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, String, Layout, String)
protected	PortletURLImpl(javax.servlet.http.HttpServletRequest request, String portletId, PortletRequest portletRequest, long plid, String lifecycle) Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, String, PortletRequest, Layout, String)
	PortletURLImpl(PortletRequest portletRequest, com.liferay.portal.kernel.model.Portlet portlet, com.liferay.portal.kernel.model.Layout layout, String lifecycle)
	PortletURLImpl(PortletRequest portletRequest, String portletId, com.liferay.portal.kernel.model.Layout layout, String lifecycle) Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(PortletRequest, Portlet, Layout, String)
	PortletURLImpl(PortletRequest portletRequest, String portletId, long plid, String lifecycle) Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(PortletRequest, String, Layout, String)

Method Summary

Modifier and Type	Method and Description
void	addParameterIncludedInPath(String name)
protected void	addPortalAuthToken(com.liferay.portal.kernel.util.StringBundler sb, Key key)
protected void	addPortletAuthToken(com.liferay.portal.kernel.util.StringBundler sb, Key key)
void	addProperty(String key, String value)
protected void	clearCache()
protected String	generateToString()
protected String	generateWSRPToString()
String	getCacheability()
javax.servlet.http.HttpServletRequest	getHttpServletRequest()
com.liferay.portal.kernel.model.Layout	getLayout()
String	getLayoutFriendlyURL()
String	getLifecycle()
String	getNamespace()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Set<String>	getParametersIncludedInPath()
long	getPlid()
com.liferay.portal.kernel.model.Portlet	getPortlet()
String	getPortletFriendlyURLPath()
String	getPortletId()
PortletMode	getPortletMode()
PortletRequest	getPortletRequest()
protected String	getPublicRenderParameterName(String name)
Set<String>	getRemovedParameterNames()
Map<String,String>	getReservedParameterMap() Deprecated. As of Judson (7.1.x), replaced by visitReservedParameters(BiConsumer)
String	getResourceID()
WindowState	getWindowState()
boolean	isAnchor()
protected boolean	isBlankValue(String[] value)
boolean	isCopyCurrentRenderParameters()
boolean	isEncrypt()
boolean	isEscapeXml()
boolean	isParameterIncludedInPath(String name)
boolean	isSecure()
protected void	mergeRenderParameters() Deprecated. As of Judson (7.1.x), with no direct replacement
protected String	prependNamespace(String name) Deprecated. As of Judson (7.1.x), with no direct replacement
protected String	processValue(Key key, int value)
protected String	processValue(Key key, long value)
protected String	processValue(Key key, String value)
protected void	removeParameter(String name)
void	removePublicRenderParameter(String name)
void	setAnchor(boolean anchor)
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 value)
void	setParameter(String name, String[] values)
void	setParameter(String name, String[] values, boolean append)
void	setParameter(String name, String value, boolean append)
void	setParameters(Map<String,String[]> params)
void	setPlid(long plid)
void	setPortletId(String portletId)
void	setPortletMode(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(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 request,
                      com.liferay.portal.kernel.model.Portlet portlet,
                      com.liferay.portal.kernel.model.Layout layout,
                      String lifecycle)

PortletURLImpl

@Deprecated
public PortletURLImpl(javax.servlet.http.HttpServletRequest request,
                                  String portletId,
                                  com.liferay.portal.kernel.model.Layout layout,
                                  String lifecycle)

Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, Portlet, Layout, String)

PortletURLImpl

@Deprecated
public PortletURLImpl(javax.servlet.http.HttpServletRequest request,
                                  String portletId,
                                  long plid,
                                  String lifecycle)

Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, String, Layout, String)

PortletURLImpl

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

PortletURLImpl

@Deprecated
public PortletURLImpl(PortletRequest portletRequest,
                                  String portletId,
                                  com.liferay.portal.kernel.model.Layout layout,
                                  String lifecycle)

Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(PortletRequest, Portlet, Layout, String)

PortletURLImpl

@Deprecated
public PortletURLImpl(PortletRequest portletRequest,
                                  String portletId,
                                  long plid,
                                  String lifecycle)

Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(PortletRequest, String, Layout, String)

PortletURLImpl

@Deprecated
protected PortletURLImpl(javax.servlet.http.HttpServletRequest request,
                                     String portletId,
                                     PortletRequest portletRequest,
                                     long plid,
                                     String lifecycle)

Deprecated. As of Judson (7.1.x), replaced by PortletURLImpl(HttpServletRequest, String, PortletRequest, Layout, String)

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 BaseURL

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

public String getParameter(String name)

Specified by:

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

getParameterMap

public Map<String,String[]> getParameterMap()

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 PortletURL

getPortletRequest

public PortletRequest getPortletRequest()

getRemovedParameterNames

public Set<String> getRemovedParameterNames()

Specified by:

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

getReservedParameterMap

@Deprecated
public Map<String,String> getReservedParameterMap()

Deprecated. As of Judson (7.1.x), replaced by visitReservedParameters(BiConsumer)

Specified by:

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

getResourceID

public String getResourceID()

Specified by:

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

getWindowState

public WindowState getWindowState()

Specified by:

getWindowState in interface PortletURL

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

public void removePublicRenderParameter(String name)

Specified by:

removePublicRenderParameter in interface PortletURL

setAnchor

public void setAnchor(boolean anchor)

Specified by:

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

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

public void setParameter(String name,
                         String value)

Specified by:

setParameter in interface BaseURL

setParameter

public void setParameter(String name,
                         String value,
                         boolean append)

Specified by:

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

setParameter

public void setParameter(String name,
                         String[] values)

Specified by:

setParameter in interface BaseURL

setParameter

public void setParameter(String name,
                         String[] values,
                         boolean append)

Specified by:

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

setParameters

public void setParameters(Map<String,String[]> params)

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 PortletURL

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 PortletURL

Throws:

WindowStateException

setWindowStateRestoreCurrentView

public void setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView)

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

addPortalAuthToken

protected void addPortalAuthToken(com.liferay.portal.kernel.util.StringBundler sb,
                                  Key key)

addPortletAuthToken

protected void addPortletAuthToken(com.liferay.portal.kernel.util.StringBundler sb,
                                   Key key)

clearCache

protected void clearCache()

generateToString

protected String generateToString()

generateWSRPToString

protected String generateWSRPToString()

getPublicRenderParameterName

protected String getPublicRenderParameterName(String name)

isBlankValue

protected boolean isBlankValue(String[] value)

mergeRenderParameters

@Deprecated
protected void mergeRenderParameters()

Deprecated. As of Judson (7.1.x), with no direct replacement

prependNamespace

@Deprecated
protected String prependNamespace(String name)

Deprecated. As of Judson (7.1.x), with no direct replacement

processValue

protected String processValue(Key key,
                              int value)

processValue

protected String processValue(Key key,
                              long value)

processValue

protected String processValue(Key key,
                              String value)

removeParameter

protected void removeParameter(String name)