RealmDefiniteOutcomeAuthenticationEvent (WildFly Elytron Parent 2.0.0.Final API)

java.lang.Object
- org.wildfly.security.auth.server.event.RealmEvent
- - org.wildfly.security.auth.server.event.RealmAuthenticationEvent
  - - org.wildfly.security.auth.server.event.RealmDefiniteOutcomeAuthenticationEvent

Direct Known Subclasses:

RealmFailedAuthenticationEvent, RealmSuccessfulAuthenticationEvent
```
public abstract class RealmDefiniteOutcomeAuthenticationEvent
extends RealmAuthenticationEvent
```
An authentication event with a definite outcome.

Author:

David M. Lloyd

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<P,R> R`	`accept(RealmEventVisitor<P,R> visitor, P param)`	Accept the given visitor, calling the method which is most applicable to this event type.
`Credential`	`getCredential()`	Get the actual credential used.
`Evidence`	`getEvidence()`	Get the actual credential guess used.
`boolean`	`isFailure()`	Determine if this authentication definitely failed.

Methods inherited from class org.wildfly.security.auth.server.event.RealmAuthenticationEvent
getRealmIdentity, isSuccess

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

- Method Detail
  - getCredential
```
public Credential getCredential()
```
    Get the actual credential used.
    
    Returns:
    
    the actual credential used, or null if it is not known or none was used
  - getEvidence
```
public Evidence getEvidence()
```
    Get the actual credential guess used.
    
    Returns:
    
    the actual credential guess used, or null if there was no guess, it is not known, or no credential was used
  - accept
```
public <P,R> R accept(RealmEventVisitor<P,R> visitor,
                            P param)
```
    Description copied from class: RealmEvent
    
    Accept the given visitor, calling the method which is most applicable to this event type.
    
    Overrides:
    
    accept in class RealmAuthenticationEvent
    
    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
  - isFailure
```
public final boolean isFailure()
```
    Description copied from class: RealmAuthenticationEvent
    
    Determine if this authentication definitely failed.
    
    Specified by:
    
    isFailure in class RealmAuthenticationEvent
    
    Returns:
    
    true if the authentication definitely failed, false if it did not definitely fail