com.anabas.sharedlet
Interface SessionManager


public interface SessionManager
extends SharedletService

This service provides sessioh parameter storage to the sharedlets as well as user list management.

Location In GXO

A sharedlet can find it under the meeting context:

/services/SessionManager


Method Summary
 void addSessionListener(SessionListener l)
          Add a listener to session change events such as user joined, left.
 com.anabas.concepts.User getMyUser()
          The user who owns this particular instance of the session manager.
 java.util.Vector getParticipants()
          A list of participants (SharedletUser objects) including one's self.
 com.anabas.concepts.SessionID getSessionID()
           
 java.lang.Object getSessionParameter(java.lang.String paramName)
          Gets a session parameter that was set when the framework was initialized.
 java.lang.String getSessionRoleID(java.lang.String MIMEType)
          Gets the role that a particular sharedlet is currently assigned.
 void removeSessionListener(SessionListener l)
          Remove a listener.
 
Methods inherited from interface com.anabas.sharedlet.SharedletService
init, resume, shutdown, suspend
 

Method Detail

addSessionListener

public void addSessionListener(SessionListener l)
Add a listener to session change events such as user joined, left.
Parameters:
l - The listener to add.

removeSessionListener

public void removeSessionListener(SessionListener l)
Remove a listener.
Parameters:
l - The listener to remove

getMyUser

public com.anabas.concepts.User getMyUser()
The user who owns this particular instance of the session manager.
Returns:
The user object associated with my instance of the session.

getSessionParameter

public java.lang.Object getSessionParameter(java.lang.String paramName)
Gets a session parameter that was set when the framework was initialized.
Parameters:
paramName - The name of the session parameter to retrieve the value for.
Returns:
The value of a session parameter.

getParticipants

public java.util.Vector getParticipants()
A list of participants (SharedletUser objects) including one's self.
Returns:
A vector of SharedletUser objects who are in this session.

getSessionRoleID

public java.lang.String getSessionRoleID(java.lang.String MIMEType)
Gets the role that a particular sharedlet is currently assigned. This is the same role id defined by the SharedletInfo.getRoleInfos().
Parameters:
The - MIME Type of the sharedlet.
Returns:
The id of the role this sharedlet is in.

getSessionID

public com.anabas.concepts.SessionID getSessionID()
Returns:
The unique ID for this particular collaborative session (meeting).