Package com.aquima.web.rest.v1.exception

Class RestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.aquima.web.rest.v1.exception.RestException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidParameterException, ResourceNotFoundException, UnauthorizedUserException

public class RestException
extends RuntimeException

Base class for exceptions thrown by the REST API. Encapsultes the HTTP status code that should be returned when an exception of this type occurs. The exception message should be suitable for display to the end user.

Since:

9.6

Author:

Voicu Moldovan

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	RestException(String message)
protected	RestException(String message, int statusCode)	Constructor meant for subclasses, which can specify the associated HTTP status code.
	RestException(String message, Throwable cause)
protected	RestException(String message, Throwable cause, int statusCode)	Constructor meant for subclasses, which can specify the associated HTTP status code.

Method Summary

Modifier and Type	Method	Description
int	getStatusCode()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

RestException

public RestException(String message)

RestException

public RestException(String message,
 Throwable cause)

RestException

protected RestException(String message,
 int statusCode)

Constructor meant for subclasses, which can specify the associated HTTP status code.

Parameters:

message - the error message

statusCode - the HTTP status code

RestException

protected RestException(String message,
 Throwable cause,
 int statusCode)

Constructor meant for subclasses, which can specify the associated HTTP status code.

Parameters:

message - the error message

cause - the wrapped exception

statusCode - the HTTP status code

Method Details

getStatusCode

public int getStatusCode()

Returns:

the HTTP status code for this exception