Package org.apache.guacamole.language

Class TranslatableGuacamoleClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.guacamole.GuacamoleException

org.apache.guacamole.GuacamoleClientException

org.apache.guacamole.language.TranslatableGuacamoleClientException

All Implemented Interfaces:

Serializable, Translatable

public class TranslatableGuacamoleClientException
extends org.apache.guacamole.GuacamoleClientException
implements Translatable

A GuacamoleClientException whose associated message is translatable and can be passed through an arbitrary translation service, producing a human-readable message in the user's native language.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TranslatableGuacamoleClientException(String message, String key)	Creates a new TranslatableGuacamoleClientException with the given message.
TranslatableGuacamoleClientException(String message, String key, Throwable cause)	Creates a new TranslatableGuacamoleClientException with the given message and cause.
TranslatableGuacamoleClientException(String message, TranslatableMessage translatableMessage)	Creates a new TranslatableGuacamoleClientException with the given message.
TranslatableGuacamoleClientException(String message, TranslatableMessage translatableMessage, Throwable cause)	Creates a new TranslatableGuacamoleClientException with the given message and cause.

Method Summary

Modifier and Type	Method	Description
TranslatableMessage	getTranslatableMessage()	Returns a message which can be translated using a translation service, consisting of a translation key and optional set of substitution variables.

Methods inherited from class org.apache.guacamole.GuacamoleClientException

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

TranslatableGuacamoleClientException

public TranslatableGuacamoleClientException(String message,
                                            TranslatableMessage translatableMessage,
                                            Throwable cause)

Creates a new TranslatableGuacamoleClientException with the given message and cause. The message must be provided in both non-translatable (readable as-written) and translatable forms.

Parameters:

message - A human-readable description of the exception that occurred. This message should be readable on its own and as-written, without requiring a translation service.

translatableMessage - A translatable, human-readable description of the exception that occurred.

cause - The cause of this exception.

TranslatableGuacamoleClientException

public TranslatableGuacamoleClientException(String message,
                                            TranslatableMessage translatableMessage)

Creates a new TranslatableGuacamoleClientException with the given message. The message must be provided in both non-translatable (readable as-written) and translatable forms.

Parameters:

message - A human-readable description of the exception that occurred. This message should be readable on its own and as-written, without requiring a translation service.

translatableMessage - A translatable, human-readable description of the exception that occurred.

TranslatableGuacamoleClientException

public TranslatableGuacamoleClientException(String message,
                                            String key,
                                            Throwable cause)

Creates a new TranslatableGuacamoleClientException with the given message and cause. The message must be provided in both non-translatable (readable as-written) and translatable forms.

Parameters:

message - A human-readable description of the exception that occurred. This message should be readable on its own and as-written, without requiring a translation service.

key - The arbitrary key which can be used to look up the message to be displayed in the user's native language.

cause - The cause of this exception.

TranslatableGuacamoleClientException

public TranslatableGuacamoleClientException(String message,
                                            String key)

Creates a new TranslatableGuacamoleClientException with the given message. The message must be provided in both non-translatable (readable as-written) and translatable forms.

Parameters:

message - A human-readable description of the exception that occurred. This message should be readable on its own and as-written, without requiring a translation service.

key - The arbitrary key which can be used to look up the message to be displayed in the user's native language.

Method Detail

getTranslatableMessage

public TranslatableMessage getTranslatableMessage()

Description copied from interface: Translatable

Returns a message which can be translated using a translation service, consisting of a translation key and optional set of substitution variables.

Specified by:

getTranslatableMessage in interface Translatable

Returns:

A message which can be translated using a translation service.