org.exoplatform.services.wsrp.consumer
Interface ConsumerCapabilities

All Known Subinterfaces:

ConsumerEnvironment

All Known Implementing Classes:

ConsumerEnvironmentImpl

public interface ConsumerCapabilities

The consumer capababilities provides access to consumer related information.

Author:

Peter Fischer, Benjamin Mestrallet

Method Summary

String[]	getCharacterEncodingSet() Get the character sets the consumer wants the remote portlet to use for encoding the markup.
String	getConsumerAgent() Get the name of the consumer
String[]	getMimeTypes() Get an array of mime types which are supported by the consumer.
org.exoplatform.services.wsrp.type.StateChange	getPortletStateChange() Returns a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.
String[]	getSupportedLocales() Get the locales which are supported by the consumer.
String[]	getSupportedModes() Get the portlet modes the consumer is willing to manage.
String[]	getSupportedWindowStates() Get the window states the consumer is willing to manage.
String	getUserAuthentication() Get the method which is used by the consumer to authenticate its users.
void	setCharacterEncodingSet(String[] charEncoding) Set the character set the consumer wants the remote portlet to use for encoding the markup.
void	setConsumerAgent(String name) Set the name of the consumer
void	setMimeTypes(String[] mimeTypes) Set the mime types the consumer supports The order in the array defines the order of preference of the consumer.
void	setPortletStateChange(org.exoplatform.services.wsrp.type.StateChange portletStateChange) Set a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.
void	setSupportedLocales(String[] locales) Set the locales which are supported by the consumer.
void	setSupportedModes(String[] modes) Set the portlet modes which are supported by the consumer.
void	setSupportedWindowStates(String[] states) Set the window states which are supported by the consumer.
void	setUserAuthentication(String authMethod) Set the method of end user authentication used by the consumer..

Method Detail

getConsumerAgent

String getConsumerAgent()

Get the name of the consumer

Returns:

The name of the consumer

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.

getSupportedLocales

String[] getSupportedLocales()

Get the locales which are supported by the consumer. (ISO-639 + "_" + ISO-3166)

Returns:

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

getSupportedModes

String[] getSupportedModes()

Get the portlet modes the consumer is willing to manage.

Returns:

Array with string representations of the portlet modes which are supported by the consumer

getSupportedWindowStates

String[] getSupportedWindowStates()

Get the window states the consumer is willing to manage.

Returns:

Array with string representations of the window states which are supported by the consumer

getPortletStateChange

org.exoplatform.services.wsrp.type.StateChange getPortletStateChange()

Returns a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.

Returns:

A flag

getCharacterEncodingSet

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.

getMimeTypes

String[] getMimeTypes()

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

Returns:

An array of mimes types the consumer supports.

setConsumerAgent

void setConsumerAgent(String name)

Set the name of the consumer

Parameters:

name - The new name of the consumer

setUserAuthentication

void setUserAuthentication(String authMethod)

Set the method of end user authentication used by the consumer..

setMimeTypes

void setMimeTypes(String[] mimeTypes)

Set the mime types the consumer supports The order in the array defines the order of preference of the consumer.

setSupportedLocales

void setSupportedLocales(String[] locales)

Set the locales which are supported by the consumer. Pattern: ISO-639 + "_" + ISO-3166

Parameters:

locales - Array of string representations of supported locales

setSupportedModes

void setSupportedModes(String[] modes)

Set the portlet modes which are supported by the consumer.

Parameters:

modes - Array of string representations of portlet modes

setSupportedWindowStates

void setSupportedWindowStates(String[] states)

Set the window states which are supported by the consumer.

setPortletStateChange

void setPortletStateChange(org.exoplatform.services.wsrp.type.StateChange portletStateChange)

Set a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.

Parameters:

portletStateChange - A flag with one of the following values: StateChange.OK, StateChange.Clone, StateChange.Fault

setCharacterEncodingSet

void setCharacterEncodingSet(String[] charEncoding)

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

Parameters:

charEncoding - Array of string representations of the character encoding.