org.apache.wsrp4j.consumer
Interface WSRPBaseRequest

All Known Subinterfaces:

InteractionRequest, MarkupRequest

All Known Implementing Classes:

GenericWSRPBaseRequestImpl

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.

See Also:

MarkupRequest, InteractionRequest

Method Summary

java.lang.String[]	getCharacterEncodingSet() Get the character sets the consumer wants the remote portlet to use for encoding the markup.
ClientData	getClientData() Get the ClientData structure which carries information about the end user agent.
java.lang.String[]	getLocales() Get the locales which are supported by the portlet according to the client connecting to it.
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[]	getModes() Get the list of wsrp modes which are supported by the portlet.
java.lang.String	getNavigationalState() Get the current navigational state 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	getWindowState() Get the current window state of the portlet
java.lang.String[]	getWindowStates() Get the list of wsrp window states which are supported by the portlet.
boolean	isModeSupported(java.lang.String wsrpMode) Checks wether a given wsrp mode is supported by the portlet.
boolean	isWindowStateSupported(java.lang.String wsrpWindowState) Checks wether a given wsrp window state is supported by the portlet.

Method Detail

getSessionID

public java.lang.String getSessionID()

Get the ID of the session context

Returns:

The session context

getPortletInstanceKey

public java.lang.String getPortletInstanceKey()

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

Returns:

The portlet instance key

getNavigationalState

public java.lang.String getNavigationalState()

Get the current navigational state of the portlet

Returns:

The navigational state

getWindowState

public java.lang.String getWindowState()

Get the current window state of the portlet

Returns:

The window state

getMode

public java.lang.String getMode()

Get the current mode of the portlet

Returns:

The mode of the portlet

getClientData

public ClientData getClientData()

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

Returns:

The ClientData specifying the user agent.

getLocales

public java.lang.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

getModes

public java.lang.String[] getModes()

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

getWindowStates

public java.lang.String[] getWindowStates()

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

public java.lang.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

getCharacterEncodingSet

public java.lang.String[] getCharacterEncodingSet()

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

public boolean isModeSupported(java.lang.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

public boolean isWindowStateSupported(java.lang.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

getUserAuthentication

public java.lang.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.