org.apache.guacamole.net.event

Class AuthenticationSuccessEvent

java.lang.Object

org.apache.guacamole.net.event.AuthenticationSuccessEvent

All Implemented Interfaces:

CredentialEvent, UserEvent

public class AuthenticationSuccessEvent
extends Object
implements UserEvent, CredentialEvent

An event which is triggered whenever a user's credentials pass authentication. The credentials that passed authentication are included within this event, and can be retrieved using getCredentials().

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
AuthenticationSuccessEvent(UserContext context, Credentials credentials) Creates a new AuthenticationSuccessEvent which represents a successful authentication attempt with 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.
UserContext	getUserContext() Returns the current UserContext 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

AuthenticationSuccessEvent

public AuthenticationSuccessEvent(UserContext context,
                                  Credentials credentials)

Creates a new AuthenticationSuccessEvent which represents a successful authentication attempt with the given credentials.

Parameters:

context - The UserContext created as a result of successful authentication.

credentials - The credentials which passed authentication.

Method Detail

getUserContext

public UserContext getUserContext()

Description copied from interface: UserEvent

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

Specified by:

getUserContext in interface UserEvent

Returns:

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

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.