org.wildfly.security.auth.server.event

Class RealmFailedAuthenticationEvent

java.lang.Object

org.wildfly.security.auth.server.event.RealmEvent

org.wildfly.security.auth.server.event.RealmAuthenticationEvent

org.wildfly.security.auth.server.event.RealmFailedAuthenticationEvent

public final class RealmFailedAuthenticationEvent
extends RealmAuthenticationEvent

A realm event signifying a failed authentication.

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor and Description
RealmFailedAuthenticationEvent(RealmIdentity realmIdentity, Credential credential, Evidence evidence) Construct a new instance.

Method Summary

Modifier and Type	Method and 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.
boolean	isSuccess() Determine if this authentication was definitely successful.

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

getRealmIdentity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RealmFailedAuthenticationEvent

public RealmFailedAuthenticationEvent(RealmIdentity realmIdentity,
                                      Credential credential,
                                      Evidence evidence)

Construct a new instance.

Parameters:

realmIdentity - the realm identity of the failed authentication

credential - the actual credential value from the authentication (may be null if not known)

evidence - the evidence used to authenticate (may be null if not known or not applicable)

Method Detail

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.

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

isSuccess

public boolean isSuccess()

Description copied from class: RealmAuthenticationEvent

Determine if this authentication was definitely successful.

Specified by:

isSuccess in class RealmAuthenticationEvent

Returns:

true if the authentication was definitely successful, false if it was not definitely successful

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

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