TokenInfo (PKCS#11 wrapper 1.4.1 API)

java.lang.Object
- iaik.pkcs.pkcs11.TokenInfo

```
public class TokenInfo
extends Object
```
Objects of this class provide information about a token. Serial number, manufacturer, free memory,... . Notice that this is just a snapshot of the token's status at the time this object was created.

Version:

1.0

Author:

Karl Scheibelhofer

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`EFFECTIVELY_INFINITE` This is the value which can be used for ulMaxSessionCount and ulMaxRwSessionCount to express an infinite number.
`static long`	`UNAVAILABLE_INFORMATION` This is the value which can be used for ulMaxSessionCount, ulSessionCount, ulMaxRwSessionCount, ulRwSessionCount, ulTotalPublicMemory, ulFreePublicMemory, ulTotalPrivateMemory, and ulFreePrivateMemory to signal that the information is unavailable.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TokenInfo(sun.security.pkcs11.wrapper.CK_TOKEN_INFO ckTokenInfo)` Constructor taking CK_TOKEN_INFO as given returned by PKCS11.C_GetTokenInfo.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object otherObject)` Compares all member variables of this object with the other object.
`Version`	`getFirmwareVersion()` Get the version of the token's firmware.
`long`	`getFlags()` Return the token flags.
`long`	`getFreePrivateMemory()` Get the amount of free memory for private objects.
`long`	`getFreePublicMemory()` Get the amount of free memory for public objects.
`Version`	`getHardwareVersion()` Get the version of the token's hardware.
`String`	`getLabel()` Get the label of this token.
`String`	`getManufacturerID()` Get the manufacturer identifier.
`long`	`getMaxPinLen()` Get the maximum length for the PIN.
`long`	`getMaxRwSessionCount()` Get the maximum allowed number of (open) concurrent read-write sessions.
`long`	`getMaxSessionCount()` Get the maximum allowed number of (open) concurrent sessions.
`long`	`getMinPinLen()` Get the minimum length for the PIN.
`String`	`getModel()` Get the model of this token.
`long`	`getRwSessionCount()` Get the current number of open read-write sessions.
`String`	`getSerialNumber()` Get the serial number of this token.
`long`	`getSessionCount()` Get the current number of open sessions.
`Date`	`getTime()` Get the current time of the token's clock.
`long`	`getTotalPrivateMemory()` Get the total amount of memory for private objects.
`long`	`getTotalPublicMemory()` Get the total amount of memory for public objects.
`int`	`hashCode()` The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
`boolean`	`isClockOnToken()` Check, if the token has an own clock.
`boolean`	`isDualCryptoOperations()` Check, if the token supports dual crypto operations.
`boolean`	`isLoginRequired()` Check, if the token requires the user to log in before certain operations can be performed.
`boolean`	`isProtectedAuthenticationPath()` Check, if the token has an protected authentication path.
`boolean`	`isRestoreKeyNotNeeded()` Check, if a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session.
`boolean`	`isRNG()` Check, if the token has a random number generator.
`boolean`	`isSecondaryAuthentication()` Check, if the token supports secondary authentication for private key objects.
`boolean`	`isSoPinCountLow()` Check, if the security officer-PIN has been entered incorrectly at least once since the last successful authentication.
`boolean`	`isSoPinFinalTry()` Check, if the security officer has just one try left to supply the correct PIN before the security officer-PIN gets locked.
`boolean`	`isSoPinLocked()` Check, if the security officer-PIN is locked.
`boolean`	`isSoPinToBeChanged()` Check, if the security officer PIN value is the default value set by token initialization or manufacturing.
`boolean`	`isTokenInitialized()` Check, if the token is already initialized.
`boolean`	`isUserPinCountLow()` Check, if the user-PIN has been entered incorrectly at least once since the last successful authentication.
`boolean`	`isUserPinFinalTry()` Check, if the user has just one try left to supply the correct PIN before the user-PIN gets locked.
`boolean`	`isUserPinInitialized()` Check, if the user-PIN is already initialized.
`boolean`	`isUserPinLocked()` Check, if the user-PIN is locked.
`boolean`	`isUserPinToBeChanged()` Check, if the user PIN value is the default value set by token initialization or manufacturing.
`boolean`	`isWriteProtected()` Check, if the token is write protected.
`String`	`toString()` Returns the string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EFFECTIVELY_INFINITE
```
public static final long EFFECTIVELY_INFINITE
```
    This is the value which can be used for ulMaxSessionCount and ulMaxRwSessionCount to express an infinite number.
    
    See Also:
    
    Constant Field Values
  - UNAVAILABLE_INFORMATION
```
public static final long UNAVAILABLE_INFORMATION
```
    This is the value which can be used for ulMaxSessionCount, ulSessionCount, ulMaxRwSessionCount, ulRwSessionCount, ulTotalPublicMemory, ulFreePublicMemory, ulTotalPrivateMemory, and ulFreePrivateMemory to signal that the information is unavailable.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TokenInfo
```
protected TokenInfo(sun.security.pkcs11.wrapper.CK_TOKEN_INFO ckTokenInfo)
```
    Constructor taking CK_TOKEN_INFO as given returned by PKCS11.C_GetTokenInfo.
    
    Parameters:
    
    ckTokenInfo - The CK_TOKEN_INFO object as returned by PKCS11.C_GetTokenInfo.
- Method Detail
  - getLabel
```
public String getLabel()
```
    Get the label of this token.
    
    Returns:
    
    The label of this token.
  - getManufacturerID
```
public String getManufacturerID()
```
    Get the manufacturer identifier.
    
    Returns:
    
    A string identifying the manufacturer of this token.
  - getModel
```
public String getModel()
```
    Get the model of this token.
    
    Returns:
    
    A string specifying the model of this token.
  - getSerialNumber
```
public String getSerialNumber()
```
    Get the serial number of this token.
    
    Returns:
    
    A string holding the serial number of this token.
  - getMaxSessionCount
```
public long getMaxSessionCount()
```
    Get the maximum allowed number of (open) concurrent sessions.
    
    Returns:
    
    The maximum allowed number of (open) concurrent sessions.
  - getSessionCount
```
public long getSessionCount()
```
    Get the current number of open sessions.
    
    Returns:
    
    The current number of open sessions.
  - getMaxRwSessionCount
```
public long getMaxRwSessionCount()
```
    Get the maximum allowed number of (open) concurrent read-write sessions.
    
    Returns:
    
    The maximum allowed number of (open) concurrent read-write sessions.
  - getRwSessionCount
```
public long getRwSessionCount()
```
    Get the current number of open read-write sessions.
    
    Returns:
    
    The current number of open read-write sessions.
  - getMaxPinLen
```
public long getMaxPinLen()
```
    Get the maximum length for the PIN.
    
    Returns:
    
    The maximum length for the PIN.
  - getMinPinLen
```
public long getMinPinLen()
```
    Get the minimum length for the PIN.
    
    Returns:
    
    The minimum length for the PIN.
  - getTotalPublicMemory
```
public long getTotalPublicMemory()
```
    Get the total amount of memory for public objects.
    
    Returns:
    
    The total amount of memory for public objects.
  - getFreePublicMemory
```
public long getFreePublicMemory()
```
    Get the amount of free memory for public objects.
    
    Returns:
    
    The amount of free memory for public objects.
  - getTotalPrivateMemory
```
public long getTotalPrivateMemory()
```
    Get the total amount of memory for private objects.
    
    Returns:
    
    The total amount of memory for private objects.
  - getFreePrivateMemory
```
public long getFreePrivateMemory()
```
    Get the amount of free memory for private objects.
    
    Returns:
    
    The amount of free memory for private objects.
  - getHardwareVersion
```
public Version getHardwareVersion()
```
    Get the version of the token's hardware.
    
    Returns:
    
    The version of the token's hardware.
  - getFirmwareVersion
```
public Version getFirmwareVersion()
```
    Get the version of the token's firmware.
    
    Returns:
    
    The version of the token's firmware.
  - getTime
```
public Date getTime()
```
    Get the current time of the token's clock. This value does only make sense if the token has a clock. Remind that, this is the time this object was created and not the time the application called this method.
    
    Returns:
    
    The current time on the token's clock.
    
    See Also:
    
    isClockOnToken()
  - getFlags
```
public long getFlags()
```
    Return the token flags.
    
    Returns:
    
    the token flags.
  - isRNG
```
public boolean isRNG()
```
    Check, if the token has a random number generator.
    
    Returns:
    
    True, if the token has a random number generator. False, otherwise.
  - isWriteProtected
```
public boolean isWriteProtected()
```
    Check, if the token is write protected.
    
    Returns:
    
    True, if the token is write protected. False, otherwise.
  - isLoginRequired
```
public boolean isLoginRequired()
```
    Check, if the token requires the user to log in before certain operations can be performed.
    
    Returns:
    
    True, if the token requires the user to log in before certain operations can be performed. False, otherwise.
  - isUserPinInitialized
```
public boolean isUserPinInitialized()
```
    Check, if the user-PIN is already initialized.
    
    Returns:
    
    True, if the user-PIN is already initialized. False, otherwise.
  - isRestoreKeyNotNeeded
```
public boolean isRestoreKeyNotNeeded()
```
    Check, if a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session.
    
    Returns:
    
    True, if a successful save of a session's cryptographic operations state always contains all keys needed to restore the state of the session. False, otherwise.
  - isClockOnToken
```
public boolean isClockOnToken()
```
    Check, if the token has an own clock.
    
    Returns:
    
    True, if the token has its own clock. False, otherwise.
  - isProtectedAuthenticationPath
```
public boolean isProtectedAuthenticationPath()
```
    Check, if the token has an protected authentication path. This means that a user may log in without providing a PIN to the login method, because the token has other means to authenticate the user; e.g. a PIN-pad on the reader or some biometric authentication.
    
    Returns:
    
    True, if the token has an protected authentication path. False, otherwise.
  - isDualCryptoOperations
```
public boolean isDualCryptoOperations()
```
    Check, if the token supports dual crypto operations.
    
    Returns:
    
    True, if the token supports dual crypto operations. False, otherwise.
  - isTokenInitialized
```
public boolean isTokenInitialized()
```
    Check, if the token is already initialized.
    
    Returns:
    
    True, if the token is already initialized. False, otherwise.
  - isSecondaryAuthentication
```
public boolean isSecondaryAuthentication()
```
    Check, if the token supports secondary authentication for private key objects.
    
    Returns:
    
    True, if the token supports secondary authentication. False, otherwise.
  - isUserPinCountLow
```
public boolean isUserPinCountLow()
```
    Check, if the user-PIN has been entered incorrectly at least once since the last successful authentication.
    
    Returns:
    
    True, if the the user-PIN has been entered incorrectly at least one since the last successful authentication. False, otherwise.
  - isUserPinFinalTry
```
public boolean isUserPinFinalTry()
```
    Check, if the user has just one try left to supply the correct PIN before the user-PIN gets locked.
    
    Returns:
    
    True, if the user has just one try left to supply the correct PIN before the user-PIN gets locked. False, otherwise.
  - isUserPinLocked
```
public boolean isUserPinLocked()
```
    Check, if the user-PIN is locked.
    
    Returns:
    
    True, if the user-PIN is locked. False, otherwise.
  - isUserPinToBeChanged
```
public boolean isUserPinToBeChanged()
```
    Check, if the user PIN value is the default value set by token initialization or manufacturing.
    
    Returns:
    
    True, if the user PIN value is the default value set by token initialization or manufacturing. False, otherwise.
  - isSoPinCountLow
```
public boolean isSoPinCountLow()
```
    Check, if the security officer-PIN has been entered incorrectly at least once since the last successful authentication.
    
    Returns:
    
    True, if the the security officer-PIN has been entered incorrectly at least one since the last successful authentication. False, otherwise.
  - isSoPinFinalTry
```
public boolean isSoPinFinalTry()
```
    Check, if the security officer has just one try left to supply the correct PIN before the security officer-PIN gets locked.
    
    Returns:
    
    True, if the security officer has just one try left to supply the correct PIN before the security officer-PIN gets locked. False, otherwise.
  - isSoPinLocked
```
public boolean isSoPinLocked()
```
    Check, if the security officer-PIN is locked.
    
    Returns:
    
    True, if the security officer-PIN is locked. False, otherwise.
  - isSoPinToBeChanged
```
public boolean isSoPinToBeChanged()
```
    Check, if the security officer PIN value is the default value set by token initialization or manufacturing.
    
    Returns:
    
    True, if the security officer PIN value is the default value set by token initialization or manufacturing. False, otherwise.
  - toString
```
public String toString()
```
    Returns the string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of object
  - equals
```
public boolean equals(Object otherObject)
```
    Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    otherObject - The other TokenInfo object.
    
    Returns:
    
    True, if other is an instance of Info and all member variables of both objects are equal. False, otherwise.
  - hashCode
```
public int hashCode()
```
    The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code of this object. Gained from the label, manufacturerID, model and serialNumber.

Class TokenInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EFFECTIVELY_INFINITE

UNAVAILABLE_INFORMATION

Constructor Detail

TokenInfo

Method Detail

getLabel

getManufacturerID

getModel

getSerialNumber

getMaxSessionCount

getSessionCount

getMaxRwSessionCount

getRwSessionCount

getMaxPinLen

getMinPinLen

getTotalPublicMemory

getFreePublicMemory

getTotalPrivateMemory

getFreePrivateMemory

getHardwareVersion

getFirmwareVersion

getTime

getFlags

isRNG

isWriteProtected

isLoginRequired

isUserPinInitialized

isRestoreKeyNotNeeded

isClockOnToken

isProtectedAuthenticationPath

isDualCryptoOperations

isTokenInitialized

isSecondaryAuthentication

isUserPinCountLow

isUserPinFinalTry

isUserPinLocked

isUserPinToBeChanged

isSoPinCountLow

isSoPinFinalTry

isSoPinLocked

isSoPinToBeChanged

toString

equals

hashCode