public class RestException
extends java.lang.RuntimeException
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 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.
|
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.
|
public static java.lang.String CLASS_VERSION
public static final java.lang.String ROOT_CAUSE_KEY
public static final java.lang.String HTTP_STATUS_CODE_KEY
public static final java.lang.String ERROR_CODE_KEY
public static final java.lang.String DEV_MESSAGE_KEY
public static final java.lang.String MORE_INFO_URL_KEY
protected java.lang.String mErrorCode
protected java.lang.String mErrorPath
protected int mStatusCode
protected java.sql.SQLException mSQLException
protected java.lang.String mDevMessage
protected java.lang.String mMoreInfo
protected boolean mInputError
protected java.util.List<java.lang.Exception> mErrors
protected java.lang.Throwable mRootCause
protected boolean mWrapper
public RestException(java.lang.String pMessage)
pMessage
- error messagepublic RestException(java.lang.String pMessage, java.lang.String pErrorCode)
pMessage
- error messagepErrorCode
- error codepublic RestException(java.lang.String pMessage, java.lang.String pErrorCode, java.sql.SQLException pSQLException)
pMessage
- error messagepErrorCode
- error codepSQLException
- sql exceptionpublic RestException(int pStatusCode, java.lang.String pMessage, java.util.List<java.lang.Exception> pErrors)
pStatusCode
- HTTP error response codepMessage
- error messagepErrors
- errors that have occurredpublic RestException(int pStatusCode, java.lang.String pMessage, java.lang.Throwable pException)
pStatusCode
- HTTP error response codepMessage
- error messagepException
- error that has occurredpublic RestException(java.lang.String pErrorCode, java.lang.String pMessage, java.lang.Throwable pException)
pErrorCode
- internal error codepMessage
- error messagepException
- error that has occurredpublic RestException(int pStatusCode, java.lang.String pMessage)
pStatusCode
- HTTP error response codepMessage
- error messagepublic RestException(java.util.List<java.lang.Exception> pErrors)
pErrors
- list of errors that have occurredpublic 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)
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)
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)
public java.lang.String getErrorCode()
public void setErrorCode(java.lang.String pErrorCode)
pErrorCode
- error codepublic java.lang.String getErrorPath()
public void setErrorPath(java.lang.String pErrorPath)
pErrorPath
- error pathpublic int getStatusCode()
public void setStatusCode(int pStatusCode)
pStatusCode
- error response codepublic java.lang.Throwable getRootCause()
public void setRootCause(java.lang.Throwable pRootCause)
pRootCause
- Throwable that was the root cause of the errorpublic java.lang.String getDevMessage()
public void setDevMessage(java.lang.String pDevMessage)
pDevMessage
- dev debug messagepublic java.lang.String getMoreInfo()
public void setMoreInfo(java.lang.String pMoreInfo)
pMoreInfo
- more info linkpublic boolean isInputError()
public void setInputError(boolean pInputError)
pInputError
- input errorpublic java.sql.SQLException getSQLException()
public void setSQLException(java.sql.SQLException pSQLException)
pSQLException
- sql exceptionpublic java.util.List<java.lang.Exception> getErrors()
public void setErrors(java.util.List<java.lang.Exception> pErrors)
pErrors
- list of errorspublic void addError(java.lang.Exception pError)
pError
- errorpublic boolean isMultiException()
public boolean isWrapper()
public void setWrapper(boolean pWrapper)
pWrapper
- true if this exception wraps the root cause.public java.lang.String toString()
toString
in class java.lang.Throwable
public java.util.Map<java.lang.String,java.lang.Object> getExtraErrorAttributes()
public void log(ApplicationLogging pLogger, java.lang.String pErrorResponse)