KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exoplatform > services > wsrp > consumer > PortletDriver


1 package org.exoplatform.services.wsrp.consumer;
2
3 import org.exoplatform.services.wsrp.exceptions.WSRPException;
4 import org.exoplatform.services.wsrp.type.*;
5
6 /**
7  * The portlet driver is a wrapper for all action which can be performed on an
8  * portlet. There is one portlet driver for all instances of an portlet.
9  *
10  * @author Benjamin Mestrallet
11  */
12 public interface PortletDriver {
13
14   /**
15    * Get the portlet this driver is bound to.
16    *
17    * @return The enity
18    */
19   public WSRPPortlet getPortlet();
20
21   /**
22    * This method is used to retrieve the markup generated by the portlet instance.
23    *
24    * @return The markup response generated by portlet
25    */
26   public MarkupResponse getMarkup(WSRPMarkupRequest markupRequest,
27                                   UserSessionMgr userSession,
28                                   String JavaDoc path)
29       throws WSRPException;
30
31   /**
32    * This method is used to perform a blocking interaction on the portlet instance.
33    */
34   public BlockingInteractionResponse performBlockingInteraction(InteractionRequest actionRequest,
35                                                                 UserSessionMgr userSession,
36                                                                 String JavaDoc path)
37       throws WSRPException;
38
39   /**
40    * Clone the portlet
41    *
42    * @return The new portlet context
43    */
44   public PortletContext clonePortlet(UserSessionMgr userSession) throws WSRPException;
45
46   /**
47    *
48    **/
49   public void initCookie() throws WSRPException;
50
51   /**
52    * Destroy the producer portlets specified in the entiyHandles array.
53    */
54   public DestroyPortletsResponse destroyPortlets(String JavaDoc[] portletHandles,
55                                                  UserSessionMgr userSession)
56       throws WSRPException;
57
58   /**
59    * Inform the producer that the sessions specified in the sessionIDs array
60    * will no longer be used by the consumer and can therefor be released.
61    */
62   public ReturnAny releaseSessions(String JavaDoc[] sessionIDs,
63                                    UserSessionMgr userSession)
64       throws WSRPException;
65
66
67   public PortletDescriptionResponse getPortletDescription(UserSessionMgr userSession,
68                                                           String JavaDoc[] desiredLocales)
69       throws WSRPException;
70
71
72   public PortletPropertyDescriptionResponse getPortletPropertyDescription(UserSessionMgr userSession)
73       throws WSRPException;
74
75   public PropertyList getPortletProperties(String JavaDoc[] names, UserSessionMgr userSession)
76       throws WSRPException;
77
78   public PortletContext setPortletProperties(PropertyList properties, UserSessionMgr userSession)
79       throws WSRPException;
80 }
81
Popular Tags