org.apache.guacamole.net.event.listener

Interface AuthenticationSuccessListener

public interface AuthenticationSuccessListener

A listener whose hooks will fire immediately before and after a user's authentication attempt succeeds. If a user successfully authenticates, the authenticationSucceeded() hook has the opportunity to cancel the authentication and force it to fail.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
boolean	authenticationSucceeded(AuthenticationSuccessEvent e) Event hook which fires immediately after a user's authentication attempt succeeds.

Method Detail

authenticationSucceeded

boolean authenticationSucceeded(AuthenticationSuccessEvent e)
                         throws org.apache.guacamole.GuacamoleException

Event hook which fires immediately after a user's authentication attempt succeeds. The return value of this hook dictates whether the successful authentication attempt is canceled.

Parameters:

e - The AuthenticationFailureEvent describing the authentication failure that just occurred.

Returns:

true if the successful authentication attempt should be allowed, or false if the attempt should be denied, causing the attempt to effectively fail.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while handling the authentication success event. Throwing an exception will also cancel the authentication success.