Package org.apache.guacamole.net.auth.credentials

Class GuacamoleCredentialsException

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GuacamoleInsufficientCredentialsException, GuacamoleInvalidCredentialsException, TranslatableGuacamoleCredentialsException

public class GuacamoleCredentialsException
extends org.apache.guacamole.GuacamoleUnauthorizedException

A security-related exception thrown when access is denied to a user because of a problem related to the provided credentials. Additional information describing the form of valid credentials is provided.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GuacamoleCredentialsException(String message, Throwable cause, CredentialsInfo credentialsInfo)	Creates a new GuacamoleInvalidCredentialsException with the given message, cause, and associated credential information.
GuacamoleCredentialsException(String message, CredentialsInfo credentialsInfo)	Creates a new GuacamoleInvalidCredentialsException with the given message and associated credential information.
GuacamoleCredentialsException(Throwable cause, CredentialsInfo credentialsInfo)	Creates a new GuacamoleInvalidCredentialsException with the given cause and associated credential information.

Method Summary

Modifier and Type	Method	Description
CredentialsInfo	getCredentialsInfo()	Returns information describing the form of valid credentials.

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

GuacamoleCredentialsException

public GuacamoleCredentialsException(String message,
                                     Throwable cause,
                                     CredentialsInfo credentialsInfo)

Creates a new GuacamoleInvalidCredentialsException with the given message, cause, and associated credential information.

Parameters:

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

cause - The cause of this exception.

credentialsInfo - Information describing the form of valid credentials.

GuacamoleCredentialsException

public GuacamoleCredentialsException(String message,
                                     CredentialsInfo credentialsInfo)

Creates a new GuacamoleInvalidCredentialsException with the given message and associated credential information.

Parameters:

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

credentialsInfo - Information describing the form of valid credentials.

GuacamoleCredentialsException

public GuacamoleCredentialsException(Throwable cause,
                                     CredentialsInfo credentialsInfo)

Creates a new GuacamoleInvalidCredentialsException with the given cause and associated credential information.

Parameters:

cause - The cause of this exception.

credentialsInfo - Information describing the form of valid credentials.

Method Detail

getCredentialsInfo

public CredentialsInfo getCredentialsInfo()

Returns information describing the form of valid credentials.

Returns:

Information describing the form of valid credentials.