Package org.keycloak.authentication.requiredactions

Class RecoveryAuthnCodesAction

java.lang.Object

org.keycloak.authentication.requiredactions.RecoveryAuthnCodesAction

All Implemented Interfaces:

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

public class RecoveryAuthnCodesAction
extends Object
implements RequiredActionProvider, RequiredActionFactory, EnvironmentDependentProviderFactory, CredentialRegistrator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID
static final int	RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT
static final String	WARNING_THRESHOLD

Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

MAX_AUTH_AGE_CONFIG_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
RecoveryAuthnCodesAction()

Method Summary

Modifier and Type	Method	Description
void	close()
RequiredActionProvider	create(KeycloakSession session)
protected RecoveryAuthnCodesCredentialModel	createFromValues(List<String> generatedCodes, Long generatedAtTime, String generatedUserLabel)
void	evaluateTriggers(RequiredActionContext context)
List<ProviderConfigProperty>	getConfigMetadata()
String	getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
String	getDisplayText()
String	getId()
void	init(Config.Scope config)
InitiatedActionSupport	initiatedActionSupport()
boolean	isOneTimeAction()
boolean	isSupported(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)
void	processAction(RequiredActionContext reqActionContext)
void	requiredActionChallenge(RequiredActionContext context)
void	validateConfig(KeycloakSession session, RealmModel realm, RequiredActionConfigModel model)

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

dependsOn, order

Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

isConfigurable

Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

getMaxAuthAge, getMaxAuthAge, initiatedActionCanceled

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

WARNING_THRESHOLD

public static final String WARNING_THRESHOLD

See Also:

• Constant Field Values

RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT

public static final int RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT

See Also:

• Constant Field Values

Constructor Details

RecoveryAuthnCodesAction

public RecoveryAuthnCodesAction()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

getCredentialType

public String getCredentialType(KeycloakSession session,
 AuthenticationSessionModel authenticationSession)

Specified by:

getCredentialType in interface CredentialAction

getDisplayText

public String getDisplayText()

Specified by:

getDisplayText in interface RequiredActionFactory

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>

isOneTimeAction

public boolean isOneTimeAction()

Specified by:

isOneTimeAction in interface RequiredActionFactory

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Specified by:

initiatedActionSupport in interface RequiredActionProvider

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 reqActionContext)

Specified by:

processAction in interface RequiredActionProvider

createFromValues

protected RecoveryAuthnCodesCredentialModel createFromValues(List<String> generatedCodes,
 Long generatedAtTime,
 String generatedUserLabel)

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

isSupported

public boolean isSupported(Config.Scope config)

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Specified by:

getConfigMetadata in interface ProviderFactory<RequiredActionProvider>

Specified by:

getConfigMetadata in interface RequiredActionFactory

validateConfig

public void validateConfig(KeycloakSession session,
 RealmModel realm,
 RequiredActionConfigModel model)

Specified by:

validateConfig in interface RequiredActionFactory