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

java.lang.Object
  extended by org.apache.pluto.driver.url.impl.RelativePortalURLImpl
All Implemented Interfaces:
java.lang.Cloneable, PortalURL

public class RelativePortalURLImpl
extends java.lang.Object
implements PortalURL

The portal URL.

Since:
1.0

Constructor Summary
RelativePortalURLImpl(java.lang.String contextPath, java.lang.String servletName, PortalURLParser urlParser)
          Constructs a PortalURLImpl instance using customized port.
 
Method Summary
 void addParameter(PortalURLParameter param)
           
 void addPublicParameterCurrent(java.lang.String name, java.lang.String[] values)
           
 void addPublicRenderParametersNew(java.util.Map parameters)
           
 void clearParameters(java.lang.String windowId)
          Clear parameters of the specified window.
 java.lang.Object clone()
          Clone a copy of itself.
 java.lang.String getActionWindow()
           
 PageConfig getPageConfig(javax.servlet.ServletContext servletContext)
           
 java.util.Collection getParameters()
           
 PortletMode getPortletMode(java.lang.String windowId)
           
 java.util.Map getPortletModes()
           
 java.util.Map<java.lang.String,java.lang.String[]> getPublicParameters()
           
 java.lang.String getRenderPath()
           
 java.lang.String getResourceWindow()
           
 java.lang.String getServerURI()
          Deprecated.  
 java.lang.String getServletPath()
          Returns the servlet path (context path + servlet name).
 WindowState getWindowState(java.lang.String windowId)
          Returns the window state of the specified window.
 java.util.Map getWindowStates()
           
 void setActionWindow(java.lang.String actionWindow)
           
 void setPortletMode(java.lang.String windowId, PortletMode portletMode)
           
 void setRenderPath(java.lang.String renderPath)
           
 void setResourceWindow(java.lang.String resourceWindow)
           
 void setWindowState(java.lang.String windowId, WindowState windowState)
          Sets the window state of the specified window.
 java.lang.String toString()
          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(java.lang.String contextPath,
                             java.lang.String servletName,
                             PortalURLParser urlParser)
Constructs a PortalURLImpl instance using customized port.

Parameters:
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(java.lang.String renderPath)
Specified by:
setRenderPath in interface PortalURL

getRenderPath

public java.lang.String getRenderPath()
Specified by:
getRenderPath in interface PortalURL

addParameter

public void addParameter(PortalURLParameter param)
Specified by:
addParameter in interface PortalURL

getParameters

public java.util.Collection getParameters()
Specified by:
getParameters in interface PortalURL

setActionWindow

public void setActionWindow(java.lang.String actionWindow)
Specified by:
setActionWindow in interface PortalURL

getActionWindow

public java.lang.String getActionWindow()
Specified by:
getActionWindow in interface PortalURL

getPortletModes

public java.util.Map getPortletModes()
Specified by:
getPortletModes in interface PortalURL

getPortletMode

public PortletMode getPortletMode(java.lang.String windowId)
Specified by:
getPortletMode in interface PortalURL

setPortletMode

public void setPortletMode(java.lang.String windowId,
                           PortletMode portletMode)
Specified by:
setPortletMode in interface PortalURL

getWindowStates

public java.util.Map getWindowStates()
Specified by:
getWindowStates in interface PortalURL

getWindowState

public WindowState getWindowState(java.lang.String windowId)
Returns the window state of the specified window.

Specified by:
getWindowState in interface PortalURL
Parameters:
windowId - the window ID.
Returns:
the window state. Default to NORMAL.

setWindowState

public void setWindowState(java.lang.String windowId,
                           WindowState windowState)
Sets the window state of the specified window.

Specified by:
setWindowState in interface PortalURL
Parameters:
windowId - the window ID.
windowState - the window state.

clearParameters

public void clearParameters(java.lang.String windowId)
Clear parameters of the specified window.

Specified by:
clearParameters in interface PortalURL
Parameters:
windowId - the window ID.

toString

public java.lang.String toString()
Converts to a string representing the portal URL.

Specified by:
toString in interface PortalURL
Overrides:
toString in class java.lang.Object
Returns:
a string representing the portal URL.
See Also:
PortalURLParserImpl.toString(org.apache.pluto.driver.url.PortalURL)

getServerURI

public java.lang.String getServerURI()
Deprecated. 

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

Specified by:
getServerURI in interface PortalURL
Returns:
the server URI portion of the portal URL.

getServletPath

public java.lang.String getServletPath()
Returns the servlet path (context path + servlet name).

Specified by:
getServletPath in interface PortalURL
Returns:
the servlet path.

clone

public java.lang.Object clone()
Clone a copy of itself.

Specified by:
clone in interface PortalURL
Overrides:
clone in class java.lang.Object
Returns:
a copy of itself.

addPublicRenderParametersNew

public void addPublicRenderParametersNew(java.util.Map parameters)
Specified by:
addPublicRenderParametersNew in interface PortalURL

addPublicParameterCurrent

public void addPublicParameterCurrent(java.lang.String name,
                                      java.lang.String[] values)
Specified by:
addPublicParameterCurrent in interface PortalURL

getPublicParameters

public java.util.Map<java.lang.String,java.lang.String[]> getPublicParameters()
Specified by:
getPublicParameters in interface PortalURL

getPageConfig

public PageConfig getPageConfig(javax.servlet.ServletContext servletContext)
Specified by:
getPageConfig in interface PortalURL

getResourceWindow

public java.lang.String getResourceWindow()
Specified by:
getResourceWindow in interface PortalURL

setResourceWindow

public void setResourceWindow(java.lang.String resourceWindow)
Specified by:
setResourceWindow in interface PortalURL


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.