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
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
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".