org.exoplatform.services.wsrp.consumer
Interface PortletDriver

All Known Implementing Classes:

PortletDriverImpl

public interface PortletDriver

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.

Author:

Benjamin Mestrallet

Method Summary

PortletContext	clonePortlet(UserSessionMgr userSession) Clone the portlet
DestroyPortletsResponse	destroyPortlets(java.lang.String[] portletHandles, UserSessionMgr userSession) Destroy the producer portlets specified in the entiyHandles array.
MarkupResponse	getMarkup(WSRPMarkupRequest markupRequest, UserSessionMgr userSession, java.lang.String path) This method is used to retrieve the markup generated by the portlet instance.
WSRPPortlet	getPortlet() Get the portlet this driver is bound to.
PortletDescriptionResponse	getPortletDescription(UserSessionMgr userSession, java.lang.String[] desiredLocales)
PropertyList	getPortletProperties(java.lang.String[] names, UserSessionMgr userSession)
PortletPropertyDescriptionResponse	getPortletPropertyDescription(UserSessionMgr userSession)
void	initCookie() Deprecated.
void	initCookie(UserSessionMgr userSession)
BlockingInteractionResponse	performBlockingInteraction(WSRPInteractionRequest actionRequest, UserSessionMgr userSession, java.lang.String path) This method is used to perform a blocking interaction on the portlet instance.
ReturnAny	releaseSessions(java.lang.String[] sessionIDs, UserSessionMgr userSession) 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, UserSessionMgr userSession)

Method Detail

getPortlet

WSRPPortlet getPortlet()

Get the portlet this driver is bound to.

Returns:

The enity

getMarkup

MarkupResponse getMarkup(WSRPMarkupRequest markupRequest,
                         UserSessionMgr userSession,
                         java.lang.String path)
                         throws WSRPException

This method is used to retrieve the markup generated by the portlet instance.

Returns:

The markup response generated by portlet

Throws:

WSRPException

performBlockingInteraction

BlockingInteractionResponse performBlockingInteraction(WSRPInteractionRequest actionRequest,
                                                       UserSessionMgr userSession,
                                                       java.lang.String path)
                                                       throws WSRPException

This method is used to perform a blocking interaction on the portlet instance.

Throws:

WSRPException

clonePortlet

PortletContext clonePortlet(UserSessionMgr userSession)
                            throws WSRPException

Clone the portlet

Returns:

The new portlet context

Throws:

WSRPException

initCookie

@Deprecated
void initCookie()
                throws WSRPException

Deprecated.

Throws:

WSRPException

initCookie

void initCookie(UserSessionMgr userSession)
                throws WSRPException

Throws:

WSRPException

destroyPortlets

DestroyPortletsResponse destroyPortlets(java.lang.String[] portletHandles,
                                        UserSessionMgr userSession)
                                        throws WSRPException

Destroy the producer portlets specified in the entiyHandles array.

Throws:

WSRPException

releaseSessions

ReturnAny releaseSessions(java.lang.String[] sessionIDs,
                          UserSessionMgr userSession)
                          throws WSRPException

Inform the producer that the sessions specified in the sessionIDs array will no longer be used by the consumer and can therefor be released.

Throws:

WSRPException

getPortletDescription

PortletDescriptionResponse getPortletDescription(UserSessionMgr userSession,
                                                 java.lang.String[] desiredLocales)
                                                 throws WSRPException

Throws:

WSRPException

getPortletPropertyDescription

PortletPropertyDescriptionResponse getPortletPropertyDescription(UserSessionMgr userSession)
                                                                 throws WSRPException

Throws:

WSRPException

getPortletProperties

PropertyList getPortletProperties(java.lang.String[] names,
                                  UserSessionMgr userSession)
                                  throws WSRPException

Throws:

WSRPException

setPortletProperties

PortletContext setPortletProperties(PropertyList properties,
                                    UserSessionMgr userSession)
                                    throws WSRPException

Throws:

WSRPException