Package org.keycloak.authentication.authenticators.conditional

Class ConditionalLoaAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.conditional.ConditionalLoaAuthenticator

All Implemented Interfaces:

AuthenticationFlowCallback, Authenticator, ConditionalAuthenticator, Provider

public class ConditionalLoaAuthenticator
extends Object
implements ConditionalAuthenticator, AuthenticationFlowCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_AGE
static final String	LEVEL
static final String	MAX_AGE
static final String	STORE_IN_USER_SESSION	Deprecated.

Constructor Summary

Constructors

Constructor	Description
ConditionalLoaAuthenticator(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)	Called from a form action invocation.
void	close()
boolean	matchCondition(AuthenticationFlowContext context)
void	onParentFlowSuccess(AuthenticationFlowContext context)	Triggered after the authentication flow is successfully finished.
void	onTopFlowSuccess(AuthenticationFlowModel topFlow)	Triggered after the top authentication flow is successfully finished.
boolean	requiresUser()	Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)	Set actions to configure authenticator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authentication.Authenticator

areRequiredActionsEnabled, getRequiredActions

Methods inherited from interface org.keycloak.authentication.authenticators.conditional.ConditionalAuthenticator

authenticate, configuredFor

Field Details

LEVEL

public static final String LEVEL

See Also:

• Constant Field Values

MAX_AGE

public static final String MAX_AGE

See Also:

• Constant Field Values

DEFAULT_MAX_AGE

public static final int DEFAULT_MAX_AGE

See Also:

• Constant Field Values

STORE_IN_USER_SESSION

@Deprecated
public static final String STORE_IN_USER_SESSION

Deprecated.

See Also:

• Constant Field Values

Constructor Details

ConditionalLoaAuthenticator

public ConditionalLoaAuthenticator(KeycloakSession session)

Method Details

matchCondition

public boolean matchCondition(AuthenticationFlowContext context)

Specified by:

matchCondition in interface ConditionalAuthenticator

onParentFlowSuccess

public void onParentFlowSuccess(AuthenticationFlowContext context)

Description copied from interface: AuthenticationFlowCallback

Triggered after the authentication flow is successfully finished. The target authentication flow is the one where this authenticator is configured. Authenticator should finish successfully in the flow (or being evaluated to true in case of Conditional Authenticator) in order to trigger this callback at the successful end of the flow

Specified by:

onParentFlowSuccess in interface AuthenticationFlowCallback

Parameters:

context - which encapsulate various useful data

onTopFlowSuccess

public void onTopFlowSuccess(AuthenticationFlowModel topFlow)

Description copied from interface: AuthenticationFlowCallback

Triggered after the top authentication flow is successfully finished. It is really suitable for last verification of successful authentication

Specified by:

onTopFlowSuccess in interface AuthenticationFlowCallback

Parameters:

topFlow - which was successfully finished

action

public void action(AuthenticationFlowContext context)

Description copied from interface: Authenticator

Called from a form action invocation.

Specified by:

action in interface Authenticator

requiresUser

public boolean requiresUser()

Description copied from interface: Authenticator

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

Specified by:

requiresUser in interface Authenticator

Returns:

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Description copied from interface: Authenticator

Set actions to configure authenticator

Specified by:

setRequiredActions in interface Authenticator

close

public void close()

Specified by:

close in interface Provider