Package org.keycloak.authentication.authenticators.resetcred

Class ResetCredentialEmail

java.lang.Object

org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail

All Implemented Interfaces:

Authenticator, AuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, Provider, ProviderFactory<Authenticator>

public class ResetCredentialEmail
extends Object
implements Authenticator, AuthenticatorFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FEDERATED_OPTION
static final String	FORCE_LOGIN
static final String	PROVIDER_ID
static final AuthenticationExecutionModel.Requirement[]	REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
ResetCredentialEmail()

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)
void	authenticate(AuthenticationFlowContext context)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
Authenticator	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()
String	getHelpText()
String	getId()
static Long	getLastChangedTimestamp(KeycloakSession session, RealmModel realm, UserModel user)
String	getReferenceCategory()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
void	init(Config.Scope config)
boolean	isConfigurable()
boolean	isUserSetupAllowed()
void	postInit(KeycloakSessionFactory factory)
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

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

areRequiredActionsEnabled, getRequiredActions

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

FORCE_LOGIN

public static final String FORCE_LOGIN

See Also:

• Constant Field Values

FEDERATED_OPTION

public static final String FEDERATED_OPTION

See Also:

• Constant Field Values

REQUIREMENT_CHOICES

public static final AuthenticationExecutionModel.Requirement[] REQUIREMENT_CHOICES

Constructor Details

ResetCredentialEmail

public ResetCredentialEmail()

Method Details

authenticate

public void authenticate(AuthenticationFlowContext context)

Specified by:

authenticate in interface Authenticator

getLastChangedTimestamp

public static Long getLastChangedTimestamp(KeycloakSession session,
 RealmModel realm,
 UserModel user)

action

public void action(AuthenticationFlowContext context)

Specified by:

action in interface Authenticator

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

configuredFor in interface Authenticator

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

setRequiredActions in interface Authenticator

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

getReferenceCategory

public String getReferenceCategory()

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

isUserSetupAllowed

public boolean isUserSetupAllowed()

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<Authenticator>

create

public Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<Authenticator>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<Authenticator>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>