Package org.apache.guacamole.token

Class GuacamoleTokenUndefinedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.guacamole.GuacamoleException

org.apache.guacamole.GuacamoleServerException

org.apache.guacamole.token.GuacamoleTokenUndefinedException

All Implemented Interfaces:

Serializable

public class GuacamoleTokenUndefinedException
extends org.apache.guacamole.GuacamoleServerException

An exception thrown when a token cannot be substituted because it has no corresponding value. Additional information describing the undefined token is provided.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GuacamoleTokenUndefinedException(String message, String tokenName)	Creates a new GuacamoleTokenUndefinedException with the given message and associated undefined token name.
GuacamoleTokenUndefinedException(String message, Throwable cause, String tokenName)	Creates a new GuacamoleTokenUndefinedException with the given message, cause, and associated undefined token name.
GuacamoleTokenUndefinedException(Throwable cause, String tokenName)	Creates a new GuacamoleTokenUndefinedException with the given cause and associated undefined token name.

Method Summary

Modifier and Type	Method	Description
String	getTokenName()	Returns the name of the token which has no defined value, causing this exception to be thrown.

Methods inherited from class org.apache.guacamole.GuacamoleServerException

getStatus

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

GuacamoleTokenUndefinedException

public GuacamoleTokenUndefinedException(String message,
                                        Throwable cause,
                                        String tokenName)

Creates a new GuacamoleTokenUndefinedException with the given message, cause, and associated undefined token name.

Parameters:

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

cause - The cause of this exception.

tokenName - The name of the token which has no defined value.

GuacamoleTokenUndefinedException

public GuacamoleTokenUndefinedException(String message,
                                        String tokenName)

Creates a new GuacamoleTokenUndefinedException with the given message and associated undefined token name.

Parameters:

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

tokenName - The name of the token which has no defined value.

GuacamoleTokenUndefinedException

public GuacamoleTokenUndefinedException(Throwable cause,
                                        String tokenName)

Creates a new GuacamoleTokenUndefinedException with the given cause and associated undefined token name.

Parameters:

cause - The cause of this exception.

tokenName - The name of the token which has no defined value.

Method Detail

getTokenName

public String getTokenName()

Returns the name of the token which has no defined value, causing this exception to be thrown.

Returns:

The name of the token which has no defined value.