com.entrust.toolkit.pkcs11

Class SlotInfo

java.lang.Object

com.entrust.toolkit.pkcs11.SlotInfo

public class SlotInfo
extends java.lang.Object

Represents a structure that provides information about a slot.

The structure defined as follows:

 typedef struct CK_SLOT_INFO {
      CK_UTF8CHAR slotDescription[64];
      CK_UTF8CHAR manufacturerID[32];
      CK_FLAGS flags;
      CK_VERSION hardwareVersion;
      CK_VERSION firmwareVersion;
 } CK_SLOT_INFO;
 

Field Summary

Fields

Modifier and Type	Field and Description
static long	CKF_HW_SLOT Indicates the slot is a hardware slot, as opposed to a software slot implementing a "soft token".
static long	CKF_REMOVABLE_DEVICE Indicates the reader supports removable devices.
static long	CKF_TOKEN_PRESENT Indicates a token is present in the slot.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFirmwareVersion() Returns the firmware version component.
long	getFlags() Returns the flags component.
java.lang.String	getHardwareVersion() Returns the hardware version component.
java.lang.String	getManufacturerID() Returns the manufacturer ID component.
java.lang.String	getSlotDescription() Returns the slot description component.
boolean	isFlagSet(long flag) Indicates whether a given flag has been set.
java.lang.String	toString() Returns a String representation of the SlotInfo object.
java.lang.String	toString(boolean flagNames) Returns a String representation of the SlotInfo object.

Methods inherited from class java.lang.Object

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

Field Detail

CKF_TOKEN_PRESENT

public static final long CKF_TOKEN_PRESENT

Indicates a token is present in the slot.

See Also:

Constant Field Values

CKF_REMOVABLE_DEVICE

public static final long CKF_REMOVABLE_DEVICE

Indicates the reader supports removable devices.

See Also:

Constant Field Values

CKF_HW_SLOT

public static final long CKF_HW_SLOT

Indicates the slot is a hardware slot, as opposed to a software slot implementing a "soft token".

See Also:

Constant Field Values

Method Detail

getSlotDescription

public java.lang.String getSlotDescription()

Returns the slot description component.

Returns:

a character String description of the slot.

getManufacturerID

public java.lang.String getManufacturerID()

Returns the manufacturer ID component.

Returns:

the ID of the slot manufacturer

getFlags

public long getFlags()

Returns the flags component.

Returns:

bits flags that provide capabilities of the slot

isFlagSet

public boolean isFlagSet(long flag)

Indicates whether a given flag has been set.

Parameters:

flag - the flag being checked

Returns:

true if the flag has been set, otherwise false

getHardwareVersion

public java.lang.String getHardwareVersion()

Returns the hardware version component.

Returns:

the version number of the slot's hardware

getFirmwareVersion

public java.lang.String getFirmwareVersion()

Returns the firmware version component.

Returns:

the version number of the slot's firmware

toString

public java.lang.String toString()

Returns a String representation of the SlotInfo object.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the SlotInfo object

toString

public java.lang.String toString(boolean flagNames)

Returns a String representation of the SlotInfo object.

Parameters:

flagNames - this indicates that the flags component should be represented as a list of the flags that have been set; otherwise the actual flag value will be returned

Returns:

a String representation of the SlotInfo object.