Package org.onyx.exception

Class APIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.onyx.exception.ChainException

org.onyx.exception.APIException

All Implemented Interfaces:

Serializable

public class APIException
extends ChainException

APIException is thrown when the ledger API encounters an error handling a user request. Errors could be due to user error, or due to server issues.
Each error contains a brief description in addition to an error code. The error code can be used by technical support to diagnose the exact cause of the error.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	APIException.APIExceptionData	Additional specifics about the error, including any nested sub-errors related to individual actions.

Field Summary

Fields

Modifier and Type	Field	Description
String	chainMessage	Message describing the general nature of the error.
APIException.APIExceptionData	data	Additional specifics about the error, such as which action failed in a transaction, or for what reason (possibly null).
String	detail	Additional message about the error (possibly null).
String	requestId	Unique identifier of the request to the server.
boolean	retriable	Specifies whether the error is considered to be transient and that the request should be retried.
String	seqCode	An error code of the format "SEQXXX".
int	statusCode	HTTP status code returned by the server.

Constructor Summary

Constructors

Constructor	Description
APIException()

Method Summary

Modifier and Type	Method	Description
String	getMessage()

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

Field Details

seqCode

@SerializedName("seq_code")
@Expose
public String seqCode

An error code of the format "SEQXXX".

chainMessage

@SerializedName("message")
@Expose
public String chainMessage

Message describing the general nature of the error.

detail

@Expose
public String detail

Additional message about the error (possibly null).

data

@Expose
public APIException.APIExceptionData data

Additional specifics about the error, such as which action failed in a transaction, or for what reason (possibly null).

retriable

@Expose
public boolean retriable

Specifies whether the error is considered to be transient and that the request should be retried.

requestId

@Expose
public String requestId

Unique identifier of the request to the server.

statusCode

@Expose
public int statusCode

HTTP status code returned by the server.

Constructor Details

APIException

public APIException()

Method Details

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable