org.glyptodon.guacamole.net.basic.rest

Class APIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.ws.rs.WebApplicationException

org.glyptodon.guacamole.net.basic.rest.APIException

All Implemented Interfaces:

Serializable

public class APIException
extends javax.ws.rs.WebApplicationException

An exception that will result in the given error error information being returned from the API layer. All error messages have the same format which is defined by APIError.

Author:

James Muehlner, Michael Jumper

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
APIException(APIError.Type type, String message) Creates a new APIException with the given type and message.
APIException(APIError.Type type, String message, Collection<Field> expected) Creates a new APIException with the given type, message, and parameter information.
APIException(APIError error) Construct a new APIException with the given error.

Method Summary

Methods inherited from class javax.ws.rs.WebApplicationException

getResponse

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

APIException

public APIException(APIError error)

Construct a new APIException with the given error. All information associated with this new exception will be extracted from the given APIError.

Parameters:

error - The error that occurred.

APIException

public APIException(APIError.Type type,
                    String message)

Creates a new APIException with the given type and message. The corresponding APIError will be created from the provided information.

Parameters:

type - The type of error that occurred.

message - A human-readable message describing the error.

APIException

public APIException(APIError.Type type,
                    String message,
                    Collection<Field> expected)

Creates a new APIException with the given type, message, and parameter information. The corresponding APIError will be created from the provided information.

Parameters:

type - The type of error that occurred.

message - A human-readable message describing the error.

expected - All parameters expected in the original request, or now required as a result of the original request, as a collection of fields.