com.simplify.payments.exception

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.simplify.payments.exception.ApiException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ApiCommunicationException, AuthenticationException, InvalidRequestException, NotAllowedException, ObjectNotFoundException, SystemException

public class ApiException
extends java.lang.Exception

Base class for all API exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiException() Constructs an ApiException with no detail message.
ApiException(int status, java.util.Map<? extends java.lang.String,? extends java.lang.Object> errorData) Constructs an ApiException with the specified details status and error data.
ApiException(java.lang.String s) Constructs an ApiException with the specified detail message.
ApiException(java.lang.String s, java.lang.Throwable cause) Constructs an ApiException with the specified detail message and cause.
ApiException(java.lang.Throwable cause) Constructs an ApiCommunicationException with the specified cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe() Returns a string describing the exception.
java.lang.String	getErrorCode() Returns the error code for this exception.
java.util.Map<? extends java.lang.String,? extends java.lang.Object>	getErrorData() Returns the API error data for this exception.
java.lang.String	getMessage() Returns the string detail message for this exception.
java.lang.String	getReference() Returns the reference string for this exception.
int	getStatus() Returns the HTTP status code for this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

ApiException

public ApiException()

Constructs an ApiException with no detail message.

ApiException

public ApiException(java.lang.String s)

Constructs an ApiException with the specified detail message.

Parameters:

s - the detail message.

ApiException

public ApiException(java.lang.String s,
                    java.lang.Throwable cause)

Constructs an ApiException with the specified detail message and cause.

Parameters:

s - the detail message.

cause - the detail message.

ApiException

public ApiException(java.lang.Throwable cause)

Constructs an ApiCommunicationException with the specified cause.

Parameters:

cause - the detail message.

ApiException

public ApiException(int status,
                    java.util.Map<? extends java.lang.String,? extends java.lang.Object> errorData)

Constructs an ApiException with the specified details status and error data.

Parameters:

status - the HTTP status code

errorData - a map representing the error details returned by the API. The map is expected to contain String value for the key "reference" and a map containing the detailed error data for the key "key". This map in turn is expected to contain String values for the keys "code" and "message".

Method Detail

getErrorData

public java.util.Map<? extends java.lang.String,? extends java.lang.Object> getErrorData()

Returns the API error data for this exception.

Returns:

a map representing the error data for this exception (which may be null).

getReference

public java.lang.String getReference()

Returns the reference string for this exception.

Returns:

an ID representing a unique reference for API error (which may be null).

getErrorCode

public java.lang.String getErrorCode()

Returns the error code for this exception.

Returns:

a string representing the API error code (which may be null).

getStatus

public int getStatus()

Returns the HTTP status code for this exception.

Returns:

an integer representing the HTTP status code for this API error (or 0 if there is no status)

getMessage

public java.lang.String getMessage()

Returns the string detail message for this exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

a string representing the API error code or the message detail used to construct the exception (which may be null).

describe

public java.lang.String describe()

Returns a string describing the exception.

Returns:

a string describing the exception.