org.apache.pluto.driver.services.container
Class PortletURLProviderImpl

java.lang.Object
  org.apache.pluto.driver.services.container.PortletURLProviderImpl

All Implemented Interfaces:

PortletURLProvider

public class PortletURLProviderImpl
extends java.lang.Object
implements PortletURLProvider

Constructor Summary

PortletURLProviderImpl(javax.servlet.http.HttpServletRequest request, PortletWindow internalPortletWindow)

Method Summary

void	clearParameters() Removes all pre-existing parameters in this URL
java.lang.String[]	getPrivateRenderParameters(java.lang.String name) Gets the values from the parameters from this request.
java.lang.String[]	getPublicRenderParameters(java.lang.String name) Gets the values from the current public-render-parameters from this request.
boolean	isResourceServing() Shows you if the lifecycle is serveResource
boolean	isSecureSupported() Determine whether or not this url provider supports secure urls.
void	savePortalURL(javax.servlet.http.HttpServletRequest request)
void	setAction(boolean action) Specifies whether or not this request should be considered an action request.
void	setParameters(java.util.Map parameters) Sets the given parameters as parameters into the URL, Removes all previously set parameters.
void	setPortletMode(PortletMode mode) Sets the new portlet mode at the URL.
void	setPublicRenderParameters(java.util.Map parameters) Sets the given public-render-parameters as parameters into the URL.
void	setResourceServing(boolean resourceServing) Specifies whether or not this request should be considered an resource Serving request.
void	setSecure() By calling this method the URL is defined as a secure URL.
void	setWindowState(WindowState state) Sets the new window state at the URL.
java.lang.String	toString() Returns the URL in string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletURLProviderImpl

public PortletURLProviderImpl(javax.servlet.http.HttpServletRequest request,
                              PortletWindow internalPortletWindow)

Method Detail

setPortletMode

public void setPortletMode(PortletMode mode)

Description copied from interface: PortletURLProvider

Sets the new portlet mode at the URL. If no mode is set at the URL the currently active mode is used.

Specified by:

setPortletMode in interface PortletURLProvider

Parameters:

mode - the new portlet mode

setWindowState

public void setWindowState(WindowState state)

Description copied from interface: PortletURLProvider

Sets the new window state at the URL. If no state is set at the URL the currently active state is used.

Specified by:

setWindowState in interface PortletURLProvider

Parameters:

state - the new window state

setResourceServing

public void setResourceServing(boolean resourceServing)

Description copied from interface: PortletURLProvider

Specifies whether or not this request should be considered an resource Serving request.

Specified by:

setResourceServing in interface PortletURLProvider

isResourceServing

public boolean isResourceServing()

Description copied from interface: PortletURLProvider

Shows you if the lifecycle is serveResource

Specified by:

isResourceServing in interface PortletURLProvider

Returns:

true if ResourceServing else false

setAction

public void setAction(boolean action)

Description copied from interface: PortletURLProvider

Specifies whether or not this request should be considered an action request. If the value specified is false, a render request will be assumed.

Specified by:

setAction in interface PortletURLProvider

setSecure

public void setSecure()
               throws PortletSecurityException

Description copied from interface: PortletURLProvider

By calling this method the URL is defined as a secure URL.

Specified by:

setSecure in interface PortletURLProvider

Throws:

PortletSecurityException

isSecureSupported

public boolean isSecureSupported()

Description copied from interface: PortletURLProvider

Determine whether or not this url provider supports secure urls.

Specified by:

isSecureSupported in interface PortletURLProvider

Returns:

clearParameters

public void clearParameters()

Description copied from interface: PortletURLProvider

Removes all pre-existing parameters in this URL

Specified by:

clearParameters in interface PortletURLProvider

setParameters

public void setParameters(java.util.Map parameters)

Description copied from interface: PortletURLProvider

Sets the given parameters as parameters into the URL, Removes all previously set parameters.

Specified by:

setParameters in interface PortletURLProvider

Parameters:

parameters - a map containing the name [java.lang.String] and value [java.lang.String[]] of the parameters.

getPrivateRenderParameters

public java.lang.String[] getPrivateRenderParameters(java.lang.String name)

Description copied from interface: PortletURLProvider

Gets the values from the parameters from this request. This is only used for ServeResource.

Specified by:

getPrivateRenderParameters in interface PortletURLProvider

Parameters:

name - Parametername

Returns:

the values for the Parameter, can be null, if there is no Parameter with this name.

getPublicRenderParameters

public java.lang.String[] getPublicRenderParameters(java.lang.String name)

Description copied from interface: PortletURLProvider

Gets the values from the current public-render-parameters from this request.

Specified by:

getPublicRenderParameters in interface PortletURLProvider

Parameters:

name - Parametername

Returns:

the values for the Parameter, can be null, if there is no Parameter with this name.

setPublicRenderParameters

public void setPublicRenderParameters(java.util.Map parameters)

Description copied from interface: PortletURLProvider

Sets the given public-render-parameters as parameters into the URL.

Specified by:

setPublicRenderParameters in interface PortletURLProvider

Parameters:

parameters - a map containing the name [java.lang.String] and value [java.lang.String[]] of the parameters.

toString

public java.lang.String toString()

Description copied from interface: PortletURLProvider

Returns the URL in string format. This method should only be called once.

Specified by:

toString in interface PortletURLProvider

Overrides:

toString in class java.lang.Object

Returns:

the URL

savePortalURL

public void savePortalURL(javax.servlet.http.HttpServletRequest request)

Specified by:

savePortalURL in interface PortletURLProvider