Package org.apache.guacamole.language

Class TranslatableGuacamoleCredentialsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.guacamole.GuacamoleException

org.apache.guacamole.GuacamoleClientException

org.apache.guacamole.GuacamoleSecurityException

org.apache.guacamole.GuacamoleUnauthorizedException

org.apache.guacamole.net.auth.credentials.GuacamoleCredentialsException

org.apache.guacamole.language.TranslatableGuacamoleCredentialsException

All Implemented Interfaces:

Serializable, Translatable

public class TranslatableGuacamoleCredentialsException
extends GuacamoleCredentialsException
implements Translatable

A GuacamoleCredentialsException 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
TranslatableGuacamoleCredentialsException(String message, String key, Throwable cause, CredentialsInfo credentialsInfo)	Creates a new TranslatableGuacamoleCredentialsException with the given message, cause, and associated credential information.
TranslatableGuacamoleCredentialsException(String message, String key, CredentialsInfo credentialsInfo)	Creates a new TranslatableGuacamoleCredentialsException with the given message, and associated credential information.
TranslatableGuacamoleCredentialsException(String message, TranslatableMessage translatableMessage, Throwable cause, CredentialsInfo credentialsInfo)	Creates a new TranslatableGuacamoleCredentialsException with the given message, cause, and associated credential information.
TranslatableGuacamoleCredentialsException(String message, TranslatableMessage translatableMessage, CredentialsInfo credentialsInfo)	Creates a new TranslatableGuacamoleCredentialsException with the given message, and associated credential information.

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.net.auth.credentials.GuacamoleCredentialsException

getCredentialsInfo

Methods inherited from class org.apache.guacamole.GuacamoleUnauthorizedException

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

TranslatableGuacamoleCredentialsException

public TranslatableGuacamoleCredentialsException(String message,
                                                 TranslatableMessage translatableMessage,
                                                 Throwable cause,
                                                 CredentialsInfo credentialsInfo)

Creates a new TranslatableGuacamoleCredentialsException with the given message, cause, and associated credential information. 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.

credentialsInfo - Information describing the form of valid credentials.

TranslatableGuacamoleCredentialsException

public TranslatableGuacamoleCredentialsException(String message,
                                                 TranslatableMessage translatableMessage,
                                                 CredentialsInfo credentialsInfo)

Creates a new TranslatableGuacamoleCredentialsException with the given message, and associated credential information. 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.

credentialsInfo - Information describing the form of valid credentials.

TranslatableGuacamoleCredentialsException

public TranslatableGuacamoleCredentialsException(String message,
                                                 String key,
                                                 Throwable cause,
                                                 CredentialsInfo credentialsInfo)

Creates a new TranslatableGuacamoleCredentialsException with the given message, cause, and associated credential information. 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.

credentialsInfo - Information describing the form of valid credentials.

TranslatableGuacamoleCredentialsException

public TranslatableGuacamoleCredentialsException(String message,
                                                 String key,
                                                 CredentialsInfo credentialsInfo)

Creates a new TranslatableGuacamoleCredentialsException with the given message, and associated credential information. 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.

credentialsInfo - Information describing the form of valid credentials.

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.