org.exoplatform.services.wsrp.consumer
Interface UserSession

All Known Subinterfaces:

UserSessionMgr

All Known Implementing Classes:

UserSessionImpl

public interface UserSession

A consumer based session which represents a user session with a certain producer. This user session contains one or more group sessions.

Author:

Stephan Laertz, Peter Fischer, Benjamin Mestrallet

See Also:

GroupSession

Method Summary

void	addGroupSession(GroupSession groupSession) Add a group session to the user session
java.util.Iterator	getAllGroupSessions() Get all group session
GroupSessionMgr	getGroupSession(java.lang.String groupID) Get the group session for this group ID
java.lang.String	getUserID() Get ID of the user this session is bind to
void	removeAllGroupSessions() Remove all group sessions
void	removeGroupSession(java.lang.String groupID) Remove a group session from the user session
void	setUserID(java.lang.String userID) Set the ID of the user this session is bind to

Method Detail

getUserID

java.lang.String getUserID()

Get ID of the user this session is bind to

Returns:

User ID

setUserID

void setUserID(java.lang.String userID)

Set the ID of the user this session is bind to

Parameters:

userID - ID of the user

getGroupSession

GroupSessionMgr getGroupSession(java.lang.String groupID)
                                throws WSRPException

Get the group session for this group ID

Parameters:

groupID - ID of the portlet application

Returns:

The a group session for the provided group ID or a new groupSession

Throws:

WSRPException

getAllGroupSessions

java.util.Iterator getAllGroupSessions()

Get all group session

Returns:

Iterator with all group sessions for the given producer access point

addGroupSession

void addGroupSession(GroupSession groupSession)

Add a group session to the user session

Parameters:

groupSession - A group session

removeGroupSession

void removeGroupSession(java.lang.String groupID)

Remove a group session from the user session

Parameters:

groupID - ID of the portlet application

removeAllGroupSessions

void removeAllGroupSessions()

Remove all group sessions