org.apache.pluto.spi
Interface PortletURLProvider

All Known Implementing Classes:
PortletURLProviderImpl

public interface PortletURLProvider

Defines the interface used by the portlet container to create Portal URLs. This provider must be implemented by the Portal and provided via the container services upon initialization of the container.

Version:
1.0

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 resource)
          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.
 

Method Detail

setPortletMode

void setPortletMode(PortletMode mode)
Sets the new portlet mode at the URL. If no mode is set at the URL the currently active mode is used.

Parameters:
mode - the new portlet mode

setWindowState

void setWindowState(WindowState state)
Sets the new window state at the URL. If no state is set at the URL the currently active state is used.

Parameters:
state - the new window state

setAction

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


setResourceServing

void setResourceServing(boolean resource)
Specifies whether or not this request should be considered an resource Serving request.

Since:
2.0

isResourceServing

boolean isResourceServing()
Shows you if the lifecycle is serveResource

Returns:
true if ResourceServing else false
Since:
2.0

setSecure

void setSecure()
               throws PortletSecurityException
By calling this method the URL is defined as a secure URL.

Throws:
PortletSecurityException

isSecureSupported

boolean isSecureSupported()
Determine whether or not this url provider supports secure urls.

Returns:
Throws:
PortletSecurityException

clearParameters

void clearParameters()
Removes all pre-existing parameters in this URL


setParameters

void setParameters(java.util.Map parameters)
Sets the given parameters as parameters into the URL, Removes all previously set parameters.

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

setPublicRenderParameters

void setPublicRenderParameters(java.util.Map parameters)
Sets the given public-render-parameters as parameters into the URL.

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

toString

java.lang.String toString()
Returns the URL in string format. This method should only be called once.

Overrides:
toString in class java.lang.Object
Returns:
the URL

savePortalURL

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

getPublicRenderParameters

java.lang.String[] getPublicRenderParameters(java.lang.String name)
Gets the values from the current public-render-parameters from this request.

Parameters:
name - Parametername
Returns:
the values for the Parameter, can be null, if there is no Parameter with this name.

getPrivateRenderParameters

java.lang.String[] getPrivateRenderParameters(java.lang.String name)
Gets the values from the parameters from this request. This is only used for ServeResource.

Parameters:
name - Parametername
Returns:
the values for the Parameter, can be null, if there is no Parameter with this name.


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