com.entrust.toolkit.pkcs11

Class PKCS11Information

java.lang.Object

com.entrust.toolkit.pkcs11.PKCS11Information

public class PKCS11Information
extends java.lang.Object

Provides access to general information about the token's PKCS11 library.

Using this class the following information can be retrieved:

• Information about the PKCS11 library
• The PKCS11 library's slot list
• Information about a specific token
• Mechanism information for a specific token

Constructor Summary

Constructors

Constructor and Description
PKCS11Information(PKCS11LibraryConnection pkcs11LibraryConnection) Creates a PKCS11Information object for a specific connection to a PKCS11 library.

Method Summary

Methods

Modifier and Type	Method and Description
Info	getInfo() Returns an Info object.
MechanismInfo	getMechanismInfo(long slotID, long mechanismType) Returns information about a specific mechanism supported by the token located at a specific slot ID.
MechanismList	getMechanismList(long slotID) Returns a list of all the mechanisms (cryptographic operations) supported by the token located at a specific slot ID.
SessionInfo	getSessionInfo(long sessionHandle) Returns information about a session.
SlotInfo	getSlotInfo(long slotID) Returns information about a slot located at a specific slot ID.
SlotList	getSlotList(boolean tokenPresent) Returns the slot list found by a PKCS #11 library.
TokenInfo	getTokenInfo(long slotID) Returns information about a token located at a specific slot ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS11Information

public PKCS11Information(PKCS11LibraryConnection pkcs11LibraryConnection)
                  throws UserFatalException

Creates a PKCS11Information object for a specific connection to a PKCS11 library.

The connection to the PKCS11 library must be open.

Parameters:

pkcs11LibraryConnection - the connection to the PKCS11 library

Throws:

UserFatalException - if the connection to the PKCS11 library is closed

Method Detail

getInfo

public Info getInfo()
             throws UserFatalException

Returns an Info object.

The Info object encapsulates information about the PKCS11 library — its version, for example.

Returns:

information about the PKCS11 library.

Throws:

UserFatalException - if there was a problem retrieving the information

getSlotList

public SlotList getSlotList(boolean tokenPresent)
                     throws UserFatalException

Returns the slot list found by a PKCS #11 library.

Using the slot list, a token's slot ID can be found.

Parameters:

tokenPresent - if set to true, only the IDs of slots that contain a token will be returned; otherwise all slot IDs found will be returned

Returns:

the slot list

Throws:

UserFatalException - if there was a problem retrieving the slot list

getSlotInfo

public SlotInfo getSlotInfo(long slotID)
                     throws UserFatalException

Returns information about a slot located at a specific slot ID.

Parameters:

slotID - the slotID of the slot

Returns:

information about a specific slot

Throws:

UserFatalException - if there was a problem retrieving the slot information

getTokenInfo

public TokenInfo getTokenInfo(long slotID)
                       throws UserFatalException

Returns information about a token located at a specific slot ID.

Parameters:

slotID - the slotID of the token

Returns:

information about a specific token.

Throws:

UserFatalException - if there was a problem retrieving the token information

getSessionInfo

public SessionInfo getSessionInfo(long sessionHandle)
                           throws UserFatalException

Returns information about a session.

Parameters:

sessionHandle - the session's handle

Returns:

information about the session

Throws:

UserFatalException - if there was a problem retrieving the session information

getMechanismList

public MechanismList getMechanismList(long slotID)
                               throws UserFatalException

Returns a list of all the mechanisms (cryptographic operations) supported by the token located at a specific slot ID.

Parameters:

slotID - the slotID of the token

Returns:

a list of supported mechanisms for a specific token

Throws:

UserFatalException - if there was a problem retrieving the mechanism information

getMechanismInfo

public MechanismInfo getMechanismInfo(long slotID,
                             long mechanismType)
                               throws UserFatalException

Returns information about a specific mechanism supported by the token located at a specific slot ID.

Parameters:

slotID - the slotID of the token

mechanismType - the mechanism

Returns:

information about a specific mechanism for a specific token.

Throws:

UserFatalException - if there was a problem retrieving the mechanism information