public class RegistrationUserCreation extends Object implements FormAction, FormActionFactory
| Modifier and Type | Field and Description |
|---|---|
static String |
PROVIDER_ID |
| Constructor and Description |
|---|
RegistrationUserCreation() |
| 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.
|
public static final String PROVIDER_ID
public String getHelpText()
getHelpText in interface ConfiguredProviderpublic List<ProviderConfigProperty> getConfigProperties()
getConfigProperties in interface ConfiguredProviderpublic void validate(ValidationContext context)
FormActionvalidate in interface FormActionpublic void buildPage(FormContext context, LoginFormsProvider form)
FormActionbuildPage in interface FormActionpublic void success(FormContext context)
FormActionsuccess in interface FormActionpublic boolean requiresUser()
FormActionrequiresUser in interface FormActionpublic boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
FormActionconfiguredFor in interface FormActionpublic void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
FormActionsetRequiredActions in interface FormActionpublic boolean isUserSetupAllowed()
ConfigurableAuthenticatorFactoryisUserSetupAllowed in interface ConfigurableAuthenticatorFactorypublic void close()
ProviderFactoryclose in interface Providerclose in interface ProviderFactory<FormAction>public String getDisplayType()
ConfigurableAuthenticatorFactorygetDisplayType in interface ConfigurableAuthenticatorFactorypublic String getReferenceCategory()
ConfigurableAuthenticatorFactorygetReferenceCategory in interface ConfigurableAuthenticatorFactorypublic boolean isConfigurable()
ConfigurableAuthenticatorFactoryisConfigurable in interface ConfigurableAuthenticatorFactorypublic AuthenticationExecutionModel.Requirement[] getRequirementChoices()
ConfigurableAuthenticatorFactorygetRequirementChoices in interface ConfigurableAuthenticatorFactorypublic FormAction create(KeycloakSession session)
create in interface ProviderFactory<FormAction>public void init(Config.Scope config)
ProviderFactoryinit in interface ProviderFactory<FormAction>public void postInit(KeycloakSessionFactory factory)
ProviderFactorypostInit in interface ProviderFactory<FormAction>public String getId()
getId in interface ProviderFactory<FormAction>Copyright © 2016 JBoss by Red Hat. All rights reserved.