Package org.keycloak.authentication.requiredactions

Class UpdateEmail

  • All Implemented Interfaces:
    org.keycloak.authentication.RequiredActionFactory, org.keycloak.authentication.RequiredActionProvider, org.keycloak.provider.EnvironmentDependentProviderFactory, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
    public class UpdateEmail
extends Object
implements org.keycloak.authentication.RequiredActionProvider, org.keycloak.authentication.RequiredActionFactory, org.keycloak.provider.EnvironmentDependentProviderFactory

    • Constructor Summary

      Constructors 
      Constructor Description
      UpdateEmail()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      org.keycloak.authentication.RequiredActionProvider create​(org.keycloak.models.KeycloakSession session)  
      void evaluateTriggers​(org.keycloak.authentication.RequiredActionContext context)  
      String getDisplayText()  
      String getId()  
      void init​(org.keycloak.Config.Scope config)  
      org.keycloak.authentication.InitiatedActionSupport initiatedActionSupport()  
      boolean isSupported()  
      void postInit​(org.keycloak.models.KeycloakSessionFactory factory)  
      void processAction​(org.keycloak.authentication.RequiredActionContext context)  
      void requiredActionChallenge​(org.keycloak.authentication.RequiredActionContext context)  
      static void updateEmailNow​(org.keycloak.events.EventBuilder event, org.keycloak.models.UserModel user, org.keycloak.userprofile.UserProfile emailUpdateValidationResult)  
      static org.keycloak.userprofile.UserProfile validateEmailUpdate​(org.keycloak.models.KeycloakSession session, org.keycloak.models.UserModel user, String newEmail)  

      • Methods inherited from interface org.keycloak.provider.EnvironmentDependentProviderFactory

        isSupported

      • Methods inherited from interface org.keycloak.provider.ProviderFactory

        getConfigMetadata, order

      • Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

        isOneTimeAction

      • Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

        getMaxAuthAge, initiatedActionCanceled

    • Constructor Detail

      • UpdateEmail

        public UpdateEmail()

    • Method Detail

      • initiatedActionSupport

        public org.keycloak.authentication.InitiatedActionSupport initiatedActionSupport()
        Specified by:
        initiatedActionSupport in interface org.keycloak.authentication.RequiredActionProvider

      • getDisplayText

        public String getDisplayText()
        Specified by:
        getDisplayText in interface org.keycloak.authentication.RequiredActionFactory

      • evaluateTriggers

        public void evaluateTriggers​(org.keycloak.authentication.RequiredActionContext context)
        Specified by:
        evaluateTriggers in interface org.keycloak.authentication.RequiredActionProvider

      • requiredActionChallenge

        public void requiredActionChallenge​(org.keycloak.authentication.RequiredActionContext context)
        Specified by:
        requiredActionChallenge in interface org.keycloak.authentication.RequiredActionProvider

      • processAction

        public void processAction​(org.keycloak.authentication.RequiredActionContext context)
        Specified by:
        processAction in interface org.keycloak.authentication.RequiredActionProvider

      • validateEmailUpdate

        public static org.keycloak.userprofile.UserProfile validateEmailUpdate​(org.keycloak.models.KeycloakSession session,
                                                                       org.keycloak.models.UserModel user,
                                                                       String newEmail)

      • updateEmailNow

        public static void updateEmailNow​(org.keycloak.events.EventBuilder event,
                                  org.keycloak.models.UserModel user,
                                  org.keycloak.userprofile.UserProfile emailUpdateValidationResult)

      • create

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

      • init

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

      • postInit

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

      • 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.RequiredActionProvider>

      • getId

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

      • isSupported

        public boolean isSupported()
        Specified by:
        isSupported in interface org.keycloak.provider.EnvironmentDependentProviderFactory