org.apache.pluto.spi
Interface PortletURLProvider


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
 boolean isSecureSupported()
          Determine whether or not this url provider supports secure urls.
 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(javax.portlet.PortletMode mode)
          Sets the new portlet mode at the URL.
 void setSecure()
          By calling this method the URL is defined as a secure URL.
 void setWindowState(javax.portlet.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(javax.portlet.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(javax.portlet.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.


setSecure

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

Throws:
javax.portlet.PortletSecurityException

isSecureSupported

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

Returns:
Throws:
javax.portlet.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.

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


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