com.xatkit.core.server

Class RestHandlerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.xatkit.core.server.RestHandlerException

All Implemented Interfaces:

Serializable

public class RestHandlerException
extends Exception

An exception thrown by RestHandlers to notify the XatkitServer.

This exception is used to set the HTTP response's status code in the XatkitServer: by default the server returns a status code 200, but it will return a 404 if the RestHandler threw a RestHandlerException.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	RestHandlerException() Constructs a RestHandlerException.
	RestHandlerException(int errorCode, String message) Constructs a RestHandlerException with the provided HTTP errorCode and message.
	RestHandlerException(int errorCode, String message, Throwable cause) Constructs a RestHandlerException from the provided HTTP errorCode, message, and cause.
	RestHandlerException(int errorCode, Throwable cause) Constructs a RestHandlerException from the provided HTTP errorCode and cause.
	RestHandlerException(String message) Constructs a RestHandlerException from the provided message.
	RestHandlerException(String message, Throwable cause) Constructs a RestHandlerException from the provided message and cause.
protected	RestHandlerException(String message, Throwable cause, boolean enableSuppression, boolean writeableStackTrace) Constructs a RestHandlerException from the provided message, cause, enableSuppression, and writeableStackTrace.
	RestHandlerException(Throwable cause) Constructs a RestHandlerException from the provided cause.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the HTTP error code associated to this exception.

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 Detail

RestHandlerException

public RestHandlerException()

Constructs a RestHandlerException.

The errorCode of the created exception is set to HttpStatus.SC_NOT_FOUND.

RestHandlerException

public RestHandlerException(int errorCode,
                            String message)

Constructs a RestHandlerException with the provided HTTP errorCode and message.

Parameters:

errorCode - the HTTP error code

message - the exception's message

RestHandlerException

public RestHandlerException(String message)

Constructs a RestHandlerException from the provided message.

The errorCode of the created exception is set to HttpStatus.SC_NOT_FOUND.

Parameters:

message - the exception's message

RestHandlerException

public RestHandlerException(String message,
                            Throwable cause)

Constructs a RestHandlerException from the provided message and cause.

The errorCode of the created exception is set to HttpStatus.SC_NOT_FOUND.

Parameters:

message - the exception's message

cause - the exception's cause

RestHandlerException

public RestHandlerException(int errorCode,
                            String message,
                            Throwable cause)

Constructs a RestHandlerException from the provided HTTP errorCode, message, and cause.

Parameters:

errorCode - errorCode the HTTP error code

message - the exception's message

cause - the exception's cause

RestHandlerException

public RestHandlerException(Throwable cause)

Constructs a RestHandlerException from the provided cause.

The errorCode of the created exception is set to HttpStatus.SC_NOT_FOUND.

Parameters:

cause - the exception's cause

RestHandlerException

public RestHandlerException(int errorCode,
                            Throwable cause)

Constructs a RestHandlerException from the provided HTTP errorCode and cause.

Parameters:

errorCode - the HTTP error code

cause - the exception's cause

RestHandlerException

protected RestHandlerException(String message,
                               Throwable cause,
                               boolean enableSuppression,
                               boolean writeableStackTrace)

Constructs a RestHandlerException from the provided message, cause, enableSuppression, and writeableStackTrace.

Parameters:

message - the exception's message

cause - the exception's cause

enableSuppression - whether or not suppression is enabled

writeableStackTrace - whether or not the stack trace should be writable

Method Detail

getErrorCode

public int getErrorCode()

Returns the HTTP error code associated to this exception.

Returns:

the HTTP error code associated to this exception