|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception java.lang.RuntimeException atg.rest.RestRuntimeException
public class RestRuntimeException
The RestRuntimeException class. Note that all RestRuntimeExceptions require that a servlet response status code be supplied in order to appropriately set the status on the response object. The error code must be an http status code from the HttpServletResponse object.
Exception
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
RestRuntimeException(java.lang.String pMessage,
javax.servlet.http.HttpServletResponse pResponse,
int pErrorCode)
A constructor which takes a message, response object and error code. |
|
RestRuntimeException(java.lang.String pMessage,
javax.servlet.ServletResponse pResponse,
int pErrorCode)
A constructor which takes a message, a servlet response object and error code. |
|
RestRuntimeException(java.lang.String pMessage,
java.lang.Throwable pCause,
javax.servlet.http.HttpServletResponse pResponse,
int pErrorCode)
A constructor which takes a source exception, response object and error code. |
|
RestRuntimeException(java.lang.Throwable pCause,
javax.servlet.http.HttpServletResponse pResponse,
int pErrorCode)
A constructor which takes a source exception, response object and error code. |
Method Summary | |
---|---|
int |
getErrorCode()
Returns the error code that was set into the response object for this exception. |
void |
setErrorCode(int pErrorCode)
Sets the error code that was set into the response object for this exception |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public RestRuntimeException(java.lang.String pMessage, javax.servlet.http.HttpServletResponse pResponse, int pErrorCode)
pMessage
- an error message describing the REST exception.pResponse
- the servlet response objectpErrorCode
- an error code to set into the response object. This should be one of the error codes
defined in javax.servlet.http.HttpServletResponse.HttpServletResponse
public RestRuntimeException(java.lang.String pMessage, javax.servlet.ServletResponse pResponse, int pErrorCode)
pMessage
- an error message describing the REST exception.pResponse
- the servlet response objectpErrorCode
- an error code to set into the response object. This should be one of the error codes
defined in javax.servlet.http.HttpServletResponse.HttpServletResponse
public RestRuntimeException(java.lang.Throwable pCause, javax.servlet.http.HttpServletResponse pResponse, int pErrorCode)
pCause
- the source exceptionpResponse
- the servlet response objectpErrorCode
- an error code to set into the response object. This should be one of the error codes
defined in javax.servlet.http.HttpServletResponse.HttpServletResponse
public RestRuntimeException(java.lang.String pMessage, java.lang.Throwable pCause, javax.servlet.http.HttpServletResponse pResponse, int pErrorCode)
pMessage
- an error message describing the REST exception.pCause
- the source exceptionpResponse
- the servlet response objectpErrorCode
- an error code to set into the response object. This should be one of the error codes
defined in javax.servlet.http.HttpServletResponse.HttpServletResponse
Method Detail |
---|
public int getErrorCode()
public void setErrorCode(int pErrorCode)
pErrorCode
- the error code that was set into the response object for this exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |