org.exoplatform.services.wsrp2.consumer.adapters
Class WSRPBaseRequestAdapter

java.lang.Object
  org.exoplatform.services.wsrp2.consumer.adapters.WSRPBaseRequestAdapter

All Implemented Interfaces:

WSRPBaseRequest

Direct Known Subclasses:

WSRPEventsRequestAdapter, WSRPInteractionRequestAdapter, WSRPMarkupRequestAdapter, WSRPResourceRequestAdapter

public class WSRPBaseRequestAdapter
extends java.lang.Object
implements WSRPBaseRequest

Constructor Summary

WSRPBaseRequestAdapter()

Method Summary

ClientData	getClientData() Get the ClientData structure which carries information about the end user agent.
Extension[]	getExtensions()
java.lang.String[]	getLocales() Get the locales which are supported by the portlet according to the client connecting to it.
java.lang.String[]	getMarkupCharacterSets() Get the character sets the consumer wants the remote portlet to use for encoding the markup.
java.lang.String[]	getMimeTypes() Get an array of mime types which are supported by the end user device.
java.lang.String	getMode() Get the current mode of the portlet
java.lang.String	getNavigationalState() Get the current navigational state of the portlet
NamedString[]	getNavigationalValues() Get the current navigational values of the portlet
java.lang.String	getPortletInstanceKey() Get an opaque string which corresponds to a unique reference to this use of the portlet.
java.lang.String	getSessionID() Get the ID of the session context
java.lang.String	getUserAuthentication() Get the method which is used by the consumer to authenticate its users.
java.lang.String	getValidateTag()
java.lang.String[]	getValidNewModes() Get the list of wsrp modes which are supported by the portlet.
java.lang.String[]	getValidNewWindowStates() Get the list of wsrp window states which are supported by the portlet.
java.lang.String	getWindowState() Get the current window state of the portlet
boolean	isModeSupported(java.lang.String wsrpMode) Checks wether a given wsrp mode is supported by the portlet.
boolean	isSecureClientCommunication()
boolean	isWindowStateSupported(java.lang.String wsrpWindowState) Checks wether a given wsrp window state is supported by the portlet.
void	setClientData(ClientData clientData)
void	setExtensions(Extension[] extensions)
void	setLocales(java.lang.String[] locales)
void	setMarkupCharacterSets(java.lang.String[] markupCharacterSets)
void	setMimeTypes(java.lang.String[] mimeTypes)
void	setMode(java.lang.String mode)
void	setNavigationalState(java.lang.String navigationalState)
void	setNavigationalValues(NamedString[] navigationalValues)
void	setPortletInstanceKey(java.lang.String portletInstanceKey)
void	setSecureClientCommunication(boolean secureClientCommunication)
void	setSessionID(java.lang.String sessionID)
void	setUserAuthentication(java.lang.String userAuthentication)
void	setValidateTag(java.lang.String validateTag)
void	setValidNewModes(java.lang.String[] validNewModes)
void	setValidNewWindowStates(java.lang.String[] validNewWindowStates)
void	setWindowState(java.lang.String windowState)

Methods inherited from class java.lang.Object

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

Constructor Detail

WSRPBaseRequestAdapter

public WSRPBaseRequestAdapter()

Method Detail

getSessionID

public java.lang.String getSessionID()

Description copied from interface: WSRPBaseRequest

Get the ID of the session context

Specified by:

getSessionID in interface WSRPBaseRequest

Returns:

The session context

setSessionID

public void setSessionID(java.lang.String sessionID)

getPortletInstanceKey

public java.lang.String getPortletInstanceKey()

Description copied from interface: WSRPBaseRequest

Get an opaque string which corresponds to a unique reference to this use of the portlet.

Specified by:

getPortletInstanceKey in interface WSRPBaseRequest

Returns:

The portlet instance key

setPortletInstanceKey

public void setPortletInstanceKey(java.lang.String portletInstanceKey)

getNavigationalState

public java.lang.String getNavigationalState()

Description copied from interface: WSRPBaseRequest

Get the current navigational state of the portlet

Specified by:

getNavigationalState in interface WSRPBaseRequest

Returns:

The navigational state

setNavigationalState

public void setNavigationalState(java.lang.String navigationalState)

getWindowState

public java.lang.String getWindowState()

Description copied from interface: WSRPBaseRequest

Get the current window state of the portlet

Specified by:

getWindowState in interface WSRPBaseRequest

Returns:

The window state

setWindowState

public void setWindowState(java.lang.String windowState)

getMode

public java.lang.String getMode()

Description copied from interface: WSRPBaseRequest

Get the current mode of the portlet

Specified by:

getMode in interface WSRPBaseRequest

Returns:

The mode of the portlet

setMode

public void setMode(java.lang.String mode)

getClientData

public ClientData getClientData()

Description copied from interface: WSRPBaseRequest

Get the ClientData structure which carries information about the end user agent.

Specified by:

getClientData in interface WSRPBaseRequest

Returns:

The ClientData specifying the user agent.

setClientData

public void setClientData(ClientData clientData)

getLocales

public java.lang.String[] getLocales()

Description copied from interface: WSRPBaseRequest

Get the locales which are supported by the portlet according to the client connecting to it. The Locales returned are in the form of (ISO-639 + "-" + ISO-3166)

Specified by:

getLocales in interface WSRPBaseRequest

Returns:

Array with string representations of the locales which are supported by the consumer

setLocales

public void setLocales(java.lang.String[] locales)

getValidNewModes

public java.lang.String[] getValidNewModes()

Description copied from interface: WSRPBaseRequest

Get the list of wsrp modes which are supported by the portlet. This should returned the list of all actuall supported modes and not necessarily the modes returned in the portlet description of the producer.

Specified by:

getValidNewModes in interface WSRPBaseRequest

Returns:

Array with string representations of the portlet modes supported by the portlet or null

setValidNewModes

public void setValidNewModes(java.lang.String[] validNewModes)

getValidNewWindowStates

public java.lang.String[] getValidNewWindowStates()

Description copied from interface: WSRPBaseRequest

Get the list of wsrp window states which are supported by the portlet. This should returned the list of all actuall supported window states and not necessarily the window states returned in the portlet description of the producer.

Specified by:

getValidNewWindowStates in interface WSRPBaseRequest

Returns:

Array with string representations of the window states supported by the portlet or null

setValidNewWindowStates

public void setValidNewWindowStates(java.lang.String[] validNewWindowStates)

getMimeTypes

public java.lang.String[] getMimeTypes()

Description copied from interface: WSRPBaseRequest

Get an array of mime types which are supported by the end user device. The order in the array defines the order of preference of the end user.

Specified by:

getMimeTypes in interface WSRPBaseRequest

Returns:

An array of mimes types the consumer supports or null

setMimeTypes

public void setMimeTypes(java.lang.String[] mimeTypes)

getMarkupCharacterSets

public java.lang.String[] getMarkupCharacterSets()

Description copied from interface: WSRPBaseRequest

Get the character sets the consumer wants the remote portlet to use for encoding the markup. Valid character sets are defined here

Specified by:

getMarkupCharacterSets in interface WSRPBaseRequest

Returns:

Array of string representations of the character encoding.

setMarkupCharacterSets

public void setMarkupCharacterSets(java.lang.String[] markupCharacterSets)

isModeSupported

public boolean isModeSupported(java.lang.String wsrpMode)

Description copied from interface: WSRPBaseRequest

Checks wether a given wsrp mode is supported by the portlet.

Specified by:

isModeSupported in interface WSRPBaseRequest

Parameters:

wsrpMode - The wsrp mode

Returns:

True if the mode is supported by the portlet, false otherwise

isWindowStateSupported

public boolean isWindowStateSupported(java.lang.String wsrpWindowState)

Description copied from interface: WSRPBaseRequest

Checks wether a given wsrp window state is supported by the portlet.

Specified by:

isWindowStateSupported in interface WSRPBaseRequest

Parameters:

wsrpWindowState - The wsrp window state

Returns:

True if the window state is supported by the portlet, false otherwise

getNavigationalValues

public NamedString[] getNavigationalValues()

Description copied from interface: WSRPBaseRequest

Get the current navigational values of the portlet

Specified by:

getNavigationalValues in interface WSRPBaseRequest

Returns:

The navigational values

setNavigationalValues

public void setNavigationalValues(NamedString[] navigationalValues)

getValidateTag

public java.lang.String getValidateTag()

Specified by:

getValidateTag in interface WSRPBaseRequest

setValidateTag

public void setValidateTag(java.lang.String validateTag)

getExtensions

public Extension[] getExtensions()

Specified by:

getExtensions in interface WSRPBaseRequest

setExtensions

public void setExtensions(Extension[] extensions)

isSecureClientCommunication

public boolean isSecureClientCommunication()

Specified by:

isSecureClientCommunication in interface WSRPBaseRequest

setSecureClientCommunication

public void setSecureClientCommunication(boolean secureClientCommunication)

getUserAuthentication

public java.lang.String getUserAuthentication()

Description copied from interface: WSRPBaseRequest

Get the method which is used by the consumer to authenticate its users.

Specified by:

getUserAuthentication in interface WSRPBaseRequest

Returns:

String indicating how end-users were authenticated by the consumer.

setUserAuthentication

public void setUserAuthentication(java.lang.String userAuthentication)