Package org.keycloak.authentication

Interface AuthenticationFlowCallback

All Superinterfaces:

Authenticator, Provider

All Known Implementing Classes:

ConditionalLoaAuthenticator

public interface AuthenticationFlowCallback
extends Authenticator

Callback to be triggered during various lifecycle events of authentication flow. The AuthenticatorFactory, which creates this Authenticator should implement AuthenticationFlowCallbackFactory interface.

Author:

Marek Posolda

Method Summary

Modifier and Type	Method	Description
void	onParentFlowSuccess(AuthenticationFlowContext context)	Triggered after the authentication flow is successfully finished.
default void	onTopFlowSuccess(AuthenticationFlowModel topFlow)	Triggered after the top authentication flow is successfully finished.

Methods inherited from interface org.keycloak.authentication.Authenticator

action, areRequiredActionsEnabled, authenticate, configuredFor, getRequiredActions, requiresUser, setRequiredActions

Methods inherited from interface org.keycloak.provider.Provider

close

Method Details

onParentFlowSuccess

void onParentFlowSuccess(AuthenticationFlowContext context)

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

Parameters:

context - which encapsulate various useful data

onTopFlowSuccess

default void onTopFlowSuccess(AuthenticationFlowModel topFlow)

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

Parameters:

topFlow - which was successfully finished