| org.apache.wsrp4j.consumer.PortletDriver
All known Subclasses: org.apache.wsrp4j.consumer.driver.PortletDriverImpl,
| PortletDriver | | public interface PortletDriver (Code) | | The portlet driver is a wrapper for all action which can be performed on an
portlet. There is one portlet driver for all instances of an portlet.
|
| getMarkup | | public MarkupResponse getMarkup(MarkupRequest markupRequest, String userID) throws WSRPException(Code) | | This method is used to retrieve the markup generated by the portlet instance.
Parameters:
markupRequest - The markup request The markup response generated by portlet |
| getPortlet | | public WSRPPortlet getPortlet()(Code) | | Get the portlet this driver is bound to.
The enity |
| getPortletDescription | | public PortletDescriptionResponse getPortletDescription(String userID, String[] desiredLocales) throws WSRPException(Code) | | Fetches information about the portlet from the producer.
Parameters:
userID - is used to get the user context of the user from the user registry
Parameters:
desiredLocales - Array of locales the description should be provided The response to the getPortletDescription call. |
| getPortletProperties | | public PropertyList getPortletProperties(String[] names, String userID) throws WSRPException(Code) | | Get the current values of the properties with the given names.
Parameters:
names - The names of the properties
Parameters:
userID - The ID of the user is used to get the user context A list of properties containing the values and names of the properties. |
| getPortletPropertyDescription | | public PortletPropertyDescriptionResponse getPortletPropertyDescription(String userID) throws WSRPException(Code) | | Fetches all published properties of an remote portlet.
Parameters:
userID - The ID of the user this request is done for The portlet property description response from the producer |
| releaseSessions | | public ReturnAny releaseSessions(String[] sessionIDs, String userID) throws WSRPException(Code) | | Inform the producer that the sessions specified in the sessionIDs array
will no longer be used by the consumer and can therefor be released.
|
| setPortletProperties | | public PortletContext setPortletProperties(PropertyList properties, String userID) throws WSRPException(Code) | | Set the portlet properties specified in the property list
Parameters:
properties - List of properties to be set.
Parameters:
userID - The ID of the user is used to get the user context |
|
|