com.metamatrix.platform.admin.api
Interface SessionAdminAPI

All Superinterfaces:

java.io.Serializable, SubSystemAdminAPI

All Known Implementing Classes:

SessionAdminAPIImpl

public interface SessionAdminAPI
extends SubSystemAdminAPI

Method Summary

int	getActiveConnectionsCountForProduct(java.lang.String product) Get the count of all active connections to a product.
java.util.Collection	getActiveSessions() Get the collection of active user sessions on the system.
int	getActiveSessionsCount() Get the count of active user sessions on the system.
MetaMatrixPrincipal	getPrincipal(MetaMatrixSessionID userSessionID) Get the information for the account to which the specified session has been authenticated.
java.lang.Boolean	isSessionValid(MetaMatrixSessionID userSessionID)
void	terminateSession(MetaMatrixSessionID userSessionID)

Method Detail

getPrincipal

MetaMatrixPrincipal getPrincipal(MetaMatrixSessionID userSessionID)
                                 throws InvalidSessionException,
                                        AuthorizationException,
                                        MetaMatrixComponentException,
                                        SessionServiceException

Get the information for the account to which the specified session has been authenticated.

Parameters:

userSessionID - ID identifying session for which the account information is to be obtained

Returns:

the information for the user account for which the sessionToken is logged into

Throws:

InvalidSessionException - If the caller's session has expired or doesn't exist

SessionNotFoundException - If specified userSessionID is invalid or nonexistant

AuthorizationException - if the caller denoted by callerSessionID does not have authority to access the account information for the userSessionID session

MetaMatrixComponentException - If couldn't find a component

SessionServiceException

getActiveSessions

java.util.Collection getActiveSessions()
                                       throws AuthorizationException,
                                              InvalidSessionException,
                                              MetaMatrixComponentException,
                                              SessionServiceException

Get the collection of active user sessions on the system.

Returns:

The collection of MetaMatrixSessionInfo objects of active users on the system - possibly empty, never null.

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

getActiveSessionsCount

int getActiveSessionsCount()
                           throws AuthorizationException,
                                  InvalidSessionException,
                                  MetaMatrixComponentException,
                                  SessionServiceException

Get the count of active user sessions on the system.

Returns:

The count of all active users on the system.

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

getActiveConnectionsCountForProduct

int getActiveConnectionsCountForProduct(java.lang.String product)
                                        throws AuthorizationException,
                                               InvalidSessionException,
                                               MetaMatrixComponentException,
                                               SessionServiceException

Get the count of all active connections to a product.

Returns:

The count of all active connections to a product on the system.

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

terminateSession

void terminateSession(MetaMatrixSessionID userSessionID)
                      throws AuthorizationException,
                             InvalidSessionException,
                             MetaMatrixComponentException,
                             SessionServiceException

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

isSessionValid

java.lang.Boolean isSessionValid(MetaMatrixSessionID userSessionID)
                                 throws AuthorizationException,
                                        InvalidSessionException,
                                        MetaMatrixComponentException,
                                        SessionServiceException

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException