org.apache.guacamole.net.event

Class AuthenticationFailureEvent

java.lang.Object

org.apache.guacamole.net.event.AuthenticationFailureEvent

All Implemented Interfaces:

CredentialEvent

public class AuthenticationFailureEvent
extends Object
implements CredentialEvent

An event which is triggered whenever a user's credentials fail to be authenticated. The credentials that failed to be authenticated are included within this event, and can be retrieved using getCredentials().

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
AuthenticationFailureEvent(Credentials credentials) Creates a new AuthenticationFailureEvent which represents the failure to authenticate the given credentials.

Method Summary

Modifier and Type	Method and Description
Credentials	getCredentials() Returns the current credentials of the user triggering the event, if any.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticationFailureEvent

public AuthenticationFailureEvent(Credentials credentials)

Creates a new AuthenticationFailureEvent which represents the failure to authenticate the given credentials.

Parameters:

credentials - The credentials which failed authentication.

Method Detail

getCredentials

public Credentials getCredentials()

Description copied from interface: CredentialEvent

Returns the current credentials of the user triggering the event, if any.

Specified by:

getCredentials in interface CredentialEvent

Returns:

The current credentials of the user triggering the event, if any, or null if no credentials are associated with the event.