org.apache.wsrp4j.consumer.driver
Class GenericWSRPBaseRequestImpl

java.lang.Object
  org.apache.wsrp4j.consumer.driver.GenericWSRPBaseRequestImpl

All Implemented Interfaces:

WSRPBaseRequest

public abstract class GenericWSRPBaseRequestImpl

extends java.lang.Object

implements WSRPBaseRequest

Field Summary

protected Logger

logger

Constructor Summary

GenericWSRPBaseRequestImpl()

Method Summary

abstract java.lang.String[]	getCharacterEncodingSet() Get the character sets the consumer wants the remote portlet to use for encoding the markup.
abstract ClientData	getClientData() Get the ClientData structure which carries information about the end user agent.
abstract java.lang.String[]	getLocales() Get the locales which are supported by the portlet according to the client connecting to it.
abstract java.lang.String[]	getMimeTypes() Get an array of mime types which are supported by the end user device.
abstract java.lang.String	getMode() Get the current mode of the portlet
abstract java.lang.String[]	getModes() Get the list of wsrp modes which are supported by the portlet.
abstract java.lang.String	getNavigationalState() Get the current navigational state of the portlet
abstract java.lang.String	getPortletInstanceKey() Get an opaque string which corresponds to a unique reference to this use of the portlet.
abstract java.lang.String	getSessionID() Get the ID of the session context
abstract java.lang.String	getUserAuthentication() Get the method which is used by the consumer to authenticate its users.
abstract java.lang.String	getWindowState() Get the current window state of the portlet
abstract 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.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Logger logger

Constructor Detail

GenericWSRPBaseRequestImpl

public GenericWSRPBaseRequestImpl()

Method Detail

getSessionID

public abstract 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

getPortletInstanceKey

public abstract 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

getNavigationalState

public abstract 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

getWindowState

public abstract 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

getMode

public abstract 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

getClientData

public abstract 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.

getLocales

public abstract 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

getModes

public abstract java.lang.String[] getModes()

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:

getModes in interface WSRPBaseRequest

Returns:

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

getWindowStates

public abstract java.lang.String[] getWindowStates()

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:

getWindowStates in interface WSRPBaseRequest

Returns:

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

getMimeTypes

public abstract 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

getCharacterEncodingSet

public abstract java.lang.String[] getCharacterEncodingSet()

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:

getCharacterEncodingSet in interface WSRPBaseRequest

Returns:

Array of string representations of the character encoding.

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

getUserAuthentication

public abstract 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.