atg.service.jaxrs

Class RestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

atg.service.jaxrs.RestException

All Implemented Interfaces:

java.io.Serializable

public class RestException
extends java.lang.RuntimeException

RestException class that is intended to be used to handle exceptions thrown by the rest framework and any resource endpoint methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	DEV_MESSAGE_KEY
static java.lang.String	ERROR_CODE_KEY
static java.lang.String	HTTP_STATUS_CODE_KEY
protected java.lang.String	mDevMessage
protected java.lang.String	mErrorCode
protected java.lang.String	mErrorPath
protected java.util.List<java.lang.Exception>	mErrors
protected boolean	mInputError
protected java.lang.String	mMoreInfo
static java.lang.String	MORE_INFO_URL_KEY
protected java.lang.Throwable	mRootCause
protected java.sql.SQLException	mSQLException
protected int	mStatusCode
protected boolean	mWrapper
static java.lang.String	ROOT_CAUSE_KEY

Constructor Summary

Constructors

Constructor and Description
RestException(int pStatusCode, java.lang.String pMessage) Constructs a new RestException with the specified HTTP Error Response code and error message
RestException(int pStatusCode, java.lang.String pMessage, java.util.List<java.lang.Exception> pErrors) Constructs a new RestException with the specified HTTP Error Response code, error message and list of errors that have occurred.
RestException(int pStatusCode, java.lang.String pErrorCode, java.lang.String pMessage, java.lang.String pDevMessage, java.lang.String pMoreInfo, boolean pInputError, java.lang.Throwable pRootCause, java.util.List<java.lang.Exception> pErrors)
RestException(int pStatusCode, java.lang.String pErrorCode, java.lang.String pErrorPath, java.lang.String pMessage, java.lang.String pDevMessage, java.lang.String pMoreInfo, boolean pInputError, java.lang.Throwable pRootCause, java.util.List<java.lang.Exception> pErrors)
RestException(int pStatusCode, java.lang.String pErrorCode, java.lang.String pMessage, java.lang.String pDevMessage, java.lang.String pMoreInfo, java.lang.Throwable pRootCause, java.util.List<java.lang.Exception> pErrors)
RestException(int pStatusCode, java.lang.String pMessage, java.lang.Throwable pException) Constructs a new RestException with the specified HTTP Error Response code, error message and the error that has occurred.
RestException(java.util.List<java.lang.Exception> pErrors) Constructs a new RestException from a list of errors that have occurred.
RestException(java.lang.String pMessage) Constructs a new RestException with the specified error message
RestException(java.lang.String pMessage, java.lang.String pErrorCode) Constructs a new RestException with the specified error message and error code.
RestException(java.lang.String pMessage, java.lang.String pErrorCode, java.sql.SQLException pSQLException) Constructs a new RestException with the specified error message, error code and sql exception.
RestException(java.lang.String pErrorCode, java.lang.String pMessage, java.lang.Throwable pException) Constructs a new RestException with the specified Error code, error message and the error that has occurred.

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.Exception pError) Add an error to the list of errors that have occurred.
java.lang.String	getDevMessage() Get the dev debug message.
java.lang.String	getErrorCode() Return the error code.
java.lang.String	getErrorPath() Return the error path.
java.util.List<java.lang.Exception>	getErrors() Return the list of errors that have occurred.
java.util.Map<java.lang.String,java.lang.Object>	getExtraErrorAttributes() Pulls the extraneous error attributes out and puts them in a map.
java.lang.String	getMoreInfo() Return the more info link.
java.lang.Throwable	getRootCause() Get the root cause of this error
java.sql.SQLException	getSQLException() Return the sql exception.
int	getStatusCode() Return the HTTP error response code.
boolean	isInputError() Check if there was an input error.
boolean	isMultiException() Return true if an error has been added to this RestException.
boolean	isWrapper() Returns true if this RestException wraps a root cause.
void	log(ApplicationLogging pLogger, java.lang.String pErrorResponse)
void	setDevMessage(java.lang.String pDevMessage) Set the dev debug message
void	setErrorCode(java.lang.String pErrorCode) Set the error code.
void	setErrorPath(java.lang.String pErrorPath) Set the error path.
void	setErrors(java.util.List<java.lang.Exception> pErrors) Set the list of error that have occurred.
void	setInputError(boolean pInputError) Set an input error.
void	setMoreInfo(java.lang.String pMoreInfo) Set the more info link.
void	setRootCause(java.lang.Throwable pRootCause) Set the root cause of this error
void	setSQLException(java.sql.SQLException pSQLException) Set the sql exception.
void	setStatusCode(int pStatusCode) Set the HTTP error response code.
void	setWrapper(boolean pWrapper) Set to true if this RestException wraps a root cause.
java.lang.String	toString() Return a string representation of the Rest exception.

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

ROOT_CAUSE_KEY

public static final java.lang.String ROOT_CAUSE_KEY

See Also:

Constant Field Values

HTTP_STATUS_CODE_KEY

public static final java.lang.String HTTP_STATUS_CODE_KEY

See Also:

Constant Field Values

ERROR_CODE_KEY

public static final java.lang.String ERROR_CODE_KEY

See Also:

Constant Field Values

DEV_MESSAGE_KEY

public static final java.lang.String DEV_MESSAGE_KEY

See Also:

Constant Field Values

MORE_INFO_URL_KEY

public static final java.lang.String MORE_INFO_URL_KEY

See Also:

Constant Field Values

mErrorCode

protected java.lang.String mErrorCode

mErrorPath

protected java.lang.String mErrorPath

mStatusCode

protected int mStatusCode

mSQLException

protected java.sql.SQLException mSQLException

mDevMessage

protected java.lang.String mDevMessage

mMoreInfo

protected java.lang.String mMoreInfo

mInputError

protected boolean mInputError

mErrors

protected java.util.List<java.lang.Exception> mErrors

mRootCause

protected java.lang.Throwable mRootCause

mWrapper

protected boolean mWrapper

Constructor Detail

RestException

public RestException(java.lang.String pMessage)

Constructs a new RestException with the specified error message

Parameters:

pMessage - error message

RestException

public RestException(java.lang.String pMessage,
                     java.lang.String pErrorCode)

Constructs a new RestException with the specified error message and error code.

Parameters:

pMessage - error message

pErrorCode - error code

RestException

public RestException(java.lang.String pMessage,
                     java.lang.String pErrorCode,
                     java.sql.SQLException pSQLException)

Constructs a new RestException with the specified error message, error code and sql exception.

Parameters:

pMessage - error message

pErrorCode - error code

pSQLException - sql exception

RestException

public RestException(int pStatusCode,
                     java.lang.String pMessage,
                     java.util.List<java.lang.Exception> pErrors)

Constructs a new RestException with the specified HTTP Error Response code, error message and list of errors that have occurred.

Parameters:

pStatusCode - HTTP error response code

pMessage - error message

pErrors - errors that have occurred

RestException

public RestException(int pStatusCode,
                     java.lang.String pMessage,
                     java.lang.Throwable pException)

Constructs a new RestException with the specified HTTP Error Response code, error message and the error that has occurred.

Parameters:

pStatusCode - HTTP error response code

pMessage - error message

pException - error that has occurred

RestException

public RestException(java.lang.String pErrorCode,
                     java.lang.String pMessage,
                     java.lang.Throwable pException)

Constructs a new RestException with the specified Error code, error message and the error that has occurred.

Parameters:

pErrorCode - internal error code

pMessage - error message

pException - error that has occurred

RestException

public RestException(int pStatusCode,
                     java.lang.String pMessage)

Constructs a new RestException with the specified HTTP Error Response code and error message

Parameters:

pStatusCode - HTTP error response code

pMessage - error message

RestException

public RestException(java.util.List<java.lang.Exception> pErrors)

Constructs a new RestException from a list of errors that have occurred.

Parameters:

pErrors - list of errors that have occurred

RestException

public RestException(int pStatusCode,
                     java.lang.String pErrorCode,
                     java.lang.String pMessage,
                     java.lang.String pDevMessage,
                     java.lang.String pMoreInfo,
                     java.lang.Throwable pRootCause,
                     java.util.List<java.lang.Exception> pErrors)

RestException

public RestException(int pStatusCode,
                     java.lang.String pErrorCode,
                     java.lang.String pMessage,
                     java.lang.String pDevMessage,
                     java.lang.String pMoreInfo,
                     boolean pInputError,
                     java.lang.Throwable pRootCause,
                     java.util.List<java.lang.Exception> pErrors)

RestException

public RestException(int pStatusCode,
                     java.lang.String pErrorCode,
                     java.lang.String pErrorPath,
                     java.lang.String pMessage,
                     java.lang.String pDevMessage,
                     java.lang.String pMoreInfo,
                     boolean pInputError,
                     java.lang.Throwable pRootCause,
                     java.util.List<java.lang.Exception> pErrors)

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Return the error code.

Returns:

error code

setErrorCode

public void setErrorCode(java.lang.String pErrorCode)

Set the error code.

Parameters:

pErrorCode - error code

getErrorPath

public java.lang.String getErrorPath()

Return the error path.

Returns:

error path

setErrorPath

public void setErrorPath(java.lang.String pErrorPath)

Set the error path.

Parameters:

pErrorPath - error path

getStatusCode

public int getStatusCode()

Return the HTTP error response code.

Returns:

error response code

setStatusCode

public void setStatusCode(int pStatusCode)

Set the HTTP error response code.

Parameters:

pStatusCode - error response code

getRootCause

public java.lang.Throwable getRootCause()

Get the root cause of this error

Returns:

Throwable that was the root cause of the error

setRootCause

public void setRootCause(java.lang.Throwable pRootCause)

Set the root cause of this error

Parameters:

pRootCause - Throwable that was the root cause of the error

getDevMessage

public java.lang.String getDevMessage()

Get the dev debug message.

Returns:

dev debug messages

setDevMessage

public void setDevMessage(java.lang.String pDevMessage)

Set the dev debug message

Parameters:

pDevMessage - dev debug message

getMoreInfo

public java.lang.String getMoreInfo()

Return the more info link.

Returns:

more info link

setMoreInfo

public void setMoreInfo(java.lang.String pMoreInfo)

Set the more info link.

Parameters:

pMoreInfo - more info link

isInputError

public boolean isInputError()

Check if there was an input error.

Returns:

true if input error

setInputError

public void setInputError(boolean pInputError)

Set an input error.

Parameters:

pInputError - input error

getSQLException

public java.sql.SQLException getSQLException()

Return the sql exception.

Returns:

the sql exception

setSQLException

public void setSQLException(java.sql.SQLException pSQLException)

Set the sql exception.

Parameters:

pSQLException - sql exception

getErrors

public java.util.List<java.lang.Exception> getErrors()

Return the list of errors that have occurred.

Returns:

list of errors

setErrors

public void setErrors(java.util.List<java.lang.Exception> pErrors)

Set the list of error that have occurred.

Parameters:

pErrors - list of errors

addError

public void addError(java.lang.Exception pError)

Add an error to the list of errors that have occurred.

Parameters:

pError - error

isMultiException

public boolean isMultiException()

Return true if an error has been added to this RestException.

Returns:

true if errors present

isWrapper

public boolean isWrapper()

Returns true if this RestException wraps a root cause. If true the root cause should not be included in the error response.

Returns:

true if this exception wraps the root cause.

setWrapper

public void setWrapper(boolean pWrapper)

Set to true if this RestException wraps a root cause. If true the root cause should not be included in the error response.

Parameters:

pWrapper - true if this exception wraps the root cause.

toString

public java.lang.String toString()

Return a string representation of the Rest exception.

Overrides:

toString in class java.lang.Throwable

Returns:

string representation of exception

getExtraErrorAttributes

public java.util.Map<java.lang.String,java.lang.Object> getExtraErrorAttributes()

Pulls the extraneous error attributes out and puts them in a map.

Returns:

map of extra error attributes: status, error code, dev message and more info url

log

public void log(ApplicationLogging pLogger,
                java.lang.String pErrorResponse)