org.exoplatform.services.wsrp2.consumer
Interface WSRPBaseRequest

All Known Subinterfaces:

WSRPEventsRequest, WSRPInteractionRequest, WSRPMarkupRequest, WSRPResourceRequest

All Known Implementing Classes:

WSRPBaseRequestAdapter, WSRPEventsRequestAdapter, WSRPInteractionRequestAdapter, WSRPMarkupRequestAdapter, WSRPResourceRequestAdapter

public interface WSRPBaseRequest

The WSRPRequest is the base interface for all requests to a consumer side invocation of a integrated remote portlet. Specialized interfaces exist for markup and action calls.

Author:

Benjamin Mestrallet

See Also:

WSRPMarkupRequest, WSRPInteractionRequest

Method Summary

org.exoplatform.services.wsrp2.type.ClientData	getClientData() Get the ClientData structure which carries information about the end user agent.
org.exoplatform.services.wsrp2.type.Extension[]	getExtensions()
String[]	getLocales() Get the locales which are supported by the portlet according to the client connecting to it.
String[]	getMarkupCharacterSets() Get the character sets the consumer wants the remote portlet to use for encoding the markup.
String[]	getMimeTypes() Get an array of mime types which are supported by the end user device.
String	getMode() Get the current mode of the portlet
String	getNavigationalState() Get the current navigational state of the portlet
org.exoplatform.services.wsrp2.type.NamedString[]	getNavigationalValues() Get the current navigational values of the portlet
String	getPortletInstanceKey() Get an opaque string which corresponds to a unique reference to this use of the portlet.
String	getSessionID() Get the ID of the session context
String	getUserAuthentication() Get the method which is used by the consumer to authenticate its users.
String	getValidateTag()
String[]	getValidNewModes() Get the list of wsrp modes which are supported by the portlet.
String[]	getValidNewWindowStates() Get the list of wsrp window states which are supported by the portlet.
String	getWindowState() Get the current window state of the portlet
boolean	isModeSupported(String wsrpMode) Checks wether a given wsrp mode is supported by the portlet.
boolean	isSecureClientCommunication()
boolean	isWindowStateSupported(String wsrpWindowState) Checks wether a given wsrp window state is supported by the portlet.

Method Detail

getSessionID

String getSessionID()

Get the ID of the session context

Returns:

The session context

getPortletInstanceKey

String getPortletInstanceKey()

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

Returns:

The portlet instance key

getNavigationalState

String getNavigationalState()

Get the current navigational state of the portlet

Returns:

The navigational state

getNavigationalValues

org.exoplatform.services.wsrp2.type.NamedString[] getNavigationalValues()

Get the current navigational values of the portlet

Returns:

The navigational values

getWindowState

String getWindowState()

Get the current window state of the portlet

Returns:

The window state

getMode

String getMode()

Get the current mode of the portlet

Returns:

The mode of the portlet

getClientData

org.exoplatform.services.wsrp2.type.ClientData getClientData()

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

Returns:

The ClientData specifying the user agent.

getLocales

String[] getLocales()

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)

Returns:

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

getValidNewModes

String[] getValidNewModes()

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.

Returns:

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

getValidNewWindowStates

String[] getValidNewWindowStates()

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.

Returns:

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

getMimeTypes

String[] getMimeTypes()

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.

Returns:

An array of mimes types the consumer supports or null

getMarkupCharacterSets

String[] getMarkupCharacterSets()

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

Returns:

Array of string representations of the character encoding.

isModeSupported

boolean isModeSupported(String wsrpMode)

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

Parameters:

wsrpMode - The wsrp mode

Returns:

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

isWindowStateSupported

boolean isWindowStateSupported(String wsrpWindowState)

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

Parameters:

wsrpWindowState - The wsrp window state

Returns:

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

getValidateTag

String getValidateTag()

isSecureClientCommunication

boolean isSecureClientCommunication()

getExtensions

org.exoplatform.services.wsrp2.type.Extension[] getExtensions()

getUserAuthentication

String getUserAuthentication()

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

Returns:

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