Package org.wildfly.security.auth.server.event

Class RealmAuthenticationEvent

java.lang.Object

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

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

Direct Known Subclasses:

RealmAbandonedAuthenticationEvent, RealmDefiniteOutcomeAuthenticationEvent

public abstract class RealmAuthenticationEvent
extends RealmEvent

A realm authentication event. The realm identity may be destroyed at some point after the event is handled.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field	Description
private RealmIdentity	realmIdentity

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RealmAuthenticationEvent(RealmIdentity realmIdentity)	Construct a new instance.

Method Summary

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.
RealmIdentity	getRealmIdentity()	Get the realm identity.
abstract boolean	isFailure()	Determine if this authentication definitely failed.
abstract boolean	isSuccess()	Determine if this authentication was definitely successful.

Methods inherited from class java.lang.Object

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

Field Detail

realmIdentity

private final RealmIdentity realmIdentity

Constructor Detail

RealmAuthenticationEvent

protected RealmAuthenticationEvent(RealmIdentity realmIdentity)

Construct a new instance.

Parameters:

realmIdentity - the realm identity of the authentication event

Method Detail

getRealmIdentity

public final RealmIdentity getRealmIdentity()

Get the realm identity.

Returns:

the realm identity

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 RealmEvent

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 abstract boolean isSuccess()

Determine if this authentication was definitely successful.

Returns:

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

isFailure

public abstract boolean isFailure()

Determine if this authentication definitely failed.

Returns:

true if the authentication definitely failed, false if it did not definitely fail