|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.wsrp4j.consumer.driver.GenericConsumerEnvironment
public abstract class GenericConsumerEnvironment
| Constructor Summary | |
|---|---|
GenericConsumerEnvironment()
|
|
| 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. |
PortletDriverRegistry |
getPortletDriverRegistry()
Get the portlet driver registry of the consumer. |
PortletRegistry |
getPortletRegistry()
Get the portlet registry of 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. |
ProducerRegistry |
getProducerRegistry()
Get the producer registry of the consumer. |
SessionHandler |
getSessionHandler()
Get the session handler of the consumer. |
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. |
URLTemplateComposer |
getTemplateComposer()
Get the url template composer for template proccessing |
URLRewriter |
getURLRewriter()
Get the url rewriter for consumer url-rewriting |
java.lang.String |
getUserAuthentication()
Get the method which is used by the consumer to authenticate its users. |
UserRegistry |
getUserRegistry()
Get the user registry of the consumer. |
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 |
setPortletDriverRegistry(PortletDriverRegistry portletDriverRegistry)
Set the portlet driver registry of the consumer. |
void |
setPortletRegistry(PortletRegistry portletRegistry)
Set the portlet registry 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 |
setProducerRegistry(ProducerRegistry producerRegistry)
Set the producer registry of the consumer. |
void |
setSessionHandler(SessionHandler sessionHandler)
Set the session handler of the consumer. |
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 |
setTemplateComposer(URLTemplateComposer templateComposer)
Set the url template composer for template proccessing |
void |
setURLRewriter(URLRewriter urlRewriter)
Set the url rewriter for consumer url-rewriting |
void |
setUserAuthentication(java.lang.String authMethod)
Set the method of end user authentication used by the consumer.. |
void |
setUserRegistry(UserRegistry userRegistry)
Set the user registry of the consumer. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public GenericConsumerEnvironment()
| Method Detail |
|---|
public java.lang.String getConsumerAgent()
getConsumerAgent in interface ConsumerCapabilitiespublic void setConsumerAgent(java.lang.String name)
setConsumerAgent in interface ConsumerCapabilitiesname - The new name of the consumerpublic java.lang.String[] getSupportedLocales()
getSupportedLocales in interface ConsumerCapabilitiespublic void setSupportedLocales(java.lang.String[] locales)
setSupportedLocales in interface ConsumerCapabilitieslocales - Array of String representations of the supported localespublic java.lang.String[] getSupportedModes()
getSupportedModes in interface ConsumerCapabilitiespublic void setSupportedModes(java.lang.String[] modes)
setSupportedModes in interface ConsumerCapabilitiesmodes - Array of string representations of portlet modespublic java.lang.String[] getSupportedWindowStates()
getSupportedWindowStates in interface ConsumerCapabilitiespublic void setSupportedWindowStates(java.lang.String[] states)
setSupportedWindowStates in interface ConsumerCapabilitiesstates - Array of string representations of window statespublic StateChange getPortletStateChange()
getPortletStateChange in interface ConsumerCapabilitiespublic void setPortletStateChange(StateChange portletStateChange)
setPortletStateChange in interface ConsumerCapabilitiesportletStateChange - A flag with one of the following values (OK, Clone, Fault)public java.lang.String[] getCharacterEncodingSet()
getCharacterEncodingSet in interface ConsumerCapabilitiespublic void setCharacterEncodingSet(java.lang.String[] charEncoding)
setCharacterEncodingSet in interface ConsumerCapabilitiescharEncoding - Array of string representations of the character encoding.public java.lang.String[] getMimeTypes()
getMimeTypes in interface ConsumerCapabilitiespublic void setMimeTypes(java.lang.String[] mimeTypes)
setMimeTypes in interface ConsumerCapabilitiesmimeTypes - An array of mimes types the consumer supports.public java.lang.String getUserAuthentication()
getUserAuthentication in interface ConsumerCapabilitiespublic void setUserAuthentication(java.lang.String authMethod)
setUserAuthentication in interface ConsumerCapabilitiesauthMethod - String indicating how end-users are authenticated by the consumer.public UserRegistry getUserRegistry()
getUserRegistry in interface Consumerpublic void setUserRegistry(UserRegistry userRegistry)
userRegistry - The consumer specific user registrypublic ProducerRegistry getProducerRegistry()
getProducerRegistry in interface Consumerpublic void setProducerRegistry(ProducerRegistry producerRegistry)
producerRegistry - The consumer specific producer registrypublic PortletRegistry getPortletRegistry()
getPortletRegistry in interface Consumerpublic void setPortletRegistry(PortletRegistry portletRegistry)
portletRegistry - The consumer specific portlet registrypublic PortletDriverRegistry getPortletDriverRegistry()
getPortletDriverRegistry in interface Consumerpublic void setPortletDriverRegistry(PortletDriverRegistry portletDriverRegistry)
portletDriverRegistry - The consumer specific portlet driver registrypublic SessionHandler getSessionHandler()
getSessionHandler in interface Consumerpublic void setSessionHandler(SessionHandler sessionHandler)
sessionHandler - The consumer specific session handlerpublic URLTemplateComposer getTemplateComposer()
getTemplateComposer in interface Consumerpublic void setTemplateComposer(URLTemplateComposer templateComposer)
templateComposer - The consumer specific template composerpublic URLRewriter getURLRewriter()
getURLRewriter in interface Consumerpublic void setURLRewriter(URLRewriter urlRewriter)
urlRewriter - The consumer specific url rewriter
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||