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, waitareRequiredActionsEnabled, authenticate, getRequiredActionsgetId, ordergetDisplayTypegetHelpTextpublic AbstractSetRequiredActionAuthenticator()
public void action(AuthenticationFlowContext context)
Authenticatoraction in interface Authenticatorpublic boolean requiresUser()
AuthenticatorrequiresUser in interface Authenticatorpublic void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
AuthenticatorsetRequiredActions in interface Authenticatorpublic String getReferenceCategory()
ConfigurableAuthenticatorFactorygetReferenceCategory in interface ConfigurableAuthenticatorFactorypublic boolean isConfigurable()
ConfigurableAuthenticatorFactoryisConfigurable in interface ConfigurableAuthenticatorFactorypublic AuthenticationExecutionModel.Requirement[] getRequirementChoices()
ConfigurableAuthenticatorFactorygetRequirementChoices in interface ConfigurableAuthenticatorFactorypublic boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactoryisUserSetupAllowed in interface ConfigurableAuthenticatorFactorypublic List<ProviderConfigProperty> getConfigProperties()
getConfigProperties in interface ConfiguredProviderpublic void close()
ProviderFactoryclose in interface Providerclose in interface ProviderFactory<Authenticator>public Authenticator create(KeycloakSession session)
create in interface ProviderFactory<Authenticator>public void init(Config.Scope config)
ProviderFactoryinit in interface ProviderFactory<Authenticator>public void postInit(KeycloakSessionFactory factory)
ProviderFactorypostInit in interface ProviderFactory<Authenticator>public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
AuthenticatorconfiguredFor in interface AuthenticatorCopyright © 2021 JBoss by Red Hat. All rights reserved.