com.entrust.toolkit.pkcs11

Class SessionInfo

java.lang.Object

com.entrust.toolkit.pkcs11.SessionInfo

public class SessionInfo
extends java.lang.Object

Represents a structure that provides information about a session.

The sturucture is defined as follows:

 typedef struct CK_SESSION_INFO {
      CK_SLOT_ID slotID;
      CK_STATE state;
      CK_FLAGS flags;
      CK_ULONG ulDeviceError;
 } CK_SESSION_INFO;
 

Field Summary

Fields

Modifier and Type	Field and Description
static long	CKF_RW_SESSION Indicates the session is read/write.
static long	CKF_SERIAL_SESSION Provided for backward compatibility.

Method Summary

Methods

Modifier and Type	Method and Description
long	getDeviceError() Returns the device error component.
long	getFlags() Returns the flags component.
long	getSlotID() Returns the slot ID component.
long	getState() Returns the state component.
boolean	isFlagSet(long flag) Indicates whether a given flag has been set.
java.lang.String	toString() Returns a String representation of the SessionInfo object.
java.lang.String	toString(boolean flagNames) Returns a String representation of the SessionInfo object.

Methods inherited from class java.lang.Object

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

Field Detail

CKF_RW_SESSION

public static final long CKF_RW_SESSION

Indicates the session is read/write.

See Also:

Constant Field Values

CKF_SERIAL_SESSION

public static final long CKF_SERIAL_SESSION

Provided for backward compatibility.

See Also:

Constant Field Values

Method Detail

getSlotID

public long getSlotID()

Returns the slot ID component.

Returns:

the ID of the slot that interfaces with the token

getState

public long getState()

Returns the state component.

Returns:

the state of the session

getFlags

public long getFlags()

Returns the flags component.

Returns:

the bit flags that define the type of session.

isFlagSet

public boolean isFlagSet(long flag)

Indicates whether a given flag has been set.

Parameters:

flag - the flag being checked

Returns:

true if the flag has been set; false otherwise

getDeviceError

public long getDeviceError()

Returns the device error component.

Returns:

an error code defined by the cryptographic device — used for errors not covered by Cryptoki.

toString

public java.lang.String toString()

Returns a String representation of the SessionInfo object.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the SessionInfo object

toString

public java.lang.String toString(boolean flagNames)

Returns a String representation of the SessionInfo object.

Parameters:

flagNames - indicates that the flags component should be represented as a list of the flags that have been set; otherwise the actual flag value will be returned

Returns:

a String representation of the SessionInfo object