com.safenetinc.luna

Class LunaSessionManager

java.lang.Object

com.safenetinc.luna.LunaSessionManager

public final class LunaSessionManager
extends Object

LunaSessionManager is a collection of methods to make handling sessions easier. The actual session data is elsewhere, and synchronization is centered around those data collections. There is no need to instantiate this class as all methods are static. Should one need manipulate sessions directly, there are public methods available which are demonstrated via the MiscSessionsDemo.java sample class.

Constructor Summary

Constructors

Constructor and Description
LunaSessionManager()

Method Summary

Modifier and Type	Method and Description
static boolean	closeAllCachedSessions() Close all cached sessions on all logged-in slots.
static boolean	closeAllSessions() Close all sessions sitting in the cache as well as all active sessions on all logged-in slots.
static boolean	closeAllSessions(int slotNum) Close all sessions sitting in the cache as well as all active sessions on the specified slot.
static boolean	closeCachedSessions() Close all cached sessions on the default slot.
static boolean	closeCachedSessions(int slotNum) Close all cached sessions on the specified slot.
static void	forceAllHSMSessionsToClose() Close all sessions open against all currently logged-in slots, then log out of the slots.
static void	forceAllHSMSessionsToClose(int slot) Close all sessions open against the specified logged-in slot, then log out of the slot.
static void	free(LunaSession session) Free the given session.
static int	getActiveSessionCount() Returns the number of sessions currently open and in-use on the default slot.
static int	getActiveSessionCount(int slotNum) Returns the number of sessions currently open and in-use on the specified slot.
static int	getCachedSessionCount() Returns the number of sessions currently cached for the default slot.
static int	getCachedSessionCount(int slotNum) Returns the number of sessions currently cached for the specified slot.
static LunaSession	getSession() Get a new session on the current default active slot.
static LunaSession	getSession(int slotNum) Get a new session on the specified slot.
static LunaSession	getSession(LunaKey key) Get a new session on the same slot as the specified key.
static int	getSessionCount() Returns the number of sessions currently open on the default slot.
static int	getSessionCount(int slotNum) Returns the number of sessions currently open on the specified slot.
static int	getTotalSessionCount() Returns the number of sessions currently open on all slots used by this application.

Methods inherited from class java.lang.Object

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

Constructor Detail

LunaSessionManager

public LunaSessionManager()

Method Detail

getTotalSessionCount

public static int getTotalSessionCount()

Returns the number of sessions currently open on all slots used by this application. This includes cached and in-use sessions.

Returns:

The number of presently open sessions

getSessionCount

public static int getSessionCount()

Returns the number of sessions currently open on the default slot. This includes cached and in-use sessions.

Returns:

The number of presently open sessions on the default slot

getSessionCount

public static int getSessionCount(int slotNum)

Returns the number of sessions currently open on the specified slot. This includes cached and in-use sessions. If there is no valid token at the specified slot number, 0 is returned.

Parameters:

slotNum - Check the token in this slot number

Returns:

The number of presently open sessions on this slot

getActiveSessionCount

public static int getActiveSessionCount()

Returns the number of sessions currently open and in-use on the default slot. If there is no default slot, 0 is returned.

Returns:

The number of presently open and in-use sessions on the default slot

getActiveSessionCount

public static int getActiveSessionCount(int slotNum)

Returns the number of sessions currently open and in-use on the specified slot. If there is no valid token at the specified slot number, 0 is returned.

Parameters:

slotNum - Check the token in this slot number

Returns:

The number of presently open and in-use sessions on the specified slot

getCachedSessionCount

public static int getCachedSessionCount()

Returns the number of sessions currently cached for the default slot. If there is no default slot, 0 is returned.

Returns:

The number of presently cached sessions on the default slot

getCachedSessionCount

public static int getCachedSessionCount(int slotNum)

Returns the number of sessions currently cached for the specified slot. If there is no valid token at the specified slot number, 0 is returned.

Parameters:

slotNum - Check the token in this slot number

Returns:

The number of presently cached sessions on the specified slot

getSession

public static LunaSession getSession()

Get a new session on the current default active slot. The user must be logged in before this call will be successful.

Returns:

An open session on the current default active slot

Throws:

LunaException - There is no logged in slot available

getSession

public static LunaSession getSession(int slotNum)

Get a new session on the specified slot. The user must be logged in to this slot before the call will be successful.

Parameters:

slotNum - The slot to get a session on

Returns:

An open session on the specified slot

Throws:

LunaException - The user is not logged in to the slot that the session is requested on

getSession

public static LunaSession getSession(LunaKey key)

Get a new session on the same slot as the specified key. This method is useful when you need to work with a LunaKey that's passed in to the application.

Parameters:

key - A session is returned on the same slot as this slot

Returns:

A session that is compatible with the key

free

public static void free(LunaSession session)

Free the given session. If caching is enabled this session will be returned to the pool to be re-used; if caching is disabled, the session will be closed immediately.

Parameters:

session - The session to free

closeCachedSessions

public static boolean closeCachedSessions(int slotNum)
                                   throws LunaException

Close all cached sessions on the specified slot.

Parameters:

slotNum - The slot number to close the sessions on

Returns:

true if all the cached sessions were closed, false otherwise

Throws:

LunaException - The user in not logged in to the specified slot

closeCachedSessions

public static boolean closeCachedSessions()
                                   throws LunaException

Close all cached sessions on the default slot.

Returns:

true if all the cached sessions were closed, false otherwise

Throws:

LunaException - The user in not logged in to the specified slot

closeAllCachedSessions

public static boolean closeAllCachedSessions()

Close all cached sessions on all logged-in slots.

Returns:

true if all the cached sessions were closed, false otherwise

closeAllSessions

public static boolean closeAllSessions(int slotNum)

Close all sessions sitting in the cache as well as all active sessions on the specified slot.

Use of this function can be dangerous and can cause operations in other threads to fail. This functionality is provided for your convenience but it is strongly recommended to find an alternative solution.

Parameters:

slotNum - Check the token in this slot number

Returns:

true if all the sessions were closed, false otherwise

closeAllSessions

public static boolean closeAllSessions()

Close all sessions sitting in the cache as well as all active sessions on all logged-in slots.

Use of this function can be dangerous and can cause operations in other threads to fail. This functionality is provided for your convenience but it is strongly recommended to find an alternative solution.

Returns:

true if all the sessions were closed, false otherwise

forceAllHSMSessionsToClose

public static void forceAllHSMSessionsToClose(int slot)

Close all sessions open against the specified logged-in slot, then log out of the slot. If the sessions can't be closed "nicely", they will be killed.

Use of this function can be dangerous and will cause operations in other threads and / or applications to fail. This functionality is provided as a convenience but we strongly advise against its use. The operation will be performed on the currently managed slot

Parameters:

slot - Check the token in this slot number

Throws:

LunaException - exception

forceAllHSMSessionsToClose

public static void forceAllHSMSessionsToClose()
                                       throws LunaException

Close all sessions open against all currently logged-in slots, then log out of the slots. If the sessions can't be closed "nicely", they will be killed.

This function is intended only to clean up the HSM if the Java application is abnormally terminated. Use of this function while the application is running will cause all current operations to fail.

This functionality is provided as a convenience but we strongly advise against its use.

Throws:

LunaException - exception