org.gatein.wsrp

Class WSRPUtils

java.lang.Object

org.gatein.wsrp.WSRPUtils

public class WSRPUtils
extends Object

Since:

2.4

Version:

$Revision: 11351 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WSRPUtils.AbsoluteURLReplacementGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEACTIVATE_URL_REWRITING
static Set<org.gatein.pc.api.Mode>	DEFAULT_JSR168_MODES
static Set<org.gatein.pc.api.WindowState>	DEFAULT_JSR168_WINDOWSTATES

Method Summary

Methods

Modifier and Type	Method and Description
static void	addMultiValuedValueTo(Map<String,String[]> paramMap, String paramName, String paramValue)
static String	convertJSR168PortletModeNameToWSRPName(String jsr168PortletModeName)
static String	convertJSR168WindowStateNameToWSRPName(String jsr168WindowStateName)
static List<String>	convertLocalesToRFC3066LanguageTags(List<Locale> localesOrderedByPreference)
static String	convertRequestAuthTypeToWSRPAuthType(String authType)
static org.gatein.common.i18n.LocalizedString	convertToCommonLocalizedStringOrNull(LocalizedString wsrpLocalizedString)
static org.gatein.pc.api.PortletContext	convertToPortalPortletContext(PortletContext portletContext)
static org.gatein.pc.api.PortletContext	convertToPortalPortletContext(String portletHandle, byte[] state)
static PropertyDescription	convertToPropertyDescription(RegistrationPropertyDescription propertyDescription)
static LocalizedString	convertToRegistrationLocalizedString(LocalizedString wsrpLocalizedString)
static RegistrationPropertyDescription	convertToRegistrationPropertyDescription(PropertyDescription propertyDescription)
static LocalizedString	convertToWSRPLocalizedString(LocalizedString regLocalizedString)
static PortletContext	convertToWSRPPortletContext(org.gatein.pc.api.PortletContext portletContext)
static Map<String,String[]>	createPublicNSFrom(List<NamedString> publicParams)
static Map<String,String[]>	decodePublicNS(String paramValue)
static String	encodePublicNS(Map<String,String[]> publicNSChanges) Encodes the public NS according to the rules found at http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-os-01.html#_wsrp-navigationalValues
static String	getAbsoluteURLFor(String url, boolean checkWSRPToken, String serverAddress)
static org.gatein.pc.api.state.AccessMode	getAccessModeFromStateChange(StateChange stateChange)
static org.gatein.pc.api.cache.CacheLevel	getCacheLevelFromResourceCacheability(String resourceCacheability)
static org.gatein.pc.api.Mode	getJSR168PortletModeFromWSRPName(String wsrpPortletModeName)
static org.gatein.pc.api.WindowState	getJSR168WindowStateFromWSRPName(String wsrpWindowStateName)
static Locale	getLocale(String lang)
static PropertyAccessor	getPropertyAccessor()
static String	getResourceCacheabilityFromCacheLevel(org.gatein.pc.api.cache.CacheLevel cacheLevel)
static StateChange	getStateChangeFromAccessMode(org.gatein.pc.api.state.AccessMode accessMode)
static byte[]	getStateOrNullFor(org.gatein.pc.api.PortletContext portletContext)
static String	getWSRPNameFromJSR168PortletMode(org.gatein.pc.api.Mode portletMode)
static String	getWSRPNameFromJSR168WindowState(org.gatein.pc.api.WindowState windowState)
static boolean	isDefaultWSRPMode(String wsrpPortletModeName)
static boolean	isDefaultWSRPWindowState(String wsrpWindowStateName)
static <T> boolean	isSingletonListWithNullOrEmptyElement(List<T> list)
static <T> List<T>	replaceByEmptyListIfNeeded(List<T> list)
static void	setStrict(boolean strict)
static String	toString(InteractionParams interactionParams) Debugging method
static String	toString(Locale locale)
static String	toString(MarkupParams params) Debugging method.
static <F,T> List<T>	transform(List<F> fromList, com.google.common.base.Function<? super F,? extends T> function) Todo: Should be moved to common module?

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JSR168_MODES

public static final Set<org.gatein.pc.api.Mode> DEFAULT_JSR168_MODES

DEFAULT_JSR168_WINDOWSTATES

public static final Set<org.gatein.pc.api.WindowState> DEFAULT_JSR168_WINDOWSTATES

DEACTIVATE_URL_REWRITING

public static final String DEACTIVATE_URL_REWRITING

See Also:

Constant Field Values

Method Detail

setStrict

public static void setStrict(boolean strict)

getJSR168WindowStateFromWSRPName

public static org.gatein.pc.api.WindowState getJSR168WindowStateFromWSRPName(String wsrpWindowStateName)

isDefaultWSRPWindowState

public static boolean isDefaultWSRPWindowState(String wsrpWindowStateName)

convertJSR168WindowStateNameToWSRPName

public static String convertJSR168WindowStateNameToWSRPName(String jsr168WindowStateName)

getWSRPNameFromJSR168WindowState

public static String getWSRPNameFromJSR168WindowState(org.gatein.pc.api.WindowState windowState)

getJSR168PortletModeFromWSRPName

public static org.gatein.pc.api.Mode getJSR168PortletModeFromWSRPName(String wsrpPortletModeName)

isDefaultWSRPMode

public static boolean isDefaultWSRPMode(String wsrpPortletModeName)

convertJSR168PortletModeNameToWSRPName

public static String convertJSR168PortletModeNameToWSRPName(String jsr168PortletModeName)

getWSRPNameFromJSR168PortletMode

public static String getWSRPNameFromJSR168PortletMode(org.gatein.pc.api.Mode portletMode)

getAccessModeFromStateChange

public static org.gatein.pc.api.state.AccessMode getAccessModeFromStateChange(StateChange stateChange)

getStateChangeFromAccessMode

public static StateChange getStateChangeFromAccessMode(org.gatein.pc.api.state.AccessMode accessMode)

convertRequestAuthTypeToWSRPAuthType

public static String convertRequestAuthTypeToWSRPAuthType(String authType)

convertLocalesToRFC3066LanguageTags

public static List<String> convertLocalesToRFC3066LanguageTags(List<Locale> localesOrderedByPreference)

convertToPortalPortletContext

public static org.gatein.pc.api.PortletContext convertToPortalPortletContext(PortletContext portletContext)

convertToPortalPortletContext

public static org.gatein.pc.api.PortletContext convertToPortalPortletContext(String portletHandle,
                                                             byte[] state)

convertToWSRPPortletContext

public static PortletContext convertToWSRPPortletContext(org.gatein.pc.api.PortletContext portletContext)

Parameters:

portletContext -

Returns:

Since 2.6

getStateOrNullFor

public static byte[] getStateOrNullFor(org.gatein.pc.api.PortletContext portletContext)

getResourceCacheabilityFromCacheLevel

public static String getResourceCacheabilityFromCacheLevel(org.gatein.pc.api.cache.CacheLevel cacheLevel)

getCacheLevelFromResourceCacheability

public static org.gatein.pc.api.cache.CacheLevel getCacheLevelFromResourceCacheability(String resourceCacheability)

getLocale

public static Locale getLocale(String lang)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

toString

public static String toString(Locale locale)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

toString

public static String toString(MarkupParams params)

Debugging method.

Parameters:

params -

Returns:

Since:

2.6

toString

public static String toString(InteractionParams interactionParams)

Debugging method

Parameters:

interactionParams -

Returns:

Since:

2.6

convertToRegistrationPropertyDescription

public static RegistrationPropertyDescription convertToRegistrationPropertyDescription(PropertyDescription propertyDescription)

Parameters:

propertyDescription -

Returns:

Since:

2.6

convertToPropertyDescription

public static PropertyDescription convertToPropertyDescription(RegistrationPropertyDescription propertyDescription)

convertToWSRPLocalizedString

public static LocalizedString convertToWSRPLocalizedString(LocalizedString regLocalizedString)

convertToRegistrationLocalizedString

public static LocalizedString convertToRegistrationLocalizedString(LocalizedString wsrpLocalizedString)

Parameters:

wsrpLocalizedString -

Returns:

Since:

2.6

getAbsoluteURLFor

public static String getAbsoluteURLFor(String url,
                       boolean checkWSRPToken,
                       String serverAddress)

transform

public static <F,T> List<T> transform(List<F> fromList,
                      com.google.common.base.Function<? super F,? extends T> function)

Todo: Should be moved to common module?

Type Parameters:

F -

T -

Parameters:

fromList -

function -

Returns:

convertToCommonLocalizedStringOrNull

public static org.gatein.common.i18n.LocalizedString convertToCommonLocalizedStringOrNull(LocalizedString wsrpLocalizedString)

createPublicNSFrom

public static Map<String,String[]> createPublicNSFrom(List<NamedString> publicParams)

addMultiValuedValueTo

public static void addMultiValuedValueTo(Map<String,String[]> paramMap,
                         String paramName,
                         String paramValue)

encodePublicNS

public static String encodePublicNS(Map<String,String[]> publicNSChanges)

Encodes the public NS according to the rules found at http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-os-01.html#_wsrp-navigationalValues

Parameters:

publicNSChanges -

Returns:

decodePublicNS

public static Map<String,String[]> decodePublicNS(String paramValue)

getPropertyAccessor

public static PropertyAccessor getPropertyAccessor()

replaceByEmptyListIfNeeded

public static <T> List<T> replaceByEmptyListIfNeeded(List<T> list)

isSingletonListWithNullOrEmptyElement

public static <T> boolean isSingletonListWithNullOrEmptyElement(List<T> list)