com.emc.esu.api

Class EsuException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.emc.esu.api.EsuException

All Implemented Interfaces:

java.io.Serializable

public class EsuException
extends java.lang.RuntimeException

Base ESU exception class that is thrown from the API methods. Contains an error code that can be mapped to the standard ESU error codes. See the Atmos programmer's guide for a list of server error codes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EsuException(java.lang.String message) Creates a new ESU Exception with the given message.
EsuException(java.lang.String message, int http_code) Creates a new ESU exception with the given message and HTTP error code.
EsuException(java.lang.String message, int http_code, int atmos_code) Creates a new ESU exception with the given message and HTTP error code.
EsuException(java.lang.String message, java.lang.Throwable cause) Creates a new ESU exception with the given message and cause.
EsuException(java.lang.String message, java.lang.Throwable cause, int http_code) Creates a new ESU exception with the given message, code, and cause
EsuException(java.lang.String message, java.lang.Throwable cause, int http_code, int atmos_code) Creates a new ESU exception with the given message, code, and cause

Method Summary

Methods

Modifier and Type	Method and Description
int	getAtmosCode() Returns the Atmos internal error code associated with the exception.
int	getHttpCode() Returns the HTTP error code associated with the exception.
java.lang.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

EsuException

public EsuException(java.lang.String message)

Creates a new ESU Exception with the given message. The error code will be set to 0.

Parameters:

message - the error message

EsuException

public EsuException(java.lang.String message,
            int http_code)

Creates a new ESU exception with the given message and HTTP error code.

Parameters:

message - the error message

http_code - code the error code

EsuException

public EsuException(java.lang.String message,
            int http_code,
            int atmos_code)

Creates a new ESU exception with the given message and HTTP error code.

Parameters:

message - the error message

http_code - code the error code

atmos_code - detailed code the error code

EsuException

public EsuException(java.lang.String message,
            java.lang.Throwable cause)

Creates a new ESU exception with the given message and cause.

Parameters:

message - the error message

cause - the exception that caused the failure

EsuException

public EsuException(java.lang.String message,
            java.lang.Throwable cause,
            int http_code)

Creates a new ESU exception with the given message, code, and cause

Parameters:

message - the error message

cause - the exception that caused the failure

http_code - code the error code

EsuException

public EsuException(java.lang.String message,
            java.lang.Throwable cause,
            int http_code,
            int atmos_code)

Creates a new ESU exception with the given message, code, and cause

Parameters:

message - the error message

cause - the exception that caused the failure

http_code - code the error code

atmos_code - detailed code the error code

Method Detail

getHttpCode

public int getHttpCode()

Returns the HTTP error code associated with the exception. If unknown (the error did not originate inside the ESU server), the code will be zero.

Returns:

the error code

getAtmosCode

public int getAtmosCode()

Returns the Atmos internal error code associated with the exception. If unknown (the error did not originate inside the ESU server), the code will be zero.

Returns:

the error code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable