|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ConsumerCapabilities
The consumer capababilities provides access to consumer related information.
| Method Summary | |
|---|---|
java.lang.String[] |
getCharacterEncodingSet()
Get the character sets the consumer wants the remote portlet to use for encoding the markup. |
java.lang.String |
getConsumerAgent()
Get the name of the consumer |
java.lang.String[] |
getMimeTypes()
Get an array of mime types which are supported by the consumer. |
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. |
java.lang.String[] |
getSupportedLocales()
Get the locales which are supported by the consumer. |
java.lang.String[] |
getSupportedModes()
Get the portlet modes the consumer is willing to manage. |
java.lang.String[] |
getSupportedWindowStates()
Get the window states the consumer is willing to manage. |
java.lang.String |
getUserAuthentication()
Get the method which is used by the consumer to authenticate its users. |
void |
setCharacterEncodingSet(java.lang.String[] charEncoding)
Set the character set the consumer wants the remote portlet to use for encoding the markup. |
void |
setConsumerAgent(java.lang.String name)
Set the name of the consumer |
void |
setMimeTypes(java.lang.String[] mimeTypes)
Set the mime types the consumer supports The order in the array defines the order of preference of the consumer. |
void |
setPortletStateChange(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(java.lang.String[] locales)
Set the locales which are supported by the consumer. |
void |
setSupportedModes(java.lang.String[] modes)
Set the portlet modes which are supported by the consumer. |
void |
setSupportedWindowStates(java.lang.String[] states)
Set the window states which are supported by the consumer. |
void |
setUserAuthentication(java.lang.String authMethod)
Set the method of end user authentication used by the consumer.. |
| Method Detail |
|---|
java.lang.String getConsumerAgent()
java.lang.String getUserAuthentication()
java.lang.String[] getSupportedLocales()
java.lang.String[] getSupportedModes()
java.lang.String[] getSupportedWindowStates()
StateChange getPortletStateChange()
java.lang.String[] getCharacterEncodingSet()
java.lang.String[] getMimeTypes()
void setConsumerAgent(java.lang.String name)
name - The new name of the consumervoid setUserAuthentication(java.lang.String authMethod)
authMethod - indicating how end-users are authenticated by the consumer.void setMimeTypes(java.lang.String[] mimeTypes)
mimeTypes - An array of mimes types the consumer supports.void setSupportedLocales(java.lang.String[] locales)
locales - Array of string representations of supported localesvoid setSupportedModes(java.lang.String[] modes)
modes - Array of string representations of portlet modesvoid setSupportedWindowStates(java.lang.String[] states)
states - Array of string representations of window statesvoid setPortletStateChange(StateChange portletStateChange)
portletStateChange - A flag with one of the following values:
StateChange.OK, StateChange.Clone, StateChange.Faultvoid setCharacterEncodingSet(java.lang.String[] charEncoding)
charEncoding - Array of string representations of the character encoding.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||