org.apache.guacamole

Class GuacamoleServerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.guacamole.GuacamoleException

org.apache.guacamole.GuacamoleServerException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GuacamoleConnectionClosedException, GuacamoleServerBusyException, GuacamoleUnsupportedException

public class GuacamoleServerException
extends GuacamoleException

A generic exception thrown when part of the Guacamole API encounters an unexpected, internal error. An internal error, if correctable, would require correction on the server side, not the client.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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

GuacamoleServerException

public GuacamoleServerException(String message,
                                Throwable cause)

Creates a new GuacamoleServerException with the given message and cause.

Parameters:

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

cause - The cause of this exception.

GuacamoleServerException

public GuacamoleServerException(String message)

Creates a new GuacamoleServerException with the given message.

Parameters:

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

GuacamoleServerException

public GuacamoleServerException(Throwable cause)

Creates a new GuacamoleServerException 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.