com.entrust.toolkit

Class JniInitializer

java.lang.Object

com.entrust.toolkit.JniInitializer

public class JniInitializer
extends java.lang.Object

This class provides a convenient way to load and initialize the native libraries used by the toolkit for interfacing with PKCS11, Single Login, Server Login, and Microsoft CAPI. Its primary purpose is to allow loading explicitly named libraries, instead of requiring the native library be on the path.

For this class to be effective, it must be called before any of the Toolkit classes that require access to native libraries. Calling any of these classes before this one will cause the default library to be loaded, which must be installed on the library search path. For example,

    PKCS11LibraryConnection p11Con = new PKCS11LibraryConnection("somep11lib.dll");
    JniInitializer.initializePkcs11Library("c:\\somedir\\JNIPKCS11.dll");

will not be effective. It should be:

    JniInitializer.initializePkcs11Library("c:\\somedir\\JNIPKCS11.dll");
    PKCS11LibraryConnection p11Con = new PKCS11LibraryConnection("somep11lib.dll");

Since:

7.0

Method Summary

Methods

Modifier and Type	Method and Description
static void	initializeCapi() Load the default CAPI native library.
static void	initializeCapi(java.lang.String libraryPath) Loads the CAPI native library from the given path.
static void	initializePkcs11() Load the default PKCS11 native library.
static void	initializePkcs11(java.lang.String libraryPath) Loads the Toolkit's PKCS11 native library from the given path.
static void	initializeServerLogin() Load the default Server Login native library.
static void	initializeServerLogin(java.lang.String libraryPath) Loads the Server Login native library from the given path.
static void	initializeSingleLogin() Load the default Single Login native library.
static void	initializeSingleLogin(java.lang.String libraryPath) Loads the Single Login native library from the given path.
static boolean	isCapiInitialized() Returns true if the native CAPI library has been successfully loaded and initialized, false otherwise.
static boolean	isPkcs11Initialized() Returns true if the Toolkit's native PKCS11 library has been successfully loaded and initialized, false otherwise.
static boolean	isServerLoginInitialized() Returns true if the native Server Login library has been successfully loaded and initialized, false otherwise.
static boolean	isSingleLoginInitialized() Returns true if the Single Login native library has been successfully loaded and initialized, false otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

initializeCapi

public static void initializeCapi()
                           throws java.lang.UnsatisfiedLinkError

Load the default CAPI native library. The default library name is "JNICAPI.dll", and it must be found on the path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Throws:

java.lang.UnsatisfiedLinkError - If the library cannot be loaded.

initializeCapi

public static void initializeCapi(java.lang.String libraryPath)
                           throws java.lang.UnsatisfiedLinkError

Loads the CAPI native library from the given path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Parameters:

libraryPath - Full path to the CAPI native library to load.

Throws:

java.lang.UnsatisfiedLinkError - If the specified library cannot be loaded.

isCapiInitialized

public static boolean isCapiInitialized()

Returns true if the native CAPI library has been successfully loaded and initialized, false otherwise.

Returns:

true if the native CAPI library has been successfully loaded and initialized, false otherwise.

initializePkcs11

public static void initializePkcs11()
                             throws java.lang.UnsatisfiedLinkError

Load the default PKCS11 native library. The default library name is "JNIPKCS11", and it must be found on the path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Throws:

java.lang.UnsatisfiedLinkError - If the library cannot be loaded.

initializePkcs11

public static void initializePkcs11(java.lang.String libraryPath)
                             throws java.lang.UnsatisfiedLinkError

Loads the Toolkit's PKCS11 native library from the given path. Note that this refers to the native library supplied with the Toolkit, not the library supplied by the hardware vendor.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Parameters:

libraryPath - Full path to the PKCS11 native library to load.

Throws:

java.lang.UnsatisfiedLinkError - If the specified library cannot be loaded.

isPkcs11Initialized

public static boolean isPkcs11Initialized()

Returns true if the Toolkit's native PKCS11 library has been successfully loaded and initialized, false otherwise.

Returns:

true if the Toolkit's native PKCS11 library has been successfully loaded and initialized, false otherwise.

initializeServerLogin

public static void initializeServerLogin()
                                  throws java.lang.UnsatisfiedLinkError

Load the default Server Login native library. The default library name is "ualjni", and it must be found on the path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Throws:

java.lang.UnsatisfiedLinkError - If the library cannot be loaded.

initializeServerLogin

public static void initializeServerLogin(java.lang.String libraryPath)
                                  throws java.lang.UnsatisfiedLinkError

Loads the Server Login native library from the given path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Parameters:

libraryPath - Full path to the Server Login native library to load.

Throws:

java.lang.UnsatisfiedLinkError - If the specified library cannot be loaded.

isServerLoginInitialized

public static boolean isServerLoginInitialized()

Returns true if the native Server Login library has been successfully loaded and initialized, false otherwise.

Returns:

true if the native Server Login library has been successfully loaded and initialized, false otherwise.

initializeSingleLogin

public static void initializeSingleLogin()
                                  throws java.lang.UnsatisfiedLinkError

Load the default Single Login native library. The default library name is "JNIELI.dll", and it must be found on the path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Throws:

java.lang.UnsatisfiedLinkError - If the library cannot be loaded.

initializeSingleLogin

public static void initializeSingleLogin(java.lang.String libraryPath)
                                  throws java.lang.UnsatisfiedLinkError

Loads the Single Login native library from the given path.

Multiple initialization is not allowed, this method has no effect if the library has already been initialized successfully.

Parameters:

libraryPath - Full path to the Single Login native library to load.

Throws:

java.lang.UnsatisfiedLinkError - If the specified library cannot be loaded.

isSingleLoginInitialized

public static boolean isSingleLoginInitialized()

Returns true if the Single Login native library has been successfully loaded and initialized, false otherwise.

Returns:

true if the Single Login native library has been successfully loaded and initialized, false otherwise.