Package org.keycloak.authentication.forms

Class RegistrationUserCreation

java.lang.Object
org.keycloak.authentication.forms.RegistrationUserCreation
All Implemented Interfaces:
org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.authentication.FormAction, org.keycloak.authentication.FormActionFactory, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
public class RegistrationUserCreation extends Object implements org.keycloak.authentication.FormAction, org.keycloak.authentication.FormActionFactory
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROVIDER_ID
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegistrationUserCreation()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    buildPage(org.keycloak.authentication.FormContext context, org.keycloak.forms.login.LoginFormsProvider form)
     
    void
    close()
     
    boolean
    configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     
    org.keycloak.authentication.FormAction
    create(org.keycloak.models.KeycloakSession session)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    String
    getDisplayType()
     
    String
    getHelpText()
     
    String
    getId()
     
    org.keycloak.userprofile.UserProfile
    getOrCreateUserProfile(org.keycloak.authentication.FormContext formContext, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
    Get user profile instance for current HTTP request (KeycloakSession) and for given context.
    String
    getReferenceCategory()
     
    org.keycloak.models.AuthenticationExecutionModel.Requirement[]
    getRequirementChoices()
     
    void
    init(org.keycloak.Config.Scope config)
     
    boolean
    isConfigurable()
     
    boolean
    isUserSetupAllowed()
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    boolean
    requiresUser()
     
    void
    setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     
    void
    success(org.keycloak.authentication.FormContext context)
     
    void
    validate(org.keycloak.authentication.ValidationContext context)
     

    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.ConfigurableAuthenticatorFactory

    getOptionalReferenceCategories

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, order

  • Field Details

  • Constructor Details

    • RegistrationUserCreation

      public RegistrationUserCreation()

  • Method Details

    • getHelpText

      public String getHelpText()
      Specified by:
      getHelpText in interface org.keycloak.provider.ConfiguredProvider

    • getConfigProperties

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

    • validate

      public void validate(org.keycloak.authentication.ValidationContext context)
      Specified by:
      validate in interface org.keycloak.authentication.FormAction

    • buildPage

      public void buildPage(org.keycloak.authentication.FormContext context, org.keycloak.forms.login.LoginFormsProvider form)
      Specified by:
      buildPage in interface org.keycloak.authentication.FormAction

    • success

      public void success(org.keycloak.authentication.FormContext context)
      Specified by:
      success in interface org.keycloak.authentication.FormAction

    • requiresUser

      public boolean requiresUser()
      Specified by:
      requiresUser in interface org.keycloak.authentication.FormAction

    • configuredFor

      public boolean configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
      Specified by:
      configuredFor in interface org.keycloak.authentication.FormAction

    • setRequiredActions

      public void setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
      Specified by:
      setRequiredActions in interface org.keycloak.authentication.FormAction

    • isUserSetupAllowed

      public boolean isUserSetupAllowed()
      Specified by:
      isUserSetupAllowed in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.Provider
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

    • getDisplayType

      public String getDisplayType()
      Specified by:
      getDisplayType in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • getReferenceCategory

      public String getReferenceCategory()
      Specified by:
      getReferenceCategory in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • isConfigurable

      public boolean isConfigurable()
      Specified by:
      isConfigurable in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • getRequirementChoices

      public org.keycloak.models.AuthenticationExecutionModel.Requirement[] getRequirementChoices()
      Specified by:
      getRequirementChoices in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • create

      public org.keycloak.authentication.FormAction create(org.keycloak.models.KeycloakSession session)
      Specified by:
      create in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

    • init

      public void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

    • postInit

      public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

    • getId

      public String getId()
      Specified by:
      getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

    • getOrCreateUserProfile

      public org.keycloak.userprofile.UserProfile getOrCreateUserProfile(org.keycloak.authentication.FormContext formContext, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
      Get user profile instance for current HTTP request (KeycloakSession) and for given context. This assumes that there is single user registered within HTTP request, which is always the case in Keycloak