|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.wsrp4j.consumer.driver.PortletDriverImpl
public class PortletDriverImpl
This class implements a portlet driver
| Constructor Summary | |
|---|---|
PortletDriverImpl(WSRPPortlet portlet,
ConsumerEnvironment consumerEnv)
|
|
| Method Summary | |
|---|---|
PortletContext |
clonePortlet(java.lang.String userID)
Clone the portlet |
DestroyPortletsResponse |
destroyPortlets(java.lang.String[] portletHandles,
java.lang.String userID)
Destroy the producer portlets specified in the entiyHandles array. |
MarkupResponse |
getMarkup(MarkupRequest markupRequest,
java.lang.String userID)
This method is used to retrieve the markup generated by the portlet instance. |
WSRPPortlet |
getPortlet()
Get the portlet this driver is bind to. |
PortletDescriptionResponse |
getPortletDescription(java.lang.String userID,
java.lang.String[] desiredLocales)
Fetches information about the portlet from the producer. |
PropertyList |
getPortletProperties(java.lang.String[] names,
java.lang.String userID)
Get the current values of the properties with the given names. |
PortletPropertyDescriptionResponse |
getPortletPropertyDescription(java.lang.String userID)
Fetches all published properties of an remote portlet. |
void |
initCookie()
Actual WSRP initCookie() call |
BlockingInteractionResponse |
performBlockingInteraction(InteractionRequest actionRequest,
java.lang.String userID)
This method is used to perform a blocking interaction on the portlet instance. |
ReturnAny |
releaseSessions(java.lang.String[] sessionIDs,
java.lang.String userID)
Inform the producer that the sessions specified in the sessionIDs array will no longer be used by the consumer and can therefor be released. |
PortletContext |
setPortletProperties(PropertyList properties,
java.lang.String userID)
Set the portlet properties specified in the property list |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PortletDriverImpl(WSRPPortlet portlet,
ConsumerEnvironment consumerEnv)
throws WSRPException
WSRPException| Method Detail |
|---|
public WSRPPortlet getPortlet()
getPortlet in interface PortletDriver
public MarkupResponse getMarkup(MarkupRequest markupRequest,
java.lang.String userID)
throws WSRPException
getMarkup in interface PortletDrivermarkupRequest - userID -
WSRPException
public BlockingInteractionResponse performBlockingInteraction(InteractionRequest actionRequest,
java.lang.String userID)
throws WSRPException
performBlockingInteraction in interface PortletDriveractionRequest -
WSRPException
public PortletContext clonePortlet(java.lang.String userID)
throws WSRPException
clonePortlet in interface PortletDriverWSRPException
public DestroyPortletsResponse destroyPortlets(java.lang.String[] portletHandles,
java.lang.String userID)
throws WSRPException
destroyPortlets in interface PortletDriverWSRPException
public ReturnAny releaseSessions(java.lang.String[] sessionIDs,
java.lang.String userID)
throws WSRPException
releaseSessions in interface PortletDriverWSRPException
public void initCookie()
throws WSRPException
initCookie in interface PortletDriverWSRPException
public PortletDescriptionResponse getPortletDescription(java.lang.String userID,
java.lang.String[] desiredLocales)
throws WSRPException
getPortletDescription in interface PortletDriveruserID - is used to get the user context of the user from the user registrydesiredLocales - Array of locales the description should be provided
WSRPException
public PortletPropertyDescriptionResponse getPortletPropertyDescription(java.lang.String userID)
throws WSRPException
getPortletPropertyDescription in interface PortletDriveruserID - The ID of the user this request is done for
WSRPException
public PropertyList getPortletProperties(java.lang.String[] names,
java.lang.String userID)
throws WSRPException
getPortletProperties in interface PortletDrivernames - The names of the propertiesuserID - The ID of the user is used to get the user context
WSRPException
public PortletContext setPortletProperties(PropertyList properties,
java.lang.String userID)
throws WSRPException
setPortletProperties in interface PortletDriverproperties - List of properties to be set.userID - The ID of the user is used to get the user context
WSRPException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||