public class

PKCS11Exception

extends Exception
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ sun.security.pkcs11.wrapper.PKCS11Exception

Class Overview

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.

Summary

Fields
protected long errorCode_ The code of the error which was the reason for this exception.
Public Constructors
PKCS11Exception(long errorCode)
Constructor taking the error code as defined for the CKR_* constants in PKCS#11.
Public Methods
long getErrorCode()
Returns the PKCS#11 error code.@preconditions
String getMessage()
This method gets the corresponding text error message from a property file.
[Expand]
Inherited Methods
From class java.lang.Throwable
From class java.lang.Object

Fields

protected long errorCode_

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

Public Constructors

public PKCS11Exception (long errorCode)

Constructor taking the error code as defined for the CKR_* constants in PKCS#11.

Public Methods

public long getErrorCode ()

Returns the PKCS#11 error code.@preconditions

Returns
  • The error code; e.g. 0x00000030.

public String 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.@preconditions

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