|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.PortletURLImpl
public class PortletURLImpl
| Field Summary |
|---|
| Fields inherited from interface javax.portlet.ResourceURL |
|---|
FULL, PAGE, PORTLET, SHARED |
| Constructor Summary | |
|---|---|
|
PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
Layout layout,
String lifecycle)
|
|
PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
long plid,
String lifecycle)
|
protected |
PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
PortletRequest portletRequest,
long plid,
String lifecycle)
|
|
PortletURLImpl(PortletRequest portletRequest,
String portletId,
Layout layout,
String lifecycle)
|
|
PortletURLImpl(PortletRequest portletRequest,
String portletId,
long plid,
String lifecycle)
|
| 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. |
protected void |
addPortalAuthToken(StringBundler sb,
Key key)
|
protected void |
addPortletAuthToken(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()
|
Layout |
getLayout()
|
String |
getLayoutFriendlyURL()
|
String |
getLifecycle()
Returns the portlet lifecycle of this URL's target portlet. |
String |
getNamespace()
|
String |
getParameter(String name)
Returns the first value of the URL parameter. |
Map<String,String[]> |
getParameterMap()
|
Set<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()
|
Portlet |
getPortlet()
|
String |
getPortletFriendlyURLPath()
|
String |
getPortletId()
Returns the ID of this URL's target portlet. |
PortletMode |
getPortletMode()
|
PortletRequest |
getPortletRequest()
|
protected String |
getPublicRenderParameterName(String name)
|
Set<String> |
getRemovedParameterNames()
|
Map<String,String> |
getReservedParameterMap()
Returns the map of reserved parameters for this URL. |
String |
getResourceID()
Returns the ID of this URL's target resource. |
WindowState |
getWindowState()
|
boolean |
isAnchor()
Returns true if this URL is an anchor pointing to the
specified portlet on the page. |
protected boolean |
isBlankValue(String[] value)
|
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(String name)
Returns true if the parameter is included in the friendly
URL path. |
boolean |
isSecure()
Returns true if this URL is secure (https). |
protected void |
mergeRenderParameters()
|
protected String |
prependNamespace(String name)
|
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)
Sets whether this URL is an anchor pointing to the specified portlet on the page. |
void |
setCacheability(String cacheability)
|
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 value)
|
void |
setParameter(String name,
String[] values)
|
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 |
setParameters(Map<String,String[]> params)
|
void |
setPlid(long plid)
Sets the portlet layout ID. |
void |
setPortletId(String portletId)
Sets the ID of the target portlet. |
void |
setPortletMode(PortletMode portletMode)
|
void |
setPortletMode(String portletMode)
|
void |
setProperty(String key,
String value)
|
void |
setRefererGroupId(long refererGroupId)
|
void |
setRefererPlid(long refererPlid)
Sets the referer layout ID. |
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 |
write(Writer writer)
|
void |
write(Writer writer,
boolean escapeXml)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
Layout layout,
String lifecycle)
public PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
long plid,
String lifecycle)
public PortletURLImpl(PortletRequest portletRequest,
String portletId,
Layout layout,
String lifecycle)
public PortletURLImpl(PortletRequest portletRequest,
String portletId,
long plid,
String lifecycle)
protected PortletURLImpl(javax.servlet.http.HttpServletRequest request,
String portletId,
PortletRequest portletRequest,
long plid,
String lifecycle)
| Method Detail |
|---|
public void addParameterIncludedInPath(String name)
LiferayPortletURL
addParameterIncludedInPath in interface LiferayPortletURLname - the name of the parameter
public void addProperty(String key,
String value)
addProperty in interface BaseURLpublic String getCacheability()
getCacheability in interface ResourceURLpublic javax.servlet.http.HttpServletRequest getHttpServletRequest()
public Layout getLayout()
public String getLayoutFriendlyURL()
public String getLifecycle()
LiferayPortletURL
getLifecycle in interface LiferayPortletURLLiferayPortletURL.setLifecycle(String)public String getNamespace()
public String getParameter(String name)
LiferayPortletURL
getParameter in interface LiferayPortletURLname - the name of the URL parameter
public Map<String,String[]> getParameterMap()
getParameterMap in interface BaseURLpublic Set<String> getParametersIncludedInPath()
LiferayPortletURL
getParametersIncludedInPath in interface LiferayPortletURLpublic long getPlid()
getPlid in interface LiferayPortletURLpublic Portlet getPortlet()
public String getPortletFriendlyURLPath()
public String getPortletId()
LiferayPortletURL
getPortletId in interface LiferayPortletURLpublic PortletMode getPortletMode()
getPortletMode in interface PortletURLpublic PortletRequest getPortletRequest()
public Set<String> getRemovedParameterNames()
getRemovedParameterNames in interface LiferayPortletURLpublic Map<String,String> getReservedParameterMap()
LiferayPortletURL
This method is only used internally. Reserved parameters contain special,
Liferay specific information, such as p_p_id and
p_p_lifecycle.
getReservedParameterMap in interface LiferayPortletURLpublic String getResourceID()
LiferayPortletURL
getResourceID in interface LiferayPortletURLpublic WindowState getWindowState()
getWindowState in interface PortletURLpublic boolean isAnchor()
LiferayPortletURLtrue if this URL is an anchor pointing to the
specified portlet on the page.
isAnchor in interface LiferayPortletURLLiferayPortletURL.setAnchor(boolean)public boolean isCopyCurrentRenderParameters()
LiferayPortletURLtrue if the render parameters in the current request
should be copied to this URL.
isCopyCurrentRenderParameters in interface LiferayPortletURLLiferayPortletURL.setCopyCurrentRenderParameters(boolean)public boolean isEncrypt()
LiferayPortletURLtrue if this URL should be encrypted.
isEncrypt in interface LiferayPortletURLtrue if this URL should be encrypted;
false otherwiseLiferayPortletURL.setEncrypt(boolean)public boolean isEscapeXml()
LiferayPortletURLtrue if this URL should be XML escaped.
isEscapeXml in interface LiferayPortletURLtrue if this URL should be XML escaped;
false otherwiseLiferayPortletURL.setEscapeXml(boolean)public boolean isParameterIncludedInPath(String name)
LiferayPortletURLtrue if the parameter is included in the friendly
URL path.
isParameterIncludedInPath in interface LiferayPortletURLname - the name of the parameter to check for inclusion in the path
LiferayPortletURL.addParameterIncludedInPath(String)public boolean isSecure()
LiferayPortletURLtrue if this URL is secure (https).
isSecure in interface LiferayPortletURLtrue if this URL is secure; false
otherwisepublic void removePublicRenderParameter(String name)
removePublicRenderParameter in interface PortletURLpublic void setAnchor(boolean anchor)
LiferayPortletURLAn 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.
setAnchor in interface LiferayPortletURLanchor - whether this URL is an anchor pointing to the specified
portlet on the pagepublic void setCacheability(String cacheability)
setCacheability in interface ResourceURLpublic void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
LiferayPortletURLNew parameters set on this URL will appear before the copied render parameters.
setCopyCurrentRenderParameters in interface LiferayPortletURLcopyCurrentRenderParameters - whether the render parameters in the
current request should be copied to this URLpublic void setDoAsGroupId(long doAsGroupId)
setDoAsGroupId in interface LiferayPortletURLpublic void setDoAsUserId(long doAsUserId)
LiferayPortletURLWhen a page is accessed while impersonating a user, it will appear exactly as it would to that user.
setDoAsUserId in interface LiferayPortletURLdoAsUserId - the ID of the user to impersonate in the portlet this
URL points topublic void setDoAsUserLanguageId(String doAsUserLanguageId)
LiferayPortletURLLiferayPortletURL.setDoAsUserId(long).
The language set here will override the impersonated user's default language.
setDoAsUserLanguageId in interface LiferayPortletURLdoAsUserLanguageId - the language ID of the user to impersonatepublic void setEncrypt(boolean encrypt)
LiferayPortletURLIn 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.
setEncrypt in interface LiferayPortletURLpublic void setEscapeXml(boolean escapeXml)
LiferayPortletURL
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.
setEscapeXml in interface LiferayPortletURLescapeXml - whether this URL should be XML escapedpublic void setLifecycle(String lifecycle)
LiferayPortletURLValid lifecycles are:
setLifecycle in interface LiferayPortletURLlifecycle - the portlet lifecycle
public void setParameter(String name,
String value)
setParameter in interface BaseURL
public void setParameter(String name,
String value,
boolean append)
LiferayPortletURL
setParameter in interface LiferayPortletURLname - 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. If append is
false any existing values will be overwritten with
the new value.
public void setParameter(String name,
String[] values)
setParameter in interface BaseURL
public void setParameter(String name,
String[] values,
boolean append)
LiferayPortletURL
setParameter in interface LiferayPortletURLname - 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. If append is
false any existing values will be overwritten with
the new values.public void setParameters(Map<String,String[]> params)
setParameters in interface BaseURLpublic void setPlid(long plid)
LiferayPortletURL
setPlid in interface LiferayPortletURLplid - the portlet layout IDpublic void setPortletId(String portletId)
LiferayPortletURL
setPortletId in interface LiferayPortletURL
public void setPortletMode(PortletMode portletMode)
throws PortletModeException
setPortletMode in interface PortletURLPortletModeException
public void setPortletMode(String portletMode)
throws PortletModeException
PortletModeException
public void setProperty(String key,
String value)
setProperty in interface BaseURLpublic void setRefererGroupId(long refererGroupId)
setRefererGroupId in interface LiferayPortletURLpublic void setRefererPlid(long refererPlid)
LiferayPortletURL
setRefererPlid in interface LiferayPortletURLrefererPlid - the referer layout IDpublic void setRemovedParameterNames(Set<String> removedParameterNames)
setRemovedParameterNames in interface LiferayPortletURLpublic void setResourceID(String resourceID)
setResourceID in interface ResourceURLpublic void setSecure(boolean secure)
setSecure in interface BaseURL
public void setWindowState(String windowState)
throws WindowStateException
WindowStateException
public void setWindowState(WindowState windowState)
throws WindowStateException
setWindowState in interface PortletURLWindowStateExceptionpublic void setWindowStateRestoreCurrentView(boolean windowStateRestoreCurrentView)
public String toString()
toString in interface BaseURLtoString in class Object
public void write(Writer writer)
throws IOException
write in interface BaseURLIOException
public void write(Writer writer,
boolean escapeXml)
throws IOException
write in interface BaseURLIOException
protected void addPortalAuthToken(StringBundler sb,
Key key)
protected void addPortletAuthToken(StringBundler sb,
Key key)
protected void clearCache()
protected String generateToString()
protected String generateWSRPToString()
protected String getPublicRenderParameterName(String name)
protected boolean isBlankValue(String[] value)
protected void mergeRenderParameters()
protected String prependNamespace(String name)
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)
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||