oracle.security.crypto.cryptoki

Class CkiContext

java.lang.Object

oracle.security.crypto.cryptoki.CkiContext

public final class CkiContext
extends java.lang.Object

The CkiContext class represents an individual Cryptoki implementation in the system.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
CkiLibrary	getCkiLibrary() Gets the CkiLibrary object of this context.
static CkiContext	getGenericInstance(java.lang.String libraryName) Gets an instance of CkiContext using the Generic library.
java.util.Properties	getInfo() Gets information on the cryptoki library.
static CkiContext	getInstance(java.lang.String libraryClass) Gets an instance of CkiContext
java.lang.String	getLibraryClassName() Gets the name of the CkiLibrary object used by this context.
CkiSlot	getSlot(int slotNum) Retrieves the slot represented by the slotNum parameter.
java.util.Vector	getSlots() Retrieves the slots the system found.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CkiContext getInstance(java.lang.String libraryClass)
                              throws CryptokiException

Gets an instance of CkiContext

Parameters:

libraryClass - The name of the library class from oracle.security.crypto.cryptoki.drivers package.

Returns:

A new instance of CkiContext

Throws:

CryptokiException

getGenericInstance

public static CkiContext getGenericInstance(java.lang.String libraryName)
                                     throws CryptokiException

Gets an instance of CkiContext using the Generic library.

Note: this generic library should only used for testing purposes.

Parameters:

libraryName - The name of the native library that implements the PKCS#11 specifications to load.

Returns:

A new instance of CkiContext

Throws:

CryptokiException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getSlots

public java.util.Vector getSlots()
                          throws CkiDeviceException

Retrieves the slots the system found. Note that if this CkiContext supports removable slots (e.g., a USB port implementation), successive calls to the getSlots method are not guaranteed to return the same list.

Returns:

A vector containing CkiSlot objects.

Throws:

CkiDeviceException

getSlot

public CkiSlot getSlot(int slotNum)
                throws CkiDeviceException

Retrieves the slot represented by the slotNum parameter.

Parameters:

slotNum - The slot number.

Returns:

A CkiSlot object.

Throws:

CkiDeviceException

getInfo

public java.util.Properties getInfo()
                             throws CryptokiException

Gets information on the cryptoki library.

Returns:

A Properties object containing the information on the cryptoki library.

Throws:

CryptokiException

getCkiLibrary

public CkiLibrary getCkiLibrary()

Gets the CkiLibrary object of this context.

Returns:

A CkiLibrary object used by this CkiContext object.

getLibraryClassName

public java.lang.String getLibraryClassName()

Gets the name of the CkiLibrary object used by this context.

Returns:

The String representing the class name of the ckilibrary.