Interface LiferayPortletURL
- All Superinterfaces:
BaseURL
,Mutable
,MutableRenderState
,PortletURL
,RenderState
,ResourceURL
,Serializable
- All Known Implementing Classes:
LiferayPortletURLWrapper
- Author:
- Brian Wing Shun Chan
-
Field Summary
Fields inherited from interface javax.portlet.ResourceURL
FULL, PAGE, PORTLET, SHARED
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a parameter that is included in the friendly URL path and does not need to appear in the query string.Returns the portlet lifecycle of this URL's target portlet.getParameter
(String name) Deprecated.Returns the parameters that are included in the friendly URL path and do not need to appear in the query string.long
getPlid()
Returns the ID of this URL's target portlet.Returns the ID of this URL's target resource.boolean
isAnchor()
Returnstrue
if this URL is an anchor pointing to the specified portlet on the page.boolean
Returnstrue
if the render parameters in the current request should be copied to this URL.boolean
Returnstrue
if this URL should be encrypted.boolean
Returnstrue
if this URL should be XML escaped.boolean
Returnstrue
if the parameter is included in the friendly URL path.boolean
isSecure()
Returnstrue
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
(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
(String lifecycle) Sets the portlet lifecycle of this URL's target portlet.void
setParameter
(String name, String[] values, boolean append) Deprecated.As of Judson (7.1.x), replaced byMutablePortletParameters.setValues(String, String...)
Sets the URL parameter the valuesvoid
setParameter
(String name, String value, boolean append) Deprecated.As of Judson (7.1.x), replaced byMutablePortletParameters.setValue(String, String)
Sets the URL parameter to the valuevoid
setPlid
(long plid) Sets the portlet layout ID.void
setPortletId
(String portletId) Sets the ID of the target portlet.void
setRefererGroupId
(long refererGroupId) void
setRefererPlid
(long refererPlid) Sets the referer layout ID.void
setRemovedParameterNames
(Set<String> removedParamNames) void
setWindowStateRestoreCurrentView
(boolean windowStateRestoreCurrentView) Sets whether this portlet restores to the current view when toggling between maximized and normal states.void
visitReservedParameters
(BiConsumer<String, String> biConsumer) 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.MutableRenderState
getRenderParameters, setPortletMode, setWindowState
Methods inherited from interface javax.portlet.PortletURL
removePublicRenderParameter, setBeanParameter
Methods inherited from interface javax.portlet.RenderState
getPortletMode, getWindowState
Methods inherited from interface javax.portlet.ResourceURL
getCacheability, getResourceParameters, setCacheability, setResourceID
-
Method Details
-
addParameterIncludedInPath
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
String getLifecycle()Returns the portlet lifecycle of this URL's target portlet.- Returns:
- the portlet lifecycle of this URL's target portlet
- See Also:
-
getParameter
Deprecated.As of Judson (7.1.x), replaced byPortletParameters.getValue(String)
- Parameters:
name
- the name of the URL parameter- Returns:
- the first value of the URL parameter
-
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
String getPortletId()Returns the ID of this URL's target portlet.- Returns:
- the ID of this URL's target portlet
-
getRemovedParameterNames
-
getResourceID
String getResourceID()Returns the ID of this URL's target resource.- Specified by:
getResourceID
in interfaceResourceURL
- Returns:
- the ID of this URL's target resource
-
isAnchor
boolean isAnchor()Returnstrue
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:
-
isCopyCurrentRenderParameters
boolean isCopyCurrentRenderParameters()Returnstrue
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:
-
isEncrypt
boolean isEncrypt()Returnstrue
if this URL should be encrypted.- Returns:
true
if this URL should be encrypted;false
otherwise- See Also:
-
isEscapeXml
boolean isEscapeXml()Returnstrue
if this URL should be XML escaped.- Returns:
true
if this URL should be XML escaped;false
otherwise- See Also:
-
isParameterIncludedInPath
Returnstrue
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:
-
isSecure
boolean isSecure()Returnstrue
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
Sets the language ID of the user to impersonate. This will only have an effect when a user is being impersonated viasetDoAsUserId(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
Sets the portlet lifecycle of this URL's target portlet.Valid lifecycles are:
- Parameters:
lifecycle
- the portlet lifecycle
-
setParameter
Deprecated.As of Judson (7.1.x), replaced byMutablePortletParameters.setValue(String, String)
Sets the URL parameter to the value- Parameters:
name
- the name of the URL parametervalue
- the value of the URL parameterappend
- whether the new value should be appended to any existing values for the parameter. Ifappend
isfalse
any existing values will be overwritten with the new value.
-
setParameter
Deprecated.As of Judson (7.1.x), replaced byMutablePortletParameters.setValues(String, String...)
Sets the URL parameter the values- Parameters:
name
- the name of the URL parametervalues
- the values of the URL parameterappend
- whether the new values should be appended to any existing values for the parameter. Ifappend
isfalse
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
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
-
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
-
PortletParameters.getValue(String)