com.liferay.portal.kernel.portlet

Interface LiferayPortletURL

All Superinterfaces:

javax.portlet.BaseURL, javax.portlet.Mutable, javax.portlet.MutableRenderState, javax.portlet.PortletURL, javax.portlet.RenderState, javax.portlet.ResourceURL, java.io.Serializable

All Known Implementing Classes:

LiferayPortletURLWrapper

@ProviderType
public interface LiferayPortletURL
extends javax.portlet.PortletURL, javax.portlet.ResourceURL, java.io.Serializable

Represents a URL pointing to a portlet.

Author:

Brian Wing Shun Chan

Field Summary

Fields inherited from interface javax.portlet.ResourceURL

FULL, PAGE, PORTLET, SHARED

Method Summary

Modifier and Type	Method and Description
void	addParameterIncludedInPath(java.lang.String name) Adds a parameter that is included in the friendly URL path and does not need to appear in the query string.
java.lang.String	getLifecycle() Returns the portlet lifecycle of this URL's target portlet.
java.lang.String	getParameter(java.lang.String name) Returns the first value of the URL parameter.
java.util.Set<java.lang.String>	getParametersIncludedInPath() Returns the parameters that are included in the friendly URL path and do not need to appear in the query string.
long	getPlid()
java.lang.String	getPortletId() Returns the ID of this URL's target portlet.
java.util.Set<java.lang.String>	getRemovedParameterNames()
java.lang.String	getResourceID() Returns the ID of this URL's target resource.
boolean	isAnchor() Returns true if this URL is an anchor pointing to the specified portlet on the page.
boolean	isCopyCurrentRenderParameters() Returns true if the render parameters in the current request should be copied to this URL.
boolean	isEncrypt() Returns true if this URL should be encrypted.
boolean	isEscapeXml() Returns true if this URL should be XML escaped.
boolean	isParameterIncludedInPath(java.lang.String name) Returns true if the parameter is included in the friendly URL path.
boolean	isSecure() Returns true if this URL is secure (https).
void	setAnchor(boolean anchor) Sets whether this URL is an anchor pointing to the specified portlet on the page.
void	setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters) Sets whether the render parameters in the current request should be copied to this URL.
void	setDoAsGroupId(long doAsGroupId)
void	setDoAsUserId(long doAsUserId) Sets the ID of the user to impersonate.
void	setDoAsUserLanguageId(java.lang.String doAsUserLanguageId) Sets the language ID of the user to impersonate.
void	setEncrypt(boolean encrypt) Sets whether this URL should be encrypted.
void	setEscapeXml(boolean escapeXml) Sets whether this URL should be XML escaped.
void	setLifecycle(java.lang.String lifecycle) Sets the portlet lifecycle of this URL's target portlet.
void	setParameter(java.lang.String name, java.lang.String[] values, boolean append) Sets the URL parameter the values.
void	setParameter(java.lang.String name, java.lang.String value, boolean append) Sets the URL parameter to the value.
void	setPlid(long plid) Sets the portlet layout ID.
void	setPortletId(java.lang.String portletId) Sets the ID of the target portlet.
void	setRefererGroupId(long refererGroupId)
void	setRefererPlid(long refererPlid) Sets the referer layout ID.
void	setRemovedParameterNames(java.util.Set<java.lang.String> removedParamNames)
void	setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView) Sets whether this portlet restores to the current view when toggling between maximized and normal states.
void	visitReservedParameters(java.util.function.BiConsumer<java.lang.String,java.lang.String> biConsumer)

Methods inherited from interface javax.portlet.PortletURL

removePublicRenderParameter, setBeanParameter

Methods inherited from interface javax.portlet.MutableRenderState

getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface javax.portlet.ResourceURL

getCacheability, getResourceParameters, setCacheability, setResourceID

Methods inherited from interface javax.portlet.BaseURL

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write

Methods inherited from interface javax.portlet.RenderState

getPortletMode, getWindowState

Method Detail

addParameterIncludedInPath

void addParameterIncludedInPath(java.lang.String name)

Adds a parameter that is included in the friendly URL path and does not need to appear in the query string.

Parameters:

name - the name of the parameter

getLifecycle

java.lang.String getLifecycle()

Returns the portlet lifecycle of this URL's target portlet.

Returns:

the portlet lifecycle of this URL's target portlet

See Also:

setLifecycle(String)

getParameter

java.lang.String getParameter(java.lang.String name)

Returns the first value of the URL parameter.

Parameters:

name - the name of the URL parameter

Returns:

the first value of the URL parameter

getParametersIncludedInPath

java.util.Set<java.lang.String> getParametersIncludedInPath()

Returns the parameters that are included in the friendly URL path and do not need to appear in the query string.

Returns:

the names of the parameters that are included in the friendly URL path and do not need to appear in the query string

getPlid

long getPlid()

getPortletId

java.lang.String getPortletId()

Returns the ID of this URL's target portlet.

Returns:

the ID of this URL's target portlet

getRemovedParameterNames

java.util.Set<java.lang.String> getRemovedParameterNames()

getResourceID

java.lang.String getResourceID()

Returns the ID of this URL's target resource.

Specified by:

getResourceID in interface javax.portlet.ResourceURL

Returns:

the ID of this URL's target resource

isAnchor

boolean isAnchor()

Returns true if this URL is an anchor pointing to the specified portlet on the page.

Returns:

whether this URL is an anchor pointing to the specified portlet on the page

See Also:

setAnchor(boolean)

isCopyCurrentRenderParameters

boolean isCopyCurrentRenderParameters()

Returns true if the render parameters in the current request should be copied to this URL.

Returns:

whether the render parameters in the current request should be copied to this URL

See Also:

setCopyCurrentRenderParameters(boolean)

isEncrypt

boolean isEncrypt()

Returns true if this URL should be encrypted.

Returns:

true if this URL should be encrypted; false otherwise

See Also:

setEncrypt(boolean)

isEscapeXml

boolean isEscapeXml()

Returns true if this URL should be XML escaped.

Returns:

true if this URL should be XML escaped; false otherwise

See Also:

setEscapeXml(boolean)

isParameterIncludedInPath

boolean isParameterIncludedInPath(java.lang.String name)

Returns true if the parameter is included in the friendly URL path.

Parameters:

name - the name of the parameter to check for inclusion in the path

Returns:

whether the parameter is included in the friendly URL path

See Also:

addParameterIncludedInPath(String)

isSecure

boolean isSecure()

Returns true if this URL is secure (https).

Returns:

true if this URL is secure; false otherwise

setAnchor

void setAnchor(boolean anchor)

Sets whether this URL is an anchor pointing to the specified portlet on the page.

An anchor URL will cause the user's browser to automatically jump down to the specified portlet after the page loads, avoiding the need to scroll.

Parameters:

anchor - whether this URL is an anchor pointing to the specified portlet on the page

setCopyCurrentRenderParameters

void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)

Sets whether the render parameters in the current request should be copied to this URL.

New parameters set on this URL will appear before the copied render parameters.

Parameters:

copyCurrentRenderParameters - whether the render parameters in the current request should be copied to this URL

setDoAsGroupId

void setDoAsGroupId(long doAsGroupId)

setDoAsUserId

void setDoAsUserId(long doAsUserId)

Sets the ID of the user to impersonate.

When a page is accessed while impersonating a user, it will appear exactly as it would to that user.

Parameters:

doAsUserId - the ID of the user to impersonate in the portlet this URL points to

setDoAsUserLanguageId

void setDoAsUserLanguageId(java.lang.String doAsUserLanguageId)

Sets the language ID of the user to impersonate. This will only have an effect when a user is being impersonated via setDoAsUserId(long).

The language set here will override the impersonated user's default language.

Parameters:

doAsUserLanguageId - the language ID of the user to impersonate

setEncrypt

void setEncrypt(boolean encrypt)

Sets whether this URL should be encrypted.

In an encrypted URL, the value of every parameter will be encrypted using the company's key. This allows sensitive information to be placed in the URL without being vulnerable to snooping.

Note that this is not the same as making a URL secure.

setEscapeXml

void setEscapeXml(boolean escapeXml)

Sets whether this URL should be XML escaped.

If a URL is XML escaped, it will automatically have special characters escaped when it is converted to a string or written to a Writer.

Parameters:

escapeXml - whether this URL should be XML escaped

setLifecycle

void setLifecycle(java.lang.String lifecycle)

Sets the portlet lifecycle of this URL's target portlet.

Valid lifecycles are:

• PortletRequest.ACTION_PHASE
• PortletRequest.RENDER_PHASE
• PortletRequest.RESOURCE_PHASE

Parameters:

lifecycle - the portlet lifecycle

setParameter

void setParameter(java.lang.String name,
                  java.lang.String value,
                  boolean append)

Sets the URL parameter to the value.

Parameters:

name - the name of the URL parameter

value - the value of the URL parameter

append - whether the new value should be appended to any existing values for the parameter. If append is false any existing values will be overwritten with the new value.

setParameter

void setParameter(java.lang.String name,
                  java.lang.String[] values,
                  boolean append)

Sets the URL parameter the values.

Parameters:

name - the name of the URL parameter

values - the values of the URL parameter

append - whether the new values should be appended to any existing values for the parameter. If append is false any existing values will be overwritten with the new values.

setPlid

void setPlid(long plid)

Sets the portlet layout ID.

Parameters:

plid - the portlet layout ID

setPortletId

void setPortletId(java.lang.String portletId)

Sets the ID of the target portlet.

setRefererGroupId

void setRefererGroupId(long refererGroupId)

setRefererPlid

void setRefererPlid(long refererPlid)

Sets the referer layout ID.

Parameters:

refererPlid - the referer layout ID

setRemovedParameterNames

void setRemovedParameterNames(java.util.Set<java.lang.String> removedParamNames)

setWindowStateRestoreCurrentView

void setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView)

Sets whether this portlet restores to the current view when toggling between maximized and normal states.

Parameters:

windowStateRestoreCurrentView - whether this portlet restores to the current view when toggling between maximized and normal states

visitReservedParameters

void visitReservedParameters(java.util.function.BiConsumer<java.lang.String,java.lang.String> biConsumer)