org.apache.juneau.rest

Class RestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.rest.RestException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadRequest, Conflict, ExpectationFailed, FailedDependency, Forbidden, Gone, HttpVersionNotSupported, InsufficientStorage, InternalServerError, LengthRequired, Locked, LoopDetected, MethodNotAllowed, MisdirectedRequest, NetworkAuthenticationRequired, NotAcceptable, NotExtended, NotFound, NotImplemented, PayloadTooLarge, PreconditionFailed, PreconditionRequired, RangeNotSatisfiable, RequestHeaderFieldsTooLarge, ServiceUnavailable, TooManyRequests, Unauthorized, UnavailableForLegalReasons, UnprocessableEntity, UnsupportedMediaType, UpgradeRequired, UriTooLong, VariantAlsoNegotiates

Deprecated.

Use HttpException.

@Deprecated
public class RestException
extends RuntimeException

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) Deprecated. Constructor.
RestException(String msg) Deprecated. Constructor.
RestException(Throwable cause, int status) Deprecated. Constructor.
RestException(Throwable cause, int status, String msg, Object... args) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
String	getFullStackMessage(boolean scrubForXssVulnerabilities) Deprecated. Returns all error messages from all errors in this stack.
int	getOccurrence() Deprecated. Not used by new logging API.
Throwable	getRootCause() Deprecated. Returns the root cause of this exception.
int	getStatus() Deprecated. Returns the HTTP status code.
int	hashCode() Deprecated.
protected RestException	setOccurrence(int occurrence) Deprecated. Not used by new logging API.
protected RestException	setStatus(int status) Deprecated. Set the status code on this exception.
String	toString() Deprecated.

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, notify, notifyAll, wait, wait, wait

Constructor Detail

RestException

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

Deprecated.

Constructor.

Parameters:

cause - The cause of this exception.

status - The HTTP status code.

msg - The status message.

args - Optional MessageFormat-style arguments.

RestException

public RestException(String msg)

Deprecated.

Constructor.

Parameters:

msg - The status message.

RestException

public RestException(Throwable cause,
                     int status)

Deprecated.

Constructor.

Parameters:

cause - The root exception.

status - The HTTP status code.

RestException

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

Deprecated.

Constructor.

Parameters:

status - The HTTP status code.

msg - The status message.

args - Optional MessageFormat-style arguments.

Method Detail

getRootCause

public Throwable getRootCause()

Deprecated.

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)

Deprecated.

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()

Deprecated.

Overrides:

hashCode in class Object

setOccurrence

@Deprecated
protected RestException setOccurrence(int occurrence)

Deprecated. Not used by new logging API.

Set the occurrence count on this exception.

Parameters:

occurrence - The number of times this exception has occurred.

Returns:

This object (for method chaining).

setStatus

protected RestException setStatus(int status)

Deprecated.

Set the status code on this exception.

Parameters:

status - The status code.

Returns:

This object (for method chaining).

getOccurrence

@Deprecated
public int getOccurrence()

Deprecated. Not used by new logging API.

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()

Deprecated.

Returns the HTTP status code.

Returns:

The HTTP status code.

toString

public String toString()

Deprecated.

Overrides:

toString in class Throwable