public abstract class AbstractSetRequiredActionAuthenticator extends Object implements Authenticator, AuthenticatorFactory
REQUIREMENT_CHOICES
Constructor and Description |
---|
AbstractSetRequiredActionAuthenticator() |
Modifier and Type | Method and 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 initialized
|
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
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
areRequiredActionsEnabled, authenticate, getRequiredActions
getId, order
getDisplayType
getHelpText
public AbstractSetRequiredActionAuthenticator()
public void action(AuthenticationFlowContext context)
Authenticator
action
in interface Authenticator
public boolean requiresUser()
Authenticator
requiresUser
in interface Authenticator
public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator
setRequiredActions
in interface Authenticator
public String getReferenceCategory()
ConfigurableAuthenticatorFactory
getReferenceCategory
in interface ConfigurableAuthenticatorFactory
public boolean isConfigurable()
ConfigurableAuthenticatorFactory
isConfigurable
in interface ConfigurableAuthenticatorFactory
public AuthenticationExecutionModel.Requirement[] getRequirementChoices()
ConfigurableAuthenticatorFactory
getRequirementChoices
in interface ConfigurableAuthenticatorFactory
public boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactory
isUserSetupAllowed
in interface ConfigurableAuthenticatorFactory
public List<ProviderConfigProperty> getConfigProperties()
getConfigProperties
in interface ConfiguredProvider
public void close()
ProviderFactory
close
in interface Provider
close
in interface ProviderFactory<Authenticator>
public Authenticator create(KeycloakSession session)
create
in interface ProviderFactory<Authenticator>
public void init(Config.Scope config)
ProviderFactory
init
in interface ProviderFactory<Authenticator>
public void postInit(KeycloakSessionFactory factory)
ProviderFactory
postInit
in interface ProviderFactory<Authenticator>
public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator
configuredFor
in interface Authenticator
Copyright © 2021 JBoss by Red Hat. All rights reserved.