Package com.dnanexus.exceptions

Class DXAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.dnanexus.exceptions.DXAPIException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InternalErrorException, InvalidAuthenticationException, InvalidInputException, InvalidStateException, InvalidTypeException, OrgExpiredException, PermissionDeniedException, ResourceNotFoundException, ServiceUnavailableException, SpendingLimitExceededException

public class DXAPIException
extends RuntimeException

Represents any response from the API server other than HTTP code 200 (OK).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DXAPIException(String message, int statusCode)	Initializes a new exception with the specified message and HTTP status code.

Method Summary

Modifier and Type	Method	Description
static DXAPIException	getInstance(String errorType, String errorMessage, int statusCode)	Constructs a DXAPIException of the appropriate subclass based on the errorType.
int	getStatusCode()	Returns the HTTP status code associated with the error.
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DXAPIException

public DXAPIException(String message,
                      int statusCode)

Initializes a new exception with the specified message and HTTP status code.

Method Detail

getInstance

public static DXAPIException getInstance(String errorType,
                                         String errorMessage,
                                         int statusCode)

Constructs a DXAPIException of the appropriate subclass based on the errorType. If the errorType is not one of the recognized subclasses, a generic DXAPIException object is returned.

Parameters:

errorType - String containing a DNAnexus error type, e.g. InvalidInput

errorMessage - String indicating the nature of the error.

statusCode - HTTP status code of the response body.

Returns:

Instance of DXAPIException or one of its subclasses.

getStatusCode

public int getStatusCode()

Returns the HTTP status code associated with the error.

toString

public String toString()

Overrides:

toString in class Throwable