com.liferay.portal.kernel.portlet
Interface LiferayPortletURL

All Superinterfaces:

BaseURL, PortletURL, ResourceURL, Serializable

All Known Implementing Classes:

LiferayStrutsPortletURLImpl, PortletURLImpl, PortletURLImplWrapper, StrutsActionPortletURL

public interface LiferayPortletURL
extends PortletURL, ResourceURL, Serializable

Represents a URL pointing to a portlet.

See Also:

PortletURLImpl

Field Summary

Fields inherited from interface javax.portlet.ResourceURL

FULL, PAGE, PORTLET, SHARED

Method Summary

void	addParameterIncludedInPath(String name) Adds a parameter that is included in the friendly URL path and does not need to appear in the query string.
String	getLifecycle() Gets the lifecycle of the portlet this URL points to.
String	getParameter(String name) Gets the first value of the URL parameter.
Set<String>	getParametersIncludedInPath()
String	getPortletId() Gets the id of the portlet this URL points to.
Map<String,String>	getReservedParameterMap() Gets the map of reserved parameters for this URL.
String	getResourceID() Gets the id of the resource this URL points to.
boolean	isAnchor() Determines whether this URL is an anchor pointing to the specified portlet on the page.
boolean	isCopyCurrentRenderParameters() Determines whether the render parameters in the current request should be copied to this URL.
boolean	isEncrypt() Determines whether this URL should be encrypted.
boolean	isEscapeXml() Determines whether this URL should be XML escaped.
boolean	isParameterIncludedInPath(String name) Determines whether the parameter is included in the friendly URL path.
boolean	isSecure() Determines whether 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	setDoAsUserId(long doAsUserId) Sets the id of the user to impersonate.
void	setDoAsUserLanguageId(String doAsUserLanguageId)
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(String lifecycle) Sets the lifecycle of the portlet this URL points to.
void	setParameter(String name, String[] values, boolean append) Sets the URL parameter the values.
void	setParameter(String name, String value, boolean append) Sets the URL parameter to the value.
void	setPlid(long plid) Sets the portlet layout id.
void	setPortletId(String portletId) Sets the id of the target portlet.

Methods inherited from interface javax.portlet.PortletURL

getPortletMode, getWindowState, removePublicRenderParameter, setPortletMode, setWindowState

Methods inherited from interface javax.portlet.ResourceURL

getCacheability, setCacheability, setResourceID

Methods inherited from interface javax.portlet.BaseURL

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

Method Detail

addParameterIncludedInPath

void addParameterIncludedInPath(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 that is included in the path

getLifecycle

String getLifecycle()

Gets the lifecycle of the portlet this URL points to.

Returns:

the portlet lifecycle

See Also:

setLifecycle(String)

getParameter

String getParameter(String name)

Gets the first value of the URL parameter.

Parameters:

name - the name of the URL parameter to get the value of

Returns:

the first value of the URL parameter

getPortletId

String getPortletId()

Gets the id of the portlet this URL points to.

Returns:

the id of the portlet this URL points to

getReservedParameterMap

Map<String,String> getReservedParameterMap()

Gets the map of reserved parameters for this URL.

This method is only used internally. Reserved parameters contain special, Liferay specific information, such as p_p_id and p_p_lifecycle.

Returns:

the reserved parameter names and values in a read-only map

getResourceID

String getResourceID()

Gets the id of the resource this URL points to.

Returns:

the id of the resource this URL points to

isAnchor

boolean isAnchor()

Determines whether 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()

Determines whether 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()

Determines whether this URL should be encrypted.

Returns:

true if this URL should be encrypted; false otherwise

See Also:

setEncrypt(boolean)

isEscapeXml

boolean isEscapeXml()

Determines whether this URL should be XML escaped.

Returns:

true if this URL should be XML escaped; false otherwise

See Also:

setEscapeXml(boolean)

isParameterIncludedInPath

boolean isParameterIncludedInPath(String name)

Determines whether 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()

Determines whether this URL is secure (https).

Returns:

true if this URL is secure; false otherwise

setLifecycle

void setLifecycle(String lifecycle)

Sets the lifecycle of the portlet this URL points to.

Valid lifecycles are:

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

Parameters:

lifecycle - the lifecycle of the portlet this URL points to

setParameter

void setParameter(String name,
                  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(String name,
                  String[] values,
                  boolean append)

Sets the URL parameter the values.

Parameters:

name - the name 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.

getParametersIncludedInPath

Set<String> getParametersIncludedInPath()

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

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(String doAsUserLanguageId)

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

setPlid

void setPlid(long plid)

Sets the portlet layout id.

Parameters:

plid - the portlet layout id

setPortletId

void setPortletId(String portletId)

Sets the id of the target portlet.