org.keycloak.authentication.authenticators.resetcred

Class AbstractSetRequiredActionAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator

All Implemented Interfaces:

Authenticator, AuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, Provider, ProviderFactory<Authenticator>

Direct Known Subclasses:

ResetOTP, ResetPassword

public abstract class AbstractSetRequiredActionAuthenticator
extends Object
implements Authenticator, AuthenticatorFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static AuthenticationExecutionModel.Requirement[]	REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor and Description
AbstractSetRequiredActionAuthenticator()

Method Summary

Modifier and Type	Method and Description
void	action(AuthenticationFlowContext context)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
String	getReferenceCategory()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
void	init(Config.Scope config)
boolean	isConfigurable()
boolean	isUserSetupAllowed()
void	postInit(KeycloakSessionFactory factory)
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

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

authenticate

Methods inherited from interface org.keycloak.provider.ProviderFactory

getId

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getDisplayType

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getHelpText

Field Detail

REQUIREMENT_CHOICES

public static final AuthenticationExecutionModel.Requirement[] REQUIREMENT_CHOICES

Constructor Detail

AbstractSetRequiredActionAuthenticator

public AbstractSetRequiredActionAuthenticator()

Method Detail

action

public void action(AuthenticationFlowContext context)

Specified by:

action in interface Authenticator

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

setRequiredActions

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

Specified by:

setRequiredActions in interface Authenticator

getReferenceCategory

public String getReferenceCategory()

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

isUserSetupAllowed

public boolean isUserSetupAllowed()

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<Authenticator>

create

public Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<Authenticator>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<Authenticator>

configuredFor

public boolean configuredFor(KeycloakSession session,
                             RealmModel realm,
                             UserModel user)

Specified by:

configuredFor in interface Authenticator