EAF 7.4 API

com.lutris.appserver.server.sessionEnhydra
Interface StandardSessionUserTable


public interface StandardSessionUserTable

Table used by StandardSessionManager to cross reference User objects and sessions.

N.B. It is assumed that this interface is only used by StandardSessionManager and that it is responsible for providing high level locks instead of synchronizing

Version:
$Revision: 1.1 $
Author:
Mark Diekhans, Kyle Clark
See Also:
BasicSessionUserTable, PagedSessionUserTable, com.lutris.appserver.server.sessionEnhydra.persistent.PersistentSessionUserTable

Method Summary
 void add(java.lang.String sessionKey, User user)
          Add a session key to the user to session xref table.
 java.util.Enumeration getSessionKeys(User user)
          Returns the session keys associated with a particular user.
 int numSessions(User user)
          Get the number of sessions for a user.
 void remove(java.lang.String sessionKey)
          Removes all references to a session from the user session table.
 void remove(java.lang.String sessionKey, User user)
          Remove a session from the user to session mapping table.
 void shutdown()
          Shutdown this session user table as required.
 

Method Detail

add

void add(java.lang.String sessionKey,
         User user)
         throws SessionException
Add a session key to the user to session xref table.

Parameters:
session - The session key.
user - the user to associated with the session key.
Throws:
SessionException - if an error occurs.

remove

void remove(java.lang.String sessionKey,
            User user)
            throws SessionException
Remove a session from the user to session mapping table. If the session is not it the table, it is ignored.

Parameters:
sessionKey - The session object, with the user already filled in.
Throws:
SessionException - if an error occurs.

remove

void remove(java.lang.String sessionKey)
            throws SessionException
Removes all references to a session from the user session table.

Parameters:
sessionKey - The session key.
Throws:
SessionException

numSessions

int numSessions(User user)
                throws SessionException
Get the number of sessions for a user.

Parameters:
user - The user object to check for.
Returns:
The count of the number of sessions associated with this user.
Throws:
SessionException - if an error occurs.

getSessionKeys

java.util.Enumeration getSessionKeys(User user)
                                     throws SessionException
Returns the session keys associated with a particular user.

Parameters:
user - The user object to check for.
Returns:
An enumeration of the session keys associated with the user.
Throws:
SessionException - if an error occurs.

shutdown

void shutdown()
Shutdown this session user table as required. The session user table should not be used after this method has been called


EAF 7.4 API