AuthenticationSuccessEvent (guacamole-ext 1.5.5 API)

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().
If a Listener throws a GuacamoleException when handling an event of this type, successful authentication is effectively vetoed and will be subsequently processed as though the authentication failed.

Constructor Summary

Constructors
Constructor	Description
`AuthenticationSuccessEvent(AuthenticatedUser authenticatedUser)`	Creates a new AuthenticationSuccessEvent which represents a successful authentication attempt by the user identified by the given AuthenticatedUser object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticatedUser`	`getAuthenticatedUser()`	Returns the AuthenticatedUser identifying the user triggering the event, if any.
`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
  - AuthenticationSuccessEvent
```
public AuthenticationSuccessEvent(AuthenticatedUser authenticatedUser)
```
    Creates a new AuthenticationSuccessEvent which represents a successful authentication attempt by the user identified by the given AuthenticatedUser object.
    
    Parameters:
    
    authenticatedUser - The AuthenticatedUser identifying the user that successfully authenticated.
- Method Detail
  - getAuthenticatedUser
```
public AuthenticatedUser getAuthenticatedUser()
```
    Description copied from interface: UserEvent
    
    Returns the AuthenticatedUser identifying the user triggering the event, if any.
    
    Specified by:
    
    getAuthenticatedUser in interface UserEvent
    
    Returns:
    
    The AuthenticatedUser identifying the user triggering the event, if any, or null if no AuthenticatedUser 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.