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 inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
REQUIREMENT_CHOICES
-
-
Constructor Summary
Constructors Constructor Description AbstractSetRequiredActionAuthenticator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
action(AuthenticationFlowContext context)
Called from a form action invocation.void
close()
This is called when the server shuts down.boolean
configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Is this authenticator configured for this user.Authenticator
create(KeycloakSession session)
List<ProviderConfigProperty>
getConfigProperties()
String
getReferenceCategory()
General authenticator type, i.e.AuthenticationExecutionModel.Requirement[]
getRequirementChoices()
What requirement settings are allowed.void
init(Config.Scope config)
Only called once when the factory is first created.boolean
isConfigurable()
Is this authenticator configurable?boolean
isUserSetupAllowed()
Does this authenticator have required actions that can set if the user does not have this authenticator set up?void
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initializedboolean
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, authenticate, getRequiredActions
-
Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
getDisplayType
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getHelpText
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, getId, order
-
-
-
-
Method Detail
-
action
public void action(AuthenticationFlowContext context)
Description copied from interface:Authenticator
Called from a form action invocation.- Specified by:
action
in interfaceAuthenticator
-
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 interfaceAuthenticator
- 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 interfaceAuthenticator
-
getReferenceCategory
public String getReferenceCategory()
Description copied from interface:ConfigurableAuthenticatorFactory
General authenticator type, i.e. totp, password, cert.- Specified by:
getReferenceCategory
in interfaceConfigurableAuthenticatorFactory
- Returns:
- null if not a referencable category
-
isConfigurable
public boolean isConfigurable()
Description copied from interface:ConfigurableAuthenticatorFactory
Is this authenticator configurable?- Specified by:
isConfigurable
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getRequirementChoices
public AuthenticationExecutionModel.Requirement[] getRequirementChoices()
Description copied from interface:ConfigurableAuthenticatorFactory
What requirement settings are allowed.- Specified by:
getRequirementChoices
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
isUserSetupAllowed
public boolean isUserSetupAllowed()
Description copied from interface:ConfigurableAuthenticatorFactory
Does this authenticator have required actions that can set if the user does not have this authenticator set up?- Specified by:
isUserSetupAllowed
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
close
public void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProvider
- Specified by:
close
in interfaceProviderFactory<Authenticator>
-
create
public Authenticator create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<Authenticator>
-
init
public void init(Config.Scope config)
Description copied from interface:ProviderFactory
Only called once when the factory is first created. This config is pulled from keycloak_server.json- Specified by:
init
in interfaceProviderFactory<Authenticator>
-
postInit
public void postInit(KeycloakSessionFactory factory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<Authenticator>
-
configuredFor
public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Description copied from interface:Authenticator
Is this authenticator configured for this user.- Specified by:
configuredFor
in interfaceAuthenticator
- Returns:
-
-