Package org.apache.guacamole

Class GuacamoleClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.guacamole.GuacamoleException

org.apache.guacamole.GuacamoleClientException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GuacamoleClientBadTypeException, GuacamoleClientOverrunException, GuacamoleClientTimeoutException, GuacamoleClientTooManyException, GuacamoleResourceClosedException, GuacamoleResourceConflictException, GuacamoleResourceNotFoundException, GuacamoleSecurityException

public class GuacamoleClientException
extends GuacamoleException

A generic exception thrown when part of the Guacamole API encounters an error in the client's request. Such an error, if correctable, usually requires correction on the client side, not the server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GuacamoleClientException(String message)	Creates a new GuacamoleException with the given message.
GuacamoleClientException(String message, Throwable cause)	Creates a new GuacamoleException with the given message and cause.
GuacamoleClientException(Throwable cause)	Creates a new GuacamoleException with the given cause.

Method Summary

Modifier and Type	Method	Description
GuacamoleStatus	getStatus()	Returns the Guacamole status associated with this exception.

Methods inherited from class org.apache.guacamole.GuacamoleException

getHttpStatusCode, getWebSocketCode

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

GuacamoleClientException

public GuacamoleClientException(String message,
                                Throwable cause)

Creates a new GuacamoleException with the given message and cause.

Parameters:

message - A human readable description of the exception that occurred.

cause - The cause of this exception.

GuacamoleClientException

public GuacamoleClientException(String message)

Creates a new GuacamoleException with the given message.

Parameters:

message - A human readable description of the exception that occurred.

GuacamoleClientException

public GuacamoleClientException(Throwable cause)

Creates a new GuacamoleException with the given cause.

Parameters:

cause - The cause of this exception.

Method Detail

getStatus

public GuacamoleStatus getStatus()

Description copied from class: GuacamoleException

Returns the Guacamole status associated with this exception. This status can then be easily translated into an HTTP error code or Guacamole protocol error code.

Overrides:

getStatus in class GuacamoleException

Returns:

The corresponding Guacamole status.