Package org.keycloak.authentication.requiredactions

Class UpdateEmail

java.lang.Object

org.keycloak.authentication.requiredactions.UpdateEmail

All Implemented Interfaces:

RequiredActionFactory, RequiredActionProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<RequiredActionProvider>

public class UpdateEmail
extends Object
implements RequiredActionProvider, RequiredActionFactory, EnvironmentDependentProviderFactory

Constructor Summary

Constructors

Constructor	Description
UpdateEmail()

Method Summary

Modifier and Type	Method	Description
void	close()
RequiredActionProvider	create(KeycloakSession session)
void	evaluateTriggers(RequiredActionContext context)
String	getDisplayText()
String	getId()
void	init(Config.Scope config)
InitiatedActionSupport	initiatedActionSupport()
boolean	isSupported()
void	postInit(KeycloakSessionFactory factory)
void	processAction(RequiredActionContext context)
void	requiredActionChallenge(RequiredActionContext context)
static void	updateEmailNow(EventBuilder event, UserModel user, UserProfile emailUpdateValidationResult)
static UserProfile	validateEmailUpdate(KeycloakSession session, UserModel user, String newEmail)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 Details

UpdateEmail

public UpdateEmail()

Method Details

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Specified by:

initiatedActionSupport in interface RequiredActionProvider

getDisplayText

public String getDisplayText()

Specified by:

getDisplayText in interface RequiredActionFactory

evaluateTriggers

public void evaluateTriggers(RequiredActionContext context)

Specified by:

evaluateTriggers in interface RequiredActionProvider

requiredActionChallenge

public void requiredActionChallenge(RequiredActionContext context)

Specified by:

requiredActionChallenge in interface RequiredActionProvider

processAction

public void processAction(RequiredActionContext context)

Specified by:

processAction in interface RequiredActionProvider

validateEmailUpdate

public static UserProfile validateEmailUpdate(KeycloakSession session,
 UserModel user,
 String newEmail)

updateEmailNow

public static void updateEmailNow(EventBuilder event,
 UserModel user,
 UserProfile emailUpdateValidationResult)

create

public RequiredActionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RequiredActionProvider>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<RequiredActionProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<RequiredActionProvider>

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory