public class RegistrationProfile extends Object implements FormAction, FormActionFactory
Modifier and Type | Field and Description |
---|---|
static String |
PROVIDER_ID |
Constructor and Description |
---|
RegistrationProfile() |
Modifier and Type | Method and Description |
---|---|
void |
buildPage(FormContext context,
LoginFormsProvider form)
When a FormAuthenticator is rendering the challenge page, even FormAction.buildPage() method will be called
This gives the FormAction the opportunity to add additional attributes to the form to be displayed.
|
void |
close()
This is called when the server shuts down.
|
boolean |
configuredFor(KeycloakSession session,
RealmModel realm,
UserModel user)
Is this FormAction configured for the current user?
|
FormAction |
create(KeycloakSession session) |
List<ProviderConfigProperty> |
getConfigProperties() |
String |
getDisplayType()
Friendly name for the authenticator
|
String |
getHelpText() |
String |
getId() |
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 FormAction require that a user be set? For registration, this method will always return false.
|
void |
setRequiredActions(KeycloakSession session,
RealmModel realm,
UserModel user)
Set actions to configure authenticator
|
void |
success(FormContext context)
Called after all validate() calls of all FormAction providers are successful.
|
void |
validate(ValidationContext context)
This is the first phase of form processing.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
order
public static final String PROVIDER_ID
public String getHelpText()
getHelpText
in interface ConfiguredProvider
public List<ProviderConfigProperty> getConfigProperties()
getConfigProperties
in interface ConfiguredProvider
public void validate(ValidationContext context)
FormAction
validate
in interface FormAction
public void success(FormContext context)
FormAction
success
in interface FormAction
public void buildPage(FormContext context, LoginFormsProvider form)
FormAction
buildPage
in interface FormAction
public boolean requiresUser()
FormAction
requiresUser
in interface FormAction
public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
FormAction
configuredFor
in interface FormAction
public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
FormAction
setRequiredActions
in interface FormAction
public boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactory
isUserSetupAllowed
in interface ConfigurableAuthenticatorFactory
public void close()
ProviderFactory
close
in interface Provider
close
in interface ProviderFactory<FormAction>
public String getDisplayType()
ConfigurableAuthenticatorFactory
getDisplayType
in interface ConfigurableAuthenticatorFactory
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 FormAction create(KeycloakSession session)
create
in interface ProviderFactory<FormAction>
public void init(Config.Scope config)
ProviderFactory
init
in interface ProviderFactory<FormAction>
public void postInit(KeycloakSessionFactory factory)
ProviderFactory
postInit
in interface ProviderFactory<FormAction>
public String getId()
getId
in interface ProviderFactory<FormAction>
Copyright © 2021 JBoss by Red Hat. All rights reserved.