* Module pkcs11Module = Module.getInstance("cryptoki.dll");
* pkcs11Module.initialize(null);
*
* // ... work with the module
*
* pkcs11Module.finalize(null);
* cryptoki.dll, the application will use the name of
* the PKCS#11 module of the installed crypto hardware.
* After the application initialized the module, it can get a list of all
* available slots. A slot is an object that represents a physical or logical
* device that can accept a cryptographic token; for instance, the card slot of
* a smart card reader. The application can call
*
* Slot[] slots = pkcs11Module.getSlotList(Module.SlotRequirement.ALL_SLOTS);
*
* Slot[] slotsWithToken = pkcs11Module.getSlotList(Module.SlotRequirement.TOKEN_PRESENT);
*
* To wait for the insertion of a token, the application can use the
* waitForSlotEvent method. For example, the method call
*
* Slot eventSlot = pkcs11Module.waitForSlotEvent(Module.WaitingBehavior.DONT_BLOCK, null);
* finalize method,
* which is the reserved Java method called by the garbage collector.
* This method calls the C_Finalize(Object) method of the
* underlying PKCS11 module.
*
* @param args Must be null in version 2.x of PKCS#11.
* @exception TokenException If finalization fails.
* @preconditions (args == null)
* @postconditions
*/
public void finalize(Object args)
throws TokenException
{
pkcs11Module_.C_Finalize(args);
}
/**
* Gets a list of slots that can accept tokens that are compatible with this
* module; e.g. a list of PC/SC smart card readers. The parameter determines
* if the method returns all compatible slots or only those in which there is
* a compatible token present.
*
* @param tokenPresent Can be SlotRequirement.ALL_SLOTS or
* SlotRequirement.TOKEN_PRESENT.
* @return An array of Slot objects. May be an empty array but not null.
* @exception TokenException If .
* @preconditions
* @postconditions (result <> null)
*/
public Slot[] getSlotList(boolean tokenPresent)
throws TokenException
{
long[] slotIDs = pkcs11Module_.C_GetSlotList(tokenPresent);
Slot[] slots = new Slot[slotIDs.length];
for (int i = 0; i < slots.length; i++) {
slots[i] = new Slot(this, slotIDs[i]);
}
return slots;
}
/**
* Waits for an slot event. That can be that a token was inserted or removed.
* It returns the Slot for which an event occured. The dontBlock parameter can
* have the value WaitingBehavior.BLOCK or WaitingBehavior.DONT_BLOCK.
* If there is no event present and the method is called with
* WaitingBehavior.DONT_BLOCK this method throws an exception with the error
* code PKCS11Constants.CKR_NO_EVENT (0x00000008).
*
* @param dontBlock Can be WaitingBehavior.BLOCK or
* WaitingBehavior.DONT_BLOCK.
* @param reserved Should be null for this version.
* @return The slot for which an event occured.
* @exception TokenException If the method was called with
* WaitingBehavior.DONT_BLOCK but there was no event
* available, or if an error occured.
* @preconditions (reserved == null)
* @postconditions (result <> null)
*/
public Slot waitForSlotEvent(boolean dontBlock, Object reserved)
throws TokenException
{
long flags = (dontBlock) ? PKCS11Constants.CKF_DONT_BLOCK : 0L;
long slotID = pkcs11Module_.C_WaitForSlotEvent(flags, reserved);
return new Slot(this, slotID);
}
/**
* Gets the PKCS#11 module of the wrapper package behind this object.
*
* @return The PKCS#11 module behind this object.
* @preconditions
* @postconditions (result <> null)
*/
public PKCS11 getPKCS11Module() {
return pkcs11Module_;
}
/**
* Returns the string representation of this object.
*
* @return The string representation of object
*/
public String toString() {
return (pkcs11Module_ != null) ? pkcs11Module_.toString() : null;
}
/**
* This finalize method tries to finalize the module by calling
* finalize() of the Java object of the PKCS11 module.
* Note that this method does not call the finalize(Object)
* (C_Finalize(Objet)) method of the PKCS11 module!
* This method is the reserved Java method called by the garbage collector.
* Don't get confused by the same name.
*
* @exception Throwable If finalization fails.
* @preconditions
* @postconditions
* @see #finalize(Object)
*/
public void finalize()
throws Throwable
{
pkcs11Module_.finalize();
super.finalize();
}
/**
* Compares the pkcs11Module_ this object with the other object.
* Returns only true, if those are equal in both objects.
*
* @param otherObject The other Module object.
* @return True, if other is an instance of Module and the pkcs11Module_ of
* both objects are equal. False, otherwise.
* @preconditions
* @postconditions
*/
public boolean equals(java.lang.Object otherObject) {
boolean equal = false;
if (otherObject instanceof Module) {
Module other = (Module) otherObject;
equal = (this == other) || this.pkcs11Module_.equals(other.pkcs11Module_);
}
return equal;
}
/**
* The overriding of this method should ensure that the objects of this class
* work correctly in a hashtable.
*
* @return The hash code of this object. Gained from the sessionHandle.
* @preconditions
* @postconditions
*/
public int hashCode() {
return pkcs11Module_.hashCode();
}
}