com.entrust.toolkit.pkcs11

Class PKCS11LibraryConnection

java.lang.Object

com.entrust.toolkit.pkcs11.PKCS11LibraryConnection

public class PKCS11LibraryConnection
extends java.lang.Object

Used to connect to a token's PKCS11 library as the first step when working with smart cards.

Once connected to the library, the PKCS11Information class can be used to obtain information about the library, and the JNIPKCS11 class can be used to perform operations on the token.

See Also:

PKCS11Information, JNIPKCS11

Constructor Summary

Constructors

Constructor and Description
PKCS11LibraryConnection(java.lang.String pkcs11LibraryPath) Creates a PKCS11LibraryConnection object and opens a connection to the specified PKCS11 library.

Method Summary

Modifier and Type	Method and Description
void	closeConnection() Closes the connection to the PKCS11 library.
JNIPKCS11	getJNIPKCS11() This method returns the JNIPKCS11 object.
java.lang.String	getPKCS11LibraryPath() Returns the name of the PKCS11 library file being used.
boolean	isConnectionOpen() Indicates whether or not the connection to the token's PKCS11 library is open.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS11LibraryConnection

public PKCS11LibraryConnection(java.lang.String pkcs11LibraryPath)
                        throws UserFatalException

Creates a PKCS11LibraryConnection object and opens a connection to the specified PKCS11 library.

The PKCS11 library is used to establish the connection, and must indicate the appropriate library file for the smart card being used.

Parameters:

pkcs11LibraryPath - the name of the PKCS11 library file

Throws:

UserFatalException - if the connection to the PKCS11 token library could not be established

Method Detail

closeConnection

public void closeConnection()
                     throws UserFatalException

Closes the connection to the PKCS11 library.

Throws:

UserFatalException - if there was a problem closing the connection to the PKCS11 library

isConnectionOpen

public boolean isConnectionOpen()

Indicates whether or not the connection to the token's PKCS11 library is open.

Returns:

true if the connection to the library is open, false otherwise

getPKCS11LibraryPath

public java.lang.String getPKCS11LibraryPath()

Returns the name of the PKCS11 library file being used.

Returns:

the name of the PKCS11 library file

getJNIPKCS11

public JNIPKCS11 getJNIPKCS11()
                       throws UserFatalException

This method returns the JNIPKCS11 object.

The method provides access to the native interface of the PKCS11 library.

Returns:

the native interface to PKCS11 capability

Throws:

UserFatalException - if the connection to the PKCS11 library is closed