org.gatein.wsrp

Class WSRPPortletURL

java.lang.Object

org.gatein.wsrp.WSRPPortletURL

All Implemented Interfaces:

org.gatein.pc.api.ContainerURL

Direct Known Subclasses:

WSRPActionURL, WSRPRenderURL, WSRPResourceURL

public abstract class WSRPPortletURL
extends Object
implements org.gatein.pc.api.ContainerURL

Translates WSRP-encoded URLs into portlet container-understandable URLs (and back).

Since:

2.4 (Apr 28, 2006)

Version:

$Revision: 13470 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WSRPPortletURL.URLContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AMPERSAND
protected static String	EQUALS
protected String	extra Holds extra data after URL in relaxed mode
protected static org.slf4j.Logger	log
protected org.gatein.pc.api.StateString	navigationalState
protected static boolean	strict Are we using strict rewriting parameters validation mode?

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WSRPPortletURL()
protected	WSRPPortletURL(org.gatein.pc.api.Mode mode, org.gatein.pc.api.WindowState windowState, boolean secure, org.gatein.pc.api.StateString navigationalState, WSRPPortletURL.URLContext context)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	appendEnd(StringBuffer sb)
protected void	appendExtraParams(StringBuffer buffer)
static WSRPPortletURL	create(org.gatein.pc.api.ContainerURL containerURL, boolean secure, WSRPPortletURL.URLContext context) Factory method to create the appropriate WSRPPortletURL based on the specified ContainerURL.
static WSRPPortletURL	create(String encodedURL) Parses a WSRP rewritten URL and extracts each component.
static WSRPPortletURL	create(String encodedURL, Set<String> customModes, Set<String> customWindowStates) Extracts the URL information contained in the specified WSRP-encoded String into a WSRPPortletURL object.
static WSRPPortletURL	create(String encodedURL, Set<String> customModes, Set<String> customWindowStates, boolean noBoundaries)
protected void	createURLParameter(StringBuffer sb, String name, String value)
protected void	dealWithSpecificParams(Map<String,String> params, String originalURL) Deal with specific parameters first so that we can remove them before dealing with extra params.
org.gatein.pc.api.Mode	getMode()
org.gatein.pc.api.StateString	getNavigationalState()
Map<String,String>	getProperties()
protected String	getRawParameterValueFor(Map params, String parameterName)
protected abstract String	getURLType()
org.gatein.pc.api.WindowState	getWindowState()
boolean	isSecure()
void	setExtra(String extra)
protected void	setParams(Map<String,String> params, String originalURL)
static void	setStrict(boolean strict)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

EQUALS

protected static final String EQUALS

See Also:

Constant Field Values

AMPERSAND

protected static final String AMPERSAND

See Also:

Constant Field Values

navigationalState

protected org.gatein.pc.api.StateString navigationalState

strict

protected static boolean strict

Are we using strict rewriting parameters validation mode?

extra

protected String extra

Holds extra data after URL in relaxed mode

Constructor Detail

WSRPPortletURL

protected WSRPPortletURL(org.gatein.pc.api.Mode mode,
              org.gatein.pc.api.WindowState windowState,
              boolean secure,
              org.gatein.pc.api.StateString navigationalState,
              WSRPPortletURL.URLContext context)

WSRPPortletURL

protected WSRPPortletURL()

Method Detail

setStrict

public static void setStrict(boolean strict)

create

public static WSRPPortletURL create(org.gatein.pc.api.ContainerURL containerURL,
                    boolean secure,
                    WSRPPortletURL.URLContext context)

Factory method to create the appropriate WSRPPortletURL based on the specified ContainerURL.

Parameters:

containerURL - a ContainerURL to be converter into WSRP-understandable URL

secure - whether or not this URL needs to be secure

context - contextual information that might be needed by URLs but are not readily available in the ContainerURL

Returns:

a new WSRPPortletURL containing all the information to generate a valid WSRP URL

create

public static WSRPPortletURL create(String encodedURL,
                    Set<String> customModes,
                    Set<String> customWindowStates)

Extracts the URL information contained in the specified WSRP-encoded String into a WSRPPortletURL object.

Parameters:

encodedURL - a WSRP-encoded String representation of a portlet URL

customModes - potentially empty set of custom modes to check if modes found in the encoded URL are valid

customWindowStates - potentially empty set of custom window states to check if window states found in the encoded URL are valid

Returns:

a WSRPPortletURL containing the information extracted from the encoded URL

create

public static WSRPPortletURL create(String encodedURL,
                    Set<String> customModes,
                    Set<String> customWindowStates,
                    boolean noBoundaries)

create

public static WSRPPortletURL create(String encodedURL)

Parses a WSRP rewritten URL and extracts each component.

TODO: some values need to be in pairs or are mutually exclusive, check for this

URL are of the form: wsrp_rewrite?wsrp-urlType=value&name1=value1&name2=value2 .../wsrp_rewrite

Examples:
• Load a resource http://test.com/images/test.gif:
  wsrp_rewrite?wsrp-urlType=resource&wsrp-url=http%3A%2F%2Ftest.com%2Fimages%2Ftest.gif&wsrp-requiresRewrite=true/wsrp_rewrite
• Declare a secure interaction back to the Portlet:
  wsrp_rewrite?wsrp-urlType=blockingAction&wsrp-secureURL=true&wsrp-navigationalState=a8h4K5JD9&wsrp-interactionState=fg4h923mdk/wsrp_rewrite
• Request the Consumer render the Portlet in a different mode and window state: wsrp_rewrite?wsrp-urlType=render&wsrp-mode=help&wsrp-windowState=maximized/wsrp_rewrite

Parameters:

encodedURL - a String representation of the URL to create

Returns:

an appropriate WSRPPortletURL as built from parsing the specified String

setParams

protected final void setParams(Map<String,String> params,
             String originalURL)

dealWithSpecificParams

protected void dealWithSpecificParams(Map<String,String> params,
                          String originalURL)

Deal with specific parameters first so that we can remove them before dealing with extra params. Sub-classes override to provide support for their specific parameters.

Parameters:

params - name-value map of the URL parameters

originalURL - a String reprensenting the URL we are working with

getRawParameterValueFor

protected String getRawParameterValueFor(Map params,
                             String parameterName)

getMode

public org.gatein.pc.api.Mode getMode()

Specified by:

getMode in interface org.gatein.pc.api.ContainerURL

getWindowState

public org.gatein.pc.api.WindowState getWindowState()

Specified by:

getWindowState in interface org.gatein.pc.api.ContainerURL

isSecure

public boolean isSecure()

getURLType

protected abstract String getURLType()

toString

public String toString()

Overrides:

toString in class Object

appendExtraParams

protected void appendExtraParams(StringBuffer buffer)

appendEnd

protected abstract void appendEnd(StringBuffer sb)

createURLParameter

protected final void createURLParameter(StringBuffer sb,
                      String name,
                      String value)

setExtra

public void setExtra(String extra)

getNavigationalState

public org.gatein.pc.api.StateString getNavigationalState()

Specified by:

getNavigationalState in interface org.gatein.pc.api.ContainerURL

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface org.gatein.pc.api.ContainerURL