org.xipki.pkcs11.wrapper

Class PKCS11Exception

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.xipki.pkcs11.wrapper.TokenException

org.xipki.pkcs11.wrapper.PKCS11Exception

All Implemented Interfaces:

Serializable

public class PKCS11Exception
extends TokenException

This is the superclass of all checked exceptions used by this package. A PKCS11Exception 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:

Lijun Liao (xipki)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PKCS11Exception(long errorCode) Constructor taking the error code as defined for the CKR_* constants in PKCS#11.
PKCS11Exception(long errorCode, String name) Constructor taking the error code as defined for the CKR_* constants in PKCS#11.

Method Summary

Modifier and Type	Method and Description
long	getErrorCode() Returns the PKCS#11 error code.
String	getErrorName()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PKCS11Exception

public PKCS11Exception(long errorCode)

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

Parameters:

errorCode - The PKCS#11 error code (return value).

PKCS11Exception

public PKCS11Exception(long errorCode,
                       String name)

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

Parameters:

errorCode - The PKCS#11 error code (return value).

name - The error name.

Method Detail

getErrorCode

public long getErrorCode()

Returns the PKCS#11 error code.

Returns:

The error code; e.g. 0x00000030.

getErrorName

public String getErrorName()