Top Description Inners Fields Constructors Methods
sun.security.pkcs11.wrapper

public Class PKCS11Exception

extends Exception
Class Inheritance
Imports
java.io.Serial, java.util.*

This is the superclass of all checked exceptions used by this package. An exception of this class indicates that a function call to the underlying PKCS#11 module returned a value not equal to CKR_OK. The application can get the returned value by calling getErrorCode(). A return value not equal to CKR_OK is the only reason for such an exception to be thrown. PKCS#11 defines the meaning of an error-code, which may depend on the context in which the error occurs.
Author
Karl Scheibelhofer

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static enum

Field Summary

Modifier and TypeField and Description
protected long
errorCode

The code of the error which was the reason for this exception.

protected String
private static final long

Constructor Summary

AccessConstructor and Description
public
PKCS11Exception(long errorCode, String extraInfo)

Constructor taking the error code (the CKR_* constants in PKCS#11) and extra info for error message.

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

The error code; e.g. 0x00000030.
getErrorCode
()

Returns the PKCS#11 error code.

public String

Returns:

The message or the error code; e.g. "CKR_DEVICE_ERROR" or "0x00000030".
getMessage
()

Overrides java.lang.Throwable.getMessage.

This method gets the corresponding text error message from a property file.

private static String
lookup(long errorCode)

public boolean

Returns:

true if the error code matches the specified enum value.
match
(PKCS11Exception.RV errorEnum)

Returns true if the error code matches the specified enum value.

Field Detail

errorCodeback to summary
protected long errorCode

The code of the error which was the reason for this exception.

errorMsgback to summary
protected String errorMsg
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Exception.serialVersionUID.

Annotations
@Serial

Constructor Detail

PKCS11Exceptionback to summary
public PKCS11Exception(long errorCode, String extraInfo)

Constructor taking the error code (the CKR_* constants in PKCS#11) and extra info for error message.

Method Detail

getErrorCodeback to summary
public long getErrorCode()

Returns the PKCS#11 error code.

Returns:long

The error code; e.g. 0x00000030.

getMessageback to summary
public String getMessage()

Overrides java.lang.Throwable.getMessage.

This method gets the corresponding text error message from a property file. If this file is not available, it returns the error code as a hex-string.

Returns:String

The message or the error code; e.g. "CKR_DEVICE_ERROR" or "0x00000030".

lookupback to summary
private static String lookup(long errorCode)
matchback to summary
public boolean match(PKCS11Exception.RV errorEnum)

Returns true if the error code matches the specified enum value.

Returns:boolean

true if the error code matches the specified enum value.

sun.security.pkcs11.wrapper back to summary

public final Enum PKCS11Exception.RV

extends Enum<PKCS11Exception.RV>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
public static final PKCS11Exception.RV
private final long

Constructor Summary

AccessConstructor and Description
private
RV(long value)

Method Summary

Modifier and TypeMethod and Description
public static PKCS11Exception.RV
public static PKCS11Exception.RV[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CKR_ACTION_PROHIBITEDback to summary
public static final PKCS11Exception.RV CKR_ACTION_PROHIBITED
CKR_AEAD_DECRYPT_FAILEDback to summary
public static final PKCS11Exception.RV CKR_AEAD_DECRYPT_FAILED
CKR_ARGUMENTS_BADback to summary
public static final PKCS11Exception.RV CKR_ARGUMENTS_BAD
CKR_ATTRIBUTE_READ_ONLYback to summary
public static final PKCS11Exception.RV CKR_ATTRIBUTE_READ_ONLY
CKR_ATTRIBUTE_SENSITIVEback to summary
public static final PKCS11Exception.RV CKR_ATTRIBUTE_SENSITIVE
CKR_ATTRIBUTE_TYPE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_ATTRIBUTE_TYPE_INVALID
CKR_ATTRIBUTE_VALUE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_ATTRIBUTE_VALUE_INVALID
CKR_BUFFER_TOO_SMALLback to summary
public static final PKCS11Exception.RV CKR_BUFFER_TOO_SMALL
CKR_CANCELback to summary
public static final PKCS11Exception.RV CKR_CANCEL
CKR_CANT_LOCKback to summary
public static final PKCS11Exception.RV CKR_CANT_LOCK
CKR_CRYPTOKI_ALREADY_INITIALIZEDback to summary
public static final PKCS11Exception.RV CKR_CRYPTOKI_ALREADY_INITIALIZED
CKR_CRYPTOKI_NOT_INITIALIZEDback to summary
public static final PKCS11Exception.RV CKR_CRYPTOKI_NOT_INITIALIZED
CKR_CURVE_NOT_SUPPORTEDback to summary
public static final PKCS11Exception.RV CKR_CURVE_NOT_SUPPORTED
CKR_DATA_INVALIDback to summary
public static final PKCS11Exception.RV CKR_DATA_INVALID
CKR_DATA_LEN_RANGEback to summary
public static final PKCS11Exception.RV CKR_DATA_LEN_RANGE
CKR_DEVICE_ERRORback to summary
public static final PKCS11Exception.RV CKR_DEVICE_ERROR
CKR_DEVICE_MEMORYback to summary
public static final PKCS11Exception.RV CKR_DEVICE_MEMORY
CKR_DEVICE_REMOVEDback to summary
public static final PKCS11Exception.RV CKR_DEVICE_REMOVED
CKR_DOMAIN_PARAMS_INVALIDback to summary
public static final PKCS11Exception.RV CKR_DOMAIN_PARAMS_INVALID
CKR_ENCRYPTED_DATA_INVALIDback to summary
public static final PKCS11Exception.RV CKR_ENCRYPTED_DATA_INVALID
CKR_ENCRYPTED_DATA_LEN_RANGEback to summary
public static final PKCS11Exception.RV CKR_ENCRYPTED_DATA_LEN_RANGE
CKR_EXCEEDED_MAX_ITERATIONSback to summary
public static final PKCS11Exception.RV CKR_EXCEEDED_MAX_ITERATIONS
CKR_FIPS_SELF_TEST_FAILEDback to summary
public static final PKCS11Exception.RV CKR_FIPS_SELF_TEST_FAILED
CKR_FUNCTION_CANCELEDback to summary
public static final PKCS11Exception.RV CKR_FUNCTION_CANCELED
CKR_FUNCTION_FAILEDback to summary
public static final PKCS11Exception.RV CKR_FUNCTION_FAILED
CKR_FUNCTION_NOT_PARALLELback to summary
public static final PKCS11Exception.RV CKR_FUNCTION_NOT_PARALLEL
CKR_FUNCTION_NOT_SUPPORTEDback to summary
public static final PKCS11Exception.RV CKR_FUNCTION_NOT_SUPPORTED
CKR_FUNCTION_REJECTEDback to summary
public static final PKCS11Exception.RV CKR_FUNCTION_REJECTED
CKR_GENERAL_ERRORback to summary
public static final PKCS11Exception.RV CKR_GENERAL_ERROR
CKR_HOST_MEMORYback to summary
public static final PKCS11Exception.RV CKR_HOST_MEMORY
CKR_INFORMATION_SENSITIVEback to summary
public static final PKCS11Exception.RV CKR_INFORMATION_SENSITIVE
CKR_KEY_CHANGEDback to summary
public static final PKCS11Exception.RV CKR_KEY_CHANGED
CKR_KEY_FUNCTION_NOT_PERMITTEDback to summary
public static final PKCS11Exception.RV CKR_KEY_FUNCTION_NOT_PERMITTED
CKR_KEY_HANDLE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_KEY_HANDLE_INVALID
CKR_KEY_INDIGESTIBLEback to summary
public static final PKCS11Exception.RV CKR_KEY_INDIGESTIBLE
CKR_KEY_NEEDEDback to summary
public static final PKCS11Exception.RV CKR_KEY_NEEDED
CKR_KEY_NOT_NEEDEDback to summary
public static final PKCS11Exception.RV CKR_KEY_NOT_NEEDED
CKR_KEY_NOT_WRAPPABLEback to summary
public static final PKCS11Exception.RV CKR_KEY_NOT_WRAPPABLE
CKR_KEY_SIZE_RANGEback to summary
public static final PKCS11Exception.RV CKR_KEY_SIZE_RANGE
CKR_KEY_TYPE_INCONSISTENTback to summary
public static final PKCS11Exception.RV CKR_KEY_TYPE_INCONSISTENT
CKR_KEY_UNEXTRACTABLEback to summary
public static final PKCS11Exception.RV CKR_KEY_UNEXTRACTABLE
CKR_LIBRARY_LOAD_FAILEDback to summary
public static final PKCS11Exception.RV CKR_LIBRARY_LOAD_FAILED
CKR_MECHANISM_INVALIDback to summary
public static final PKCS11Exception.RV CKR_MECHANISM_INVALID
CKR_MECHANISM_PARAM_INVALIDback to summary
public static final PKCS11Exception.RV CKR_MECHANISM_PARAM_INVALID
CKR_MUTEX_BADback to summary
public static final PKCS11Exception.RV CKR_MUTEX_BAD
CKR_MUTEX_NOT_LOCKEDback to summary
public static final PKCS11Exception.RV CKR_MUTEX_NOT_LOCKED
CKR_NEED_TO_CREATE_THREADSback to summary
public static final PKCS11Exception.RV CKR_NEED_TO_CREATE_THREADS
CKR_NEW_PIN_MODEback to summary
public static final PKCS11Exception.RV CKR_NEW_PIN_MODE
CKR_NEXT_OTPback to summary
public static final PKCS11Exception.RV CKR_NEXT_OTP
CKR_NO_EVENTback to summary
public static final PKCS11Exception.RV CKR_NO_EVENT
CKR_OBJECT_HANDLE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_OBJECT_HANDLE_INVALID
CKR_OKback to summary
public static final PKCS11Exception.RV CKR_OK
CKR_OPERATION_ACTIVEback to summary
public static final PKCS11Exception.RV CKR_OPERATION_ACTIVE
CKR_OPERATION_CANCEL_FAILEDback to summary
public static final PKCS11Exception.RV CKR_OPERATION_CANCEL_FAILED
CKR_OPERATION_NOT_INITIALIZEDback to summary
public static final PKCS11Exception.RV CKR_OPERATION_NOT_INITIALIZED
CKR_PIN_EXPIREDback to summary
public static final PKCS11Exception.RV CKR_PIN_EXPIRED
CKR_PIN_INCORRECTback to summary
public static final PKCS11Exception.RV CKR_PIN_INCORRECT
CKR_PIN_INVALIDback to summary
public static final PKCS11Exception.RV CKR_PIN_INVALID
CKR_PIN_LEN_RANGEback to summary
public static final PKCS11Exception.RV CKR_PIN_LEN_RANGE
CKR_PIN_LOCKEDback to summary
public static final PKCS11Exception.RV CKR_PIN_LOCKED
CKR_PIN_TOO_WEAKback to summary
public static final PKCS11Exception.RV CKR_PIN_TOO_WEAK
CKR_PUBLIC_KEY_INVALIDback to summary
public static final PKCS11Exception.RV CKR_PUBLIC_KEY_INVALID
CKR_RANDOM_NO_RNGback to summary
public static final PKCS11Exception.RV CKR_RANDOM_NO_RNG
CKR_RANDOM_SEED_NOT_SUPPORTEDback to summary
public static final PKCS11Exception.RV CKR_RANDOM_SEED_NOT_SUPPORTED
CKR_SAVED_STATE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_SAVED_STATE_INVALID
CKR_SESSION_CLOSEDback to summary
public static final PKCS11Exception.RV CKR_SESSION_CLOSED
CKR_SESSION_COUNTback to summary
public static final PKCS11Exception.RV CKR_SESSION_COUNT
CKR_SESSION_EXISTSback to summary
public static final PKCS11Exception.RV CKR_SESSION_EXISTS
CKR_SESSION_HANDLE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_SESSION_HANDLE_INVALID
CKR_SESSION_PARALLEL_NOT_SUPPORTEDback to summary
public static final PKCS11Exception.RV CKR_SESSION_PARALLEL_NOT_SUPPORTED
CKR_SESSION_READ_ONLYback to summary
public static final PKCS11Exception.RV CKR_SESSION_READ_ONLY
CKR_SESSION_READ_ONLY_EXISTSback to summary
public static final PKCS11Exception.RV CKR_SESSION_READ_ONLY_EXISTS
CKR_SESSION_READ_WRITE_SO_EXISTSback to summary
public static final PKCS11Exception.RV CKR_SESSION_READ_WRITE_SO_EXISTS
CKR_SIGNATURE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_SIGNATURE_INVALID
CKR_SIGNATURE_LEN_RANGEback to summary
public static final PKCS11Exception.RV CKR_SIGNATURE_LEN_RANGE
CKR_SLOT_ID_INVALIDback to summary
public static final PKCS11Exception.RV CKR_SLOT_ID_INVALID
CKR_STATE_UNSAVEABLEback to summary
public static final PKCS11Exception.RV CKR_STATE_UNSAVEABLE
CKR_TEMPLATE_INCOMPLETEback to summary
public static final PKCS11Exception.RV CKR_TEMPLATE_INCOMPLETE
CKR_TEMPLATE_INCONSISTENTback to summary
public static final PKCS11Exception.RV CKR_TEMPLATE_INCONSISTENT
CKR_TOKEN_NOT_PRESENTback to summary
public static final PKCS11Exception.RV CKR_TOKEN_NOT_PRESENT
CKR_TOKEN_NOT_RECOGNIZEDback to summary
public static final PKCS11Exception.RV CKR_TOKEN_NOT_RECOGNIZED
CKR_TOKEN_RESOURCE_EXCEEDEDback to summary
public static final PKCS11Exception.RV CKR_TOKEN_RESOURCE_EXCEEDED
CKR_TOKEN_WRITE_PROTECTEDback to summary
public static final PKCS11Exception.RV CKR_TOKEN_WRITE_PROTECTED
CKR_UNWRAPPING_KEY_HANDLE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_UNWRAPPING_KEY_HANDLE_INVALID
CKR_UNWRAPPING_KEY_SIZE_RANGEback to summary
public static final PKCS11Exception.RV CKR_UNWRAPPING_KEY_SIZE_RANGE
CKR_UNWRAPPING_KEY_TYPE_INCONSISTENTback to summary
public static final PKCS11Exception.RV CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT
CKR_USER_ALREADY_LOGGED_INback to summary
public static final PKCS11Exception.RV CKR_USER_ALREADY_LOGGED_IN
CKR_USER_ANOTHER_ALREADY_LOGGED_INback to summary
public static final PKCS11Exception.RV CKR_USER_ANOTHER_ALREADY_LOGGED_IN
CKR_USER_NOT_LOGGED_INback to summary
public static final PKCS11Exception.RV CKR_USER_NOT_LOGGED_IN
CKR_USER_PIN_NOT_INITIALIZEDback to summary
public static final PKCS11Exception.RV CKR_USER_PIN_NOT_INITIALIZED
CKR_USER_TOO_MANY_TYPESback to summary
public static final PKCS11Exception.RV CKR_USER_TOO_MANY_TYPES
CKR_USER_TYPE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_USER_TYPE_INVALID
CKR_VENDOR_DEFINEDback to summary
public static final PKCS11Exception.RV CKR_VENDOR_DEFINED
CKR_WRAPPED_KEY_INVALIDback to summary
public static final PKCS11Exception.RV CKR_WRAPPED_KEY_INVALID
CKR_WRAPPED_KEY_LEN_RANGEback to summary
public static final PKCS11Exception.RV CKR_WRAPPED_KEY_LEN_RANGE
CKR_WRAPPING_KEY_HANDLE_INVALIDback to summary
public static final PKCS11Exception.RV CKR_WRAPPING_KEY_HANDLE_INVALID
CKR_WRAPPING_KEY_SIZE_RANGEback to summary
public static final PKCS11Exception.RV CKR_WRAPPING_KEY_SIZE_RANGE
CKR_WRAPPING_KEY_TYPE_INCONSISTENTback to summary
public static final PKCS11Exception.RV CKR_WRAPPING_KEY_TYPE_INCONSISTENT
valueback to summary
private final long value

Constructor Detail

RVback to summary
private RV(long value)

Method Detail

valueOfback to summary
public static PKCS11Exception.RV valueOf(String name)
valuesback to summary
public static PKCS11Exception.RV[] values()
sun.security.pkcs11.wrapper back to summary

public final Enum PKCS11Exception.RV_VENDOR

extends Enum<PKCS11Exception.RV_VENDOR>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final PKCS11Exception.RV_VENDOR
public static final PKCS11Exception.RV_VENDOR
private final long

Constructor Summary

AccessConstructor and Description
private
RV_VENDOR(long value)

Method Summary

Modifier and TypeMethod and Description
public static PKCS11Exception.RV_VENDOR
public static PKCS11Exception.RV_VENDOR[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CKR_NSS_CERTDB_FAILEDback to summary
public static final PKCS11Exception.RV_VENDOR CKR_NSS_CERTDB_FAILED
CKR_NSS_KEYDB_FAILEDback to summary
public static final PKCS11Exception.RV_VENDOR CKR_NSS_KEYDB_FAILED
valueback to summary
private final long value

Constructor Detail

RV_VENDORback to summary
private RV_VENDOR(long value)

Method Detail

valueOfback to summary
public static PKCS11Exception.RV_VENDOR valueOf(String name)
valuesback to summary
public static PKCS11Exception.RV_VENDOR[] values()