org.apache.juneau.rest

Class RestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.FormattedRuntimeException

org.apache.juneau.rest.RestException

All Implemented Interfaces:

Serializable

public class RestException
extends FormattedRuntimeException

Exception thrown to trigger an error HTTP status.

REST methods on subclasses of RestServlet can throw this exception to trigger an HTTP status other than the automatically-generated 404, 405, and 500 statuses.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestException(int status, String msg, Object... args) Constructor.
RestException(int status, Throwable cause) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getFullStackMessage(boolean scrubForXssVulnerabilities) Returns all error messages from all errors in this stack.
int	getOccurrence() Returns the number of times this exception occurred on this servlet.
Throwable	getRootCause() Returns the root cause of this exception.
int	getStatus() Returns the HTTP status code.
int	hashCode()
RestException	initCause(Throwable cause) Sets the inner cause for this exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RestException

public RestException(int status,
                     String msg,
                     Object... args)

Constructor.

Parameters:

status - The HTTP status code.

msg - The status message.

args - Optional MessageFormat-style arguments.

RestException

public RestException(int status,
                     Throwable cause)

Constructor.

Parameters:

status - The HTTP status code.

cause - The root exception.

Method Detail

initCause

public RestException initCause(Throwable cause)

Sets the inner cause for this exception.

Overrides:

initCause in class Throwable

Parameters:

cause - The inner cause.

Returns:

This object (for method chaining).

getRootCause

public Throwable getRootCause()

Returns the root cause of this exception.

The root cause is the first exception in the init-cause parent chain that's not one of the following:

• RestException
• InvocationTargetException

Returns:

The root cause of this exception, or null if no root cause was found.

getFullStackMessage

public String getFullStackMessage(boolean scrubForXssVulnerabilities)

Returns all error messages from all errors in this stack.

Typically useful if you want to render all the error messages in the stack, but don't want to render all the stack traces too.

Parameters:

scrubForXssVulnerabilities - If true, replaces '<', '>', and '&' characters with spaces.

Returns:

All error messages from all errors in this stack.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getOccurrence

public int getOccurrence()

Returns the number of times this exception occurred on this servlet.

Returns:

The occurrence number if @RestResource.useStackTraceHashes() is enabled, or 0 otherwise.

getStatus

public int getStatus()

Returns the HTTP status code.

Returns:

The HTTP status code.