com.liferay.portlet
Class PortletURLImpl

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

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

View Source

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

Field Summary
static boolean APPEND_PARAMETERS
           
 
Constructor Summary
PortletURLImpl(ActionRequestImpl req, java.lang.String portletId, long plid, boolean action)
           
PortletURLImpl(javax.servlet.http.HttpServletRequest req, java.lang.String portletId, long plid, boolean action)
           
PortletURLImpl(RenderRequestImpl req, java.lang.String portletId, long plid, boolean action)
           
 
Method Summary
 void addParameterIncludedInPath(java.lang.String name)
           
protected  java.lang.String generateToString()
           
 com.liferay.portal.model.Layout getLayout()
           
 java.lang.String getLayoutFriendlyURL()
           
 java.lang.String getNamespace()
           
 java.lang.String getParameter(java.lang.String name)
           
 java.util.Map getParameterMap()
           
 java.util.Set getParametersIncludedInPath()
           
 long getPlid()
           
 com.liferay.portal.model.Portlet getPortlet()
           
 java.lang.String getPortletFriendlyURLPath()
           
 java.lang.String getPortletId()
           
 javax.portlet.PortletMode getPortletMode()
           
 java.lang.String getPortletName()
          Deprecated. Use getPortletId.
 javax.portlet.PortletRequest getPortletReq()
           
 javax.servlet.http.HttpServletRequest getReq()
           
 javax.portlet.WindowState getWindowState()
           
 boolean isAction()
           
 boolean isAnchor()
           
 boolean isEncrypt()
           
 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 setAction(boolean action)
           
 void setAnchor(boolean anchor)
           
 void setDoAsUserId(long doAsUserId)
           
 void setEncrypt(boolean encrypt)
           
 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 params)
           
 void setPortletId(java.lang.String portletId)
           
 void setPortletMode(javax.portlet.PortletMode portletMode)
           
 void setPortletMode(java.lang.String portletMode)
           
 void setPortletName(java.lang.String portletName)
          Deprecated. Use setPortletId.
 void setSecure(boolean secure)
           
 void setWindowState(java.lang.String windowState)
           
 void setWindowState(javax.portlet.WindowState windowState)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

APPEND_PARAMETERS

public static final boolean APPEND_PARAMETERS
Constructor Detail

PortletURLImpl

public PortletURLImpl(ActionRequestImpl req,
                      java.lang.String portletId,
                      long plid,
                      boolean action)

PortletURLImpl

public PortletURLImpl(RenderRequestImpl req,
                      java.lang.String portletId,
                      long plid,
                      boolean action)

PortletURLImpl

public PortletURLImpl(javax.servlet.http.HttpServletRequest req,
                      java.lang.String portletId,
                      long plid,
                      boolean action)
Method Detail

getReq

public javax.servlet.http.HttpServletRequest getReq()

getPortletReq

public javax.portlet.PortletRequest getPortletReq()

getPortletId

public java.lang.String getPortletId()
Specified by:
getPortletId 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

getPortletName

public java.lang.String getPortletName()
Deprecated. Use getPortletId.


setPortletName

public void setPortletName(java.lang.String portletName)
Deprecated. Use setPortletId.


getPortlet

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

getPortletFriendlyURLPath

public java.lang.String getPortletFriendlyURLPath()

getNamespace

public java.lang.String getNamespace()

getPlid

public long getPlid()

getLayout

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

getLayoutFriendlyURL

public java.lang.String getLayoutFriendlyURL()

isAction

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

setAction

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

getWindowState

public javax.portlet.WindowState getWindowState()
Specified by:
getWindowState in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setWindowState

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

setWindowState

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

getPortletMode

public javax.portlet.PortletMode getPortletMode()
Specified by:
getPortletMode in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

setPortletMode

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

setPortletMode

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

getParameter

public java.lang.String getParameter(java.lang.String name)
Specified by:
getParameter 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.PortletURL

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.PortletURL

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 params)
Specified by:
setParameters in interface javax.portlet.PortletURL

getParameterMap

public java.util.Map getParameterMap()
Specified by:
getParameterMap in interface com.liferay.portal.kernel.portlet.LiferayPortletURL

getParametersIncludedInPath

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

addParameterIncludedInPath

public void addParameterIncludedInPath(java.lang.String name)
Specified by:
addParameterIncludedInPath 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

setSecure

public void setSecure(boolean secure)
               throws javax.portlet.PortletSecurityException
Specified by:
setSecure in interface javax.portlet.PortletURL
Throws:
javax.portlet.PortletSecurityException

isAnchor

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

setAnchor

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

isEncrypt

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

setEncrypt

public void setEncrypt(boolean encrypt)
Specified by:
setEncrypt 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

toString

public java.lang.String toString()
Specified by:
toString in interface javax.portlet.PortletURL

generateToString

protected java.lang.String generateToString()

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)