com.liferay.portlet
Class PortletURLImpl

java.lang.Object
  extended by com.liferay.portlet.PortletURLImpl
All Implemented Interfaces:
com.liferay.portal.kernel.portlet.LiferayPortletURL, java.io.Serializable, javax.portlet.BaseURL, javax.portlet.PortletURL, javax.portlet.ResourceURL
Direct Known Subclasses:
LiferayPortletURLImpl, PortletURLImplWrapper, WSRPPortletURLImpl

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

View Source

Author:
Brian Wing Shun Chan, Jorge Ferrer
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.portlet.ResourceURL
FULL, PAGE, PORTLET, SHARED
 
Constructor Summary
PortletURLImpl(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, long plid, java.lang.String lifecycle)
           
PortletURLImpl(PortletRequestImpl portletRequestImpl, java.lang.String portletId, long plid, java.lang.String lifecycle)
           
 
Method Summary
 void addParameterIncludedInPath(java.lang.String name)
           
 void addProperty(java.lang.String key, java.lang.String value)
           
protected  java.lang.String generateToString()
           
 java.lang.String getCacheability()
           
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
           
 com.liferay.portal.model.Layout getLayout()
           
 java.lang.String getLayoutFriendlyURL()
           
 java.lang.String getLifecycle()
           
 java.lang.String getNamespace()
           
 java.lang.String getParameter(java.lang.String name)
           
 java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
           
 java.util.Set<java.lang.String> getParametersIncludedInPath()
           
 long getPlid()
           
 com.liferay.portal.model.Portlet getPortlet()
           
 java.lang.String getPortletFriendlyURLPath()
           
 java.lang.String getPortletId()
           
 javax.portlet.PortletMode getPortletMode()
           
 javax.portlet.PortletRequest getPortletRequest()
           
 java.lang.String getResourceID()
           
 javax.portlet.WindowState getWindowState()
           
 boolean isAnchor()
           
protected  boolean isBlankValue(java.lang.String[] value)
           
 boolean isCopyCurrentPublicRenderParameters()
           
 boolean isCopyCurrentRenderParameters()
           
 boolean isEncrypt()
           
 boolean isEscapeXml()
           
 boolean isParameterIncludedInPath(java.lang.String name)
           
 boolean isSecure()
           
protected  java.lang.String processValue(java.security.Key key, int value)
           
protected  java.lang.String processValue(java.security.Key key, long value)
           
protected  java.lang.String processValue(java.security.Key key, java.lang.String value)
           
 void removePublicRenderParameter(java.lang.String name)
           
 void setAnchor(boolean anchor)
           
 void setCacheability(java.lang.String cacheability)
           
 void setCopyCurrentPublicRenderParameters(boolean copyCurrentPublicRenderParameters)
           
 void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
           
 void setDoAsGroupId(long doAsGroupId)
           
 void setDoAsUserId(long doAsUserId)
           
 void setDoAsUserLanguageId(java.lang.String doAsUserLanguageId)
           
 void setEncrypt(boolean encrypt)
           
 void setEscapeXml(boolean escapeXml)
           
 void setLifecycle(java.lang.String lifecycle)
           
 void setParameter(java.lang.String name, java.lang.String value)
           
 void setParameter(java.lang.String name, java.lang.String[] values)
           
 void setParameter(java.lang.String name, java.lang.String[] values, boolean append)
           
 void setParameter(java.lang.String name, java.lang.String value, boolean append)
           
 void setParameters(java.util.Map<java.lang.String,java.lang.String[]> params)
           
 void setPlid(long plid)
           
 void setPortletId(java.lang.String portletId)
           
 void setPortletMode(javax.portlet.PortletMode portletMode)
           
 void setPortletMode(java.lang.String portletMode)
           
 void setProperty(java.lang.String key, java.lang.String value)
           
 void setRefererPlid(long refererPlid)
           
 void setResourceID(java.lang.String resourceID)
           
 void setSecure(boolean secure)
           
 void setURLType(com.sun.portal.container.ChannelURLType urlType)
           
 void setWindowState(java.lang.String windowState)
           
 void setWindowState(javax.portlet.WindowState windowState)
           
 java.lang.String toString()
           
 void write(java.io.Writer writer)
           
 void write(java.io.Writer writer, boolean escapeXml)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PortletURLImpl

public PortletURLImpl(PortletRequestImpl portletRequestImpl,
                      java.lang.String portletId,
                      long plid,
                      java.lang.String lifecycle)

PortletURLImpl

public PortletURLImpl(javax.servlet.http.HttpServletRequest request,
                      java.lang.String portletId,
                      long plid,
                      java.lang.String lifecycle)
Method Detail

addParameterIncludedInPath

public void addParameterIncludedInPath(java.lang.String name)
Specified by:
addParameterIncludedInPath in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)
Specified by:
addProperty in interface javax.portlet.BaseURL

getCacheability

public java.lang.String getCacheability()
Specified by:
getCacheability in interface javax.portlet.ResourceURL

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

getNamespace

public java.lang.String getNamespace()

getLayout

public com.liferay.portal.model.Layout getLayout()

getLayoutFriendlyURL

public java.lang.String getLayoutFriendlyURL()

getLifecycle

public java.lang.String getLifecycle()
Specified by:
getLifecycle in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getParameter

public java.lang.String getParameter(java.lang.String name)
Specified by:
getParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
Specified by:
getParameterMap in interface javax.portlet.BaseURL

getParametersIncludedInPath

public java.util.Set<java.lang.String> getParametersIncludedInPath()
Specified by:
getParametersIncludedInPath in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getPlid

public long getPlid()

getPortlet

public com.liferay.portal.model.Portlet getPortlet()

getPortletFriendlyURLPath

public java.lang.String getPortletFriendlyURLPath()

getPortletId

public java.lang.String getPortletId()
Specified by:
getPortletId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getPortletMode

public javax.portlet.PortletMode getPortletMode()
Specified by:
getPortletMode in interface javax.portlet.PortletURL

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

getResourceID

public java.lang.String getResourceID()
Specified by:
getResourceID in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getWindowState

public javax.portlet.WindowState getWindowState()
Specified by:
getWindowState in interface javax.portlet.PortletURL

isAnchor

public boolean isAnchor()
Specified by:
isAnchor in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

isCopyCurrentPublicRenderParameters

public boolean isCopyCurrentPublicRenderParameters()

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(java.lang.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(java.lang.String name)
Specified by:
removePublicRenderParameter in interface javax.portlet.PortletURL

setAnchor

public void setAnchor(boolean anchor)
Specified by:
setAnchor in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setCacheability

public void setCacheability(java.lang.String cacheability)
Specified by:
setCacheability in interface javax.portlet.ResourceURL

setCopyCurrentPublicRenderParameters

public void setCopyCurrentPublicRenderParameters(boolean copyCurrentPublicRenderParameters)

setCopyCurrentRenderParameters

public void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
Specified by:
setCopyCurrentRenderParameters 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(java.lang.String doAsUserLanguageId)
Specified by:
setDoAsUserLanguageId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setDoAsGroupId

public void setDoAsGroupId(long doAsGroupId)

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(java.lang.String lifecycle)
Specified by:
setLifecycle in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Specified by:
setParameter in interface javax.portlet.BaseURL

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value,
                         boolean append)
Specified by:
setParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String[] values)
Specified by:
setParameter in interface javax.portlet.BaseURL

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String[] values,
                         boolean append)
Specified by:
setParameter in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String[]> params)
Specified by:
setParameters in interface javax.portlet.BaseURL

setPlid

public void setPlid(long plid)
Specified by:
setPlid in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setPortletId

public void setPortletId(java.lang.String portletId)
Specified by:
setPortletId in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setPortletMode

public void setPortletMode(java.lang.String portletMode)
                    throws javax.portlet.PortletModeException
Throws:
javax.portlet.PortletModeException

setPortletMode

public void setPortletMode(javax.portlet.PortletMode portletMode)
                    throws javax.portlet.PortletModeException
Specified by:
setPortletMode in interface javax.portlet.PortletURL
Throws:
javax.portlet.PortletModeException

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
Specified by:
setProperty in interface javax.portlet.BaseURL

setRefererPlid

public void setRefererPlid(long refererPlid)

setResourceID

public void setResourceID(java.lang.String resourceID)
Specified by:
setResourceID in interface javax.portlet.ResourceURL

setSecure

public void setSecure(boolean secure)
Specified by:
setSecure in interface javax.portlet.BaseURL

setWindowState

public void setWindowState(java.lang.String windowState)
                    throws javax.portlet.WindowStateException
Throws:
javax.portlet.WindowStateException

setWindowState

public void setWindowState(javax.portlet.WindowState windowState)
                    throws javax.portlet.WindowStateException
Specified by:
setWindowState in interface javax.portlet.PortletURL
Throws:
javax.portlet.WindowStateException

setURLType

public void setURLType(com.sun.portal.container.ChannelURLType urlType)
Specified by:
setURLType in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

toString

public java.lang.String toString()
Specified by:
toString in interface javax.portlet.BaseURL
Overrides:
toString in class java.lang.Object

write

public void write(java.io.Writer writer)
           throws java.io.IOException
Specified by:
write in interface javax.portlet.BaseURL
Throws:
java.io.IOException

write

public void write(java.io.Writer writer,
                  boolean escapeXml)
           throws java.io.IOException
Specified by:
write in interface javax.portlet.BaseURL
Throws:
java.io.IOException

generateToString

protected java.lang.String generateToString()

isBlankValue

protected boolean isBlankValue(java.lang.String[] value)

processValue

protected java.lang.String processValue(java.security.Key key,
                                        int value)

processValue

protected java.lang.String processValue(java.security.Key key,
                                        long value)

processValue

protected java.lang.String processValue(java.security.Key key,
                                        java.lang.String value)