com.entrust.toolkit.exceptions

Class CapiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.entrust.toolkit.exceptions.ExceptionWithInnerException

com.entrust.toolkit.exceptions.CapiException

All Implemented Interfaces:

java.io.Serializable

public class CapiException
extends ExceptionWithInnerException

Exception class for any problems that may occur in a method that makes calls to CAPI.

Since:

7.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CapiException() Default constructor for CapiException.
CapiException(java.lang.String message) Constructor for CapiException.
CapiException(java.lang.String message, java.lang.Exception inner) Constructs an CapiException with the specified message, caused by the specified exception
CapiException(java.lang.String message, int errorValue, java.lang.String systemErrorString) Constructs an CapiException with the specified message, caused by the specified message

Method Summary

Modifier and Type	Method and Description
Error	getSystemError() Returns the native system error that caused this exception.
java.lang.String	getSystemErrorString() Returns the text from the native system that describes the cause of this exception.

Methods inherited from class com.entrust.toolkit.exceptions.ExceptionWithInnerException

getMessageChain, getMessageChain

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

CapiException

public CapiException()

Default constructor for CapiException.

CapiException

public CapiException(java.lang.String message)

Constructor for CapiException.

Parameters:

message - the detail message of the exception.

CapiException

public CapiException(java.lang.String message,
                     java.lang.Exception inner)

Constructs an CapiException with the specified message, caused by the specified exception

Parameters:

message - the detail message of the exception

inner - the exception thrown by the inner code that was the cause of this exception

CapiException

public CapiException(java.lang.String message,
                     int errorValue,
                     java.lang.String systemErrorString)

Constructs an CapiException with the specified message, caused by the specified message

Parameters:

message - the detail message of the exception.

errorValue - the integer error value returned by a native system call.

systemErrorString - the text description of the error, returned by the native operating system.

Method Detail

getSystemError

public Error getSystemError()

Returns the native system error that caused this exception. May be null if the exception was not caused by a native call.

Returns:

the native system error that caused this exception.

getSystemErrorString

public java.lang.String getSystemErrorString()

Returns the text from the native system that describes the cause of this exception. May be null if the exception was not caused by a native call.

Returns:

the text from the native system that describes the cause of this exception.