iaik.pkcs.pkcs11

Class SessionInfo

java.lang.Object

iaik.pkcs.pkcs11.SessionInfo

public class SessionInfo
extends Object

An object of this class provides information about a session. The information provided is just a snapshot at the time this information object was created; it does not retrieve the information from the session on demand.

Version:

1.0

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected long	deviceError An token specific error-code.
protected long	flags The flags.
protected long	slotID The identifier of the slot in which the token resides this session is bound to.
protected State	state The current session state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionInfo(sun.security.pkcs11.wrapper.CK_SESSION_INFO ckSessionInfo) Constructor taking a CK_SESSION_INFO object that provides the information.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
long	getDeviceError() Get the current device error-code of the token.
State	getState() Get the current state of this session.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
boolean	isRwSession() Check, if this is a read-write session.
boolean	isSerialSession() Check, if this is a serial session.
String	toString() Returns the string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

slotID

protected long slotID

The identifier of the slot in which the token resides this session is bound to.

state

protected State state

The current session state.

deviceError

protected long deviceError

An token specific error-code. The meaning of this value is not defined in PKCS#11.

flags

protected long flags

The flags.

Constructor Detail

SessionInfo

protected SessionInfo(sun.security.pkcs11.wrapper.CK_SESSION_INFO ckSessionInfo)

Constructor taking a CK_SESSION_INFO object that provides the information.

Parameters:

ckSessionInfo - The object providing the session information.

Method Detail

getState

public State getState()

Get the current state of this session.

Returns:

The current state of this session.

getDeviceError

public long getDeviceError()

Get the current device error-code of the token. Notice that this code is device-specific. Its meaning is not defined in the PKCS#11 standard.

Returns:

The error-code of the device.

isRwSession

public boolean isRwSession()

Check, if this is a read-write session.

Returns:

True, if this is a read-write session; false, if this is a read-only session.

isSerialSession

public boolean isSerialSession()

Check, if this is a serial session. Should always be true for version 2.x of the PKCS#11 standard.

Returns:

True, if this is a serial session; false, if this is a parallel session. Should always be true for version 2.x of the PKCS#11 standard.

toString

public String toString()

Returns the string representation of this object.

Overrides:

toString in class Object

Returns:

The string representation of object

equals

public boolean equals(Object otherObject)

Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.

Overrides:

equals in class Object

Parameters:

otherObject - The other SessionInfo object.

Returns:

True, if other is an instance of Info and all member variables of both objects are equal. False, otherwise.

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class Object

Returns:

The hash code of this object. Gained from the slotID, state and deviceError.