org.exoplatform.services.wsrp.consumer.impl
Class PortletDriverImpl

java.lang.Object
  org.exoplatform.services.wsrp.consumer.impl.PortletDriverImpl

All Implemented Interfaces:

PortletDriver

public class PortletDriverImpl
extends Object
implements PortletDriver

The implementation of this class is based on the WSRP4J project

Constructor Summary

PortletDriverImpl(org.exoplatform.container.ExoContainer cont, WSRPPortlet portlet)

Method Summary

org.exoplatform.services.wsrp.type.PortletContext	clonePortlet(UserSessionMgr userSession) Clone the portlet
org.exoplatform.services.wsrp.type.DestroyPortletsResponse	destroyPortlets(String[] portletHandles, UserSessionMgr userSession) Destroy the producer portlets specified in the entiyHandles array.
org.exoplatform.services.wsrp.type.MarkupResponse	getMarkup(WSRPMarkupRequest markupRequest, UserSessionMgr userSession, 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.
org.exoplatform.services.wsrp.type.PortletDescriptionResponse	getPortletDescription(UserSessionMgr userSession, String[] desiredLocales)
org.exoplatform.services.wsrp.type.PropertyList	getPortletProperties(String[] names, UserSessionMgr userSession)
org.exoplatform.services.wsrp.type.PortletPropertyDescriptionResponse	getPortletPropertyDescription(UserSessionMgr userSession)
void	initCookie()
org.exoplatform.services.wsrp.type.BlockingInteractionResponse	performBlockingInteraction(WSRPInteractionRequest actionRequest, UserSessionMgr userSession, String path) This method is used to perform a blocking interaction on the portlet instance.
org.exoplatform.services.wsrp.type.ReturnAny	releaseSessions(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.
org.exoplatform.services.wsrp.type.PortletContext	setPortletProperties(org.exoplatform.services.wsrp.type.PropertyList properties, UserSessionMgr userSession)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletDriverImpl

public PortletDriverImpl(org.exoplatform.container.ExoContainer cont,
                         WSRPPortlet portlet)
                  throws WSRPException

Throws:

WSRPException

Method Detail

getPortlet

public WSRPPortlet getPortlet()

Description copied from interface: PortletDriver

Get the portlet this driver is bound to.

Specified by:

getPortlet in interface PortletDriver

Returns:

The enity

getMarkup

public org.exoplatform.services.wsrp.type.MarkupResponse getMarkup(WSRPMarkupRequest markupRequest,
                                                                   UserSessionMgr userSession,
                                                                   String path)
                                                            throws WSRPException

Description copied from interface: PortletDriver

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

Specified by:

getMarkup in interface PortletDriver

Returns:

The markup response generated by portlet

Throws:

WSRPException

performBlockingInteraction

public org.exoplatform.services.wsrp.type.BlockingInteractionResponse performBlockingInteraction(WSRPInteractionRequest actionRequest,
                                                                                                 UserSessionMgr userSession,
                                                                                                 String path)
                                                                                          throws WSRPException

Description copied from interface: PortletDriver

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

Specified by:

performBlockingInteraction in interface PortletDriver

Throws:

WSRPException

clonePortlet

public org.exoplatform.services.wsrp.type.PortletContext clonePortlet(UserSessionMgr userSession)
                                                               throws WSRPException

Description copied from interface: PortletDriver

Clone the portlet

Specified by:

clonePortlet in interface PortletDriver

Returns:

The new portlet context

Throws:

WSRPException

destroyPortlets

public org.exoplatform.services.wsrp.type.DestroyPortletsResponse destroyPortlets(String[] portletHandles,
                                                                                  UserSessionMgr userSession)
                                                                           throws WSRPException

Description copied from interface: PortletDriver

Destroy the producer portlets specified in the entiyHandles array.

Specified by:

destroyPortlets in interface PortletDriver

Throws:

WSRPException

releaseSessions

public org.exoplatform.services.wsrp.type.ReturnAny releaseSessions(String[] sessionIDs,
                                                                    UserSessionMgr userSession)
                                                             throws WSRPException

Description copied from interface: PortletDriver

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

Specified by:

releaseSessions in interface PortletDriver

Throws:

WSRPException

initCookie

public void initCookie()
                throws WSRPException

Specified by:

initCookie in interface PortletDriver

Throws:

WSRPException

getPortletDescription

public org.exoplatform.services.wsrp.type.PortletDescriptionResponse getPortletDescription(UserSessionMgr userSession,
                                                                                           String[] desiredLocales)
                                                                                    throws WSRPException

Specified by:

getPortletDescription in interface PortletDriver

Throws:

WSRPException

getPortletPropertyDescription

public org.exoplatform.services.wsrp.type.PortletPropertyDescriptionResponse getPortletPropertyDescription(UserSessionMgr userSession)
                                                                                                    throws WSRPException

Specified by:

getPortletPropertyDescription in interface PortletDriver

Throws:

WSRPException

getPortletProperties

public org.exoplatform.services.wsrp.type.PropertyList getPortletProperties(String[] names,
                                                                            UserSessionMgr userSession)
                                                                     throws WSRPException

Specified by:

getPortletProperties in interface PortletDriver

Throws:

WSRPException

setPortletProperties

public org.exoplatform.services.wsrp.type.PortletContext setPortletProperties(org.exoplatform.services.wsrp.type.PropertyList properties,
                                                                              UserSessionMgr userSession)
                                                                       throws WSRPException

Specified by:

setPortletProperties in interface PortletDriver

Throws:

WSRPException