KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.exoplatform.services.wsrp.consumer;
2
3
4 import java.util.Iterator JavaDoc;
5 import org.exoplatform.services.wsrp.exceptions.WSRPException;
6
7 /**
8  * A consumer based session which represents a user session with a certain producer.
9  * This user session contains one or more group sessions.
10  *
11  * @author <a HREF="mailto:stephan.laertz@de.ibm.com">Stephan Laertz</a>
12  * @author <a HREF='mailto:peter.fischer@de.ibm.com'>Peter Fischer</a>
13  * @author Benjamin Mestrallet
14  * @see GroupSession
15  */
16 public interface UserSession {
17
18   /**
19    * Get ID of the user this session is bind to
20    *
21    * @return User ID
22    */
23   public String JavaDoc getUserID();
24
25   /**
26    * Set the ID of the user this session is bind to
27    *
28    * @param userID ID of the user
29    */
30   public void setUserID(String JavaDoc userID);
31
32   /**
33    * Get the group session for this group ID
34    *
35    * @param groupID ID of the portlet application
36    * @return The a group session for the provided group ID or a new groupSession
37    */
38   public GroupSessionMgr getGroupSession(String JavaDoc groupID) throws WSRPException;
39
40   /**
41    * Get all group session
42    *
43    * @return Iterator with all group sessions for the given producer access point
44    */
45   public Iterator JavaDoc getAllGroupSessions();
46
47   /**
48    * Add a group session to the user session
49    *
50    * @param groupSession A group session
51    */
52   public void addGroupSession(GroupSession groupSession);
53
54   /**
55    * Remove a group session from the user session
56    *
57    * @param groupID ID of the portlet application
58    */
59   public void removeGroupSession(String JavaDoc groupID);
60
61   /**
62    * Remove all group sessions
63    */
64   public void removeAllGroupSessions();
65 }
66
Popular Tags