org.apache.pluto.driver.url.impl

Class RelativePortalURLImpl

java.lang.Object

org.apache.pluto.driver.url.impl.RelativePortalURLImpl

All Implemented Interfaces:

Cloneable, org.apache.pluto.driver.url.PortalURL

public class RelativePortalURLImpl
extends Object
implements org.apache.pluto.driver.url.PortalURL

The portal URL.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
RelativePortalURLImpl(String urlBase, String contextPath, String servletName, org.apache.pluto.driver.url.PortalURLParser urlParser) Constructs a PortalURLImpl instance using customized port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(org.apache.pluto.driver.url.PortalURLParameter param)
void	addPublicParameterActionResourceParameter(String parameterName, String value)
void	addPublicParameterCurrent(String name, String[] values)
void	addPublicRenderParametersNew(Map<String,String[]> parameters)
void	clearParameters(String windowId) Clear parameters of the specified window.
org.apache.pluto.driver.url.PortalURL	clone() Clone a copy of itself.
String	getActionWindow()
String	getCacheability()
String	getLutecePortletId()
Map<String,String[]>	getNewPublicParameters()
org.apache.pluto.driver.services.portal.PageConfig	getPageConfig(javax.servlet.ServletContext servletContext)
Collection<org.apache.pluto.driver.url.PortalURLParameter>	getParameters()
javax.portlet.PortletMode	getPortletMode(String windowId)
Map<String,javax.portlet.PortletMode>	getPortletModes()
Map<String,String[]>	getPrivateRenderParameters()
Map<String,String[]>	getPublicParameters()
String	getRenderPath()
String	getResourceID()
String	getResourceWindow()
String	getServerURI() Deprecated.
String	getServletPath() Returns the servlet path (context path + servlet name).
javax.portlet.WindowState	getWindowState(String windowId) Returns the window state of the specified window.
Map<String,javax.portlet.WindowState>	getWindowStates()
void	merge(org.apache.pluto.driver.url.PortalURL url, String windowId)
void	setActionWindow(String actionWindow)
void	setCacheability(String cacheLevel)
void	setLutecePortletId(String strLutecePortletID)
void	setPortletMode(String windowId, javax.portlet.PortletMode portletMode)
void	setRenderPath(String renderPath)
void	setResourceID(String resourceID)
void	setResourceWindow(String resourceWindow)
void	setWindowState(String windowId, javax.portlet.WindowState windowState) Sets the window state of the specified window.
String	toString() Deprecated. use toURL(boolean absolute) instead
String	toURL(boolean absolute) Converts to a string representing the portal URL.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RelativePortalURLImpl

public RelativePortalURLImpl(String urlBase,
                     String contextPath,
                     String servletName,
                     org.apache.pluto.driver.url.PortalURLParser urlParser)

Constructs a PortalURLImpl instance using customized port.

Parameters:

urlBase - the absolute (protocol://domain:port) request url base

contextPath - the servlet context path.

servletName - the servlet name.

urlParser - the PortalURLParser used to construct a string representation of the url.

Method Detail

setRenderPath

public void setRenderPath(String renderPath)

Specified by:

setRenderPath in interface org.apache.pluto.driver.url.PortalURL

getRenderPath

public String getRenderPath()

Specified by:

getRenderPath in interface org.apache.pluto.driver.url.PortalURL

addParameter

public void addParameter(org.apache.pluto.driver.url.PortalURLParameter param)

Specified by:

addParameter in interface org.apache.pluto.driver.url.PortalURL

getParameters

public Collection<org.apache.pluto.driver.url.PortalURLParameter> getParameters()

Specified by:

getParameters in interface org.apache.pluto.driver.url.PortalURL

setActionWindow

public void setActionWindow(String actionWindow)

Specified by:

setActionWindow in interface org.apache.pluto.driver.url.PortalURL

getActionWindow

public String getActionWindow()

Specified by:

getActionWindow in interface org.apache.pluto.driver.url.PortalURL

getPortletModes

public Map<String,javax.portlet.PortletMode> getPortletModes()

Specified by:

getPortletModes in interface org.apache.pluto.driver.url.PortalURL

getPortletMode

public javax.portlet.PortletMode getPortletMode(String windowId)

Specified by:

getPortletMode in interface org.apache.pluto.driver.url.PortalURL

setPortletMode

public void setPortletMode(String windowId,
                  javax.portlet.PortletMode portletMode)

Specified by:

setPortletMode in interface org.apache.pluto.driver.url.PortalURL

getWindowStates

public Map<String,javax.portlet.WindowState> getWindowStates()

Specified by:

getWindowStates in interface org.apache.pluto.driver.url.PortalURL

getWindowState

public javax.portlet.WindowState getWindowState(String windowId)

Returns the window state of the specified window.

Specified by:

getWindowState in interface org.apache.pluto.driver.url.PortalURL

Parameters:

windowId - the window ID.

Returns:

the window state. Default to NORMAL.

setWindowState

public void setWindowState(String windowId,
                  javax.portlet.WindowState windowState)

Sets the window state of the specified window.

Specified by:

setWindowState in interface org.apache.pluto.driver.url.PortalURL

Parameters:

windowId - the window ID.

windowState - the window state.

clearParameters

public void clearParameters(String windowId)

Clear parameters of the specified window.

Specified by:

clearParameters in interface org.apache.pluto.driver.url.PortalURL

Parameters:

windowId - the window ID.

setCacheability

public void setCacheability(String cacheLevel)

Specified by:

setCacheability in interface org.apache.pluto.driver.url.PortalURL

getCacheability

public String getCacheability()

Specified by:

getCacheability in interface org.apache.pluto.driver.url.PortalURL

setResourceID

public void setResourceID(String resourceID)

Specified by:

setResourceID in interface org.apache.pluto.driver.url.PortalURL

getResourceID

public String getResourceID()

Specified by:

getResourceID in interface org.apache.pluto.driver.url.PortalURL

setLutecePortletId

public void setLutecePortletId(String strLutecePortletID)

getLutecePortletId

public String getLutecePortletId()

toString

public String toString()

Deprecated. use toURL(boolean absolute) instead

Converts to a string representing the portal URL.

Specified by:

toString in interface org.apache.pluto.driver.url.PortalURL

Overrides:

toString in class Object

Returns:

a string representing the portal URL.

See Also:

PortalURLParserImpl.toString(org.apache.pluto.driver.url.PortalURL)

toURL

public String toURL(boolean absolute)

Converts to a string representing the portal URL.

Specified by:

toURL in interface org.apache.pluto.driver.url.PortalURL

Returns:

a string representing the portal URL.

See Also:

PortalURLParserImpl.toString(org.apache.pluto.driver.url.PortalURL)

getServerURI

@Deprecated
public String getServerURI()

Deprecated.

Returns the server URI (protocol, name, port).

Specified by:

getServerURI in interface org.apache.pluto.driver.url.PortalURL

Returns:

the server URI portion of the portal URL.

getServletPath

public String getServletPath()

Returns the servlet path (context path + servlet name).

Specified by:

getServletPath in interface org.apache.pluto.driver.url.PortalURL

Returns:

the servlet path.

clone

public org.apache.pluto.driver.url.PortalURL clone()

Clone a copy of itself.

Specified by:

clone in interface org.apache.pluto.driver.url.PortalURL

Overrides:

clone in class Object

Returns:

a copy of itself.

addPublicRenderParametersNew

public void addPublicRenderParametersNew(Map<String,String[]> parameters)

Specified by:

addPublicRenderParametersNew in interface org.apache.pluto.driver.url.PortalURL

addPublicParameterCurrent

public void addPublicParameterCurrent(String name,
                             String[] values)

Specified by:

addPublicParameterCurrent in interface org.apache.pluto.driver.url.PortalURL

addPublicParameterActionResourceParameter

public void addPublicParameterActionResourceParameter(String parameterName,
                                             String value)

Specified by:

addPublicParameterActionResourceParameter in interface org.apache.pluto.driver.url.PortalURL

getPublicParameters

public Map<String,String[]> getPublicParameters()

Specified by:

getPublicParameters in interface org.apache.pluto.driver.url.PortalURL

getNewPublicParameters

public Map<String,String[]> getNewPublicParameters()

Specified by:

getNewPublicParameters in interface org.apache.pluto.driver.url.PortalURL

getPrivateRenderParameters

public Map<String,String[]> getPrivateRenderParameters()

Specified by:

getPrivateRenderParameters in interface org.apache.pluto.driver.url.PortalURL

getPageConfig

public org.apache.pluto.driver.services.portal.PageConfig getPageConfig(javax.servlet.ServletContext servletContext)

Specified by:

getPageConfig in interface org.apache.pluto.driver.url.PortalURL

getResourceWindow

public String getResourceWindow()

Specified by:

getResourceWindow in interface org.apache.pluto.driver.url.PortalURL

setResourceWindow

public void setResourceWindow(String resourceWindow)

Specified by:

setResourceWindow in interface org.apache.pluto.driver.url.PortalURL

merge

public void merge(org.apache.pluto.driver.url.PortalURL url,
         String windowId)

Specified by:

merge in interface org.apache.pluto.driver.url.PortalURL