SecurityAuthenticationFailedEvent (WildFly Elytron Parent 2.1.0.Final API)

java.lang.Object
- org.wildfly.security.auth.server.event.SecurityEvent
- - org.wildfly.security.auth.server.event.SecurityDefiniteOutcomeEvent
  - - org.wildfly.security.auth.server.event.SecurityAuthenticationEvent
    - - org.wildfly.security.auth.server.event.SecurityAuthenticationFailedEvent

public final class SecurityAuthenticationFailedEvent
extends SecurityAuthenticationEvent

An event to represent a failed authentication.

Author:: Darran Lofthouse

Field Summary

Fields
Modifier and Type Field Description

private Principal principal

Constructor Summary

Constructors
Constructor	Description
`SecurityAuthenticationFailedEvent(SecurityIdentity securityIdentity, Principal principal)`	Constructor for a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<P,R> R`	`accept(SecurityEventVisitor<P,R> visitor, P param)`	Accept the given visitor, calling the method which is most applicable to this event type.
`Principal`	`getPrincipal()`	Gets the principal used to the failed authentication.

Methods inherited from class org.wildfly.security.auth.server.event.SecurityDefiniteOutcomeEvent
isSuccessful

Methods inherited from class org.wildfly.security.auth.server.event.SecurityEvent
getInstant, getSecurityIdentity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - principal
```
private final Principal principal
```
- Constructor Detail
  - SecurityAuthenticationFailedEvent
```
public SecurityAuthenticationFailedEvent(SecurityIdentity securityIdentity,
                                         Principal principal)
```
    Constructor for a new instance.
    
    Parameters:
    
    securityIdentity - the SecurityIdentity that failed authentication (null when identity does not exists)
    
    principal - the principal used to that failed authentication (filled event if identity does not exists)
- Method Detail
  - getPrincipal
```
public Principal getPrincipal()
```
    Gets the principal used to the failed authentication.
    
    Returns:
    
    the principal used to that failed authentication (filled event if identity does not exists)
  - accept
```
public <P,R> R accept(SecurityEventVisitor<P,R> visitor,
                            P param)
```
    Description copied from class: SecurityEvent
    
    Accept the given visitor, calling the method which is most applicable to this event type.
    
    Overrides:
    
    accept in class SecurityAuthenticationEvent
    
    Type Parameters:
    
    P - the visitor parameter type
    
    R - the visitor return type
    
    Parameters:
    
    visitor - the visitor
    
    param - the parameter to pass to the visitor handleXxx method
    
    Returns:
    
    the value returned from the visitor handleXxx method