com.metamatrix.platform.admin.apiimpl
Class SessionAdminAPIImpl

java.lang.Object
  com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl
      com.metamatrix.platform.admin.apiimpl.SessionAdminAPIImpl

All Implemented Interfaces:

SessionAdminAPI, SubSystemAdminAPI, java.io.Serializable

public class SessionAdminAPIImpl
extends SubSystemAdminAPIImpl
implements SessionAdminAPI

See Also:

Serialized Form

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.
static SessionAdminAPI	getInstance()
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)

Methods inherited from class com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl

getSessionID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SessionAdminAPI getInstance()

getPrincipal

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

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

Specified by:

getPrincipal in interface SessionAdminAPI

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

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

Description copied from interface: SessionAdminAPI

Get the collection of active user sessions on the system.

Specified by:

getActiveSessions in interface SessionAdminAPI

Returns:

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

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

terminateSession

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

Specified by:

terminateSession in interface SessionAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

isSessionValid

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

Specified by:

isSessionValid in interface SessionAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

getActiveSessionsCount

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

Get the count of active user sessions on the system.

Specified by:

getActiveSessionsCount in interface SessionAdminAPI

Returns:

The count of all active users on the system.

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException

getActiveConnectionsCountForProduct

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

Get the count of all active connections to a product.

Specified by:

getActiveConnectionsCountForProduct in interface SessionAdminAPI

Returns:

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

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

SessionServiceException