Class RecoveryAuthnCodesAction
- java.lang.Object
-
- org.keycloak.authentication.requiredactions.RecoveryAuthnCodesAction
-
- All Implemented Interfaces:
RequiredActionFactory
,RequiredActionProvider
,EnvironmentDependentProviderFactory
,Provider
,ProviderFactory<RequiredActionProvider>
public class RecoveryAuthnCodesAction extends Object implements RequiredActionProvider, RequiredActionFactory, EnvironmentDependentProviderFactory
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROVIDER_ID
-
Constructor Summary
Constructors Constructor Description RecoveryAuthnCodesAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
This is called when the server shuts down.RequiredActionProvider
create(KeycloakSession session)
protected RecoveryAuthnCodesCredentialModel
createFromValues(List<String> generatedCodes, Long generatedAtTime, String generatedUserLabel)
void
evaluateTriggers(RequiredActionContext context)
Called every time a user authenticates.String
getDisplayText()
Display text used in admin console to reference this required actionString
getId()
void
init(Config.Scope config)
Only called once when the factory is first created.InitiatedActionSupport
initiatedActionSupport()
Determines what type of support is provided for application-initiated actions.boolean
isOneTimeAction()
Flag indicating whether the execution of the required action by the same circumstances (e.g.boolean
isSupported()
void
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initializedvoid
processAction(RequiredActionContext reqActionContext)
Called when a required action has form input you want to process.void
requiredActionChallenge(RequiredActionContext context)
If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser.-
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.RequiredActionProvider
getMaxAuthAge, initiatedActionCanceled
-
-
-
-
Field Detail
-
PROVIDER_ID
public static final String PROVIDER_ID
-
-
Method Detail
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<RequiredActionProvider>
-
getDisplayText
public String getDisplayText()
Description copied from interface:RequiredActionFactory
Display text used in admin console to reference this required action- Specified by:
getDisplayText
in interfaceRequiredActionFactory
- Returns:
-
create
public RequiredActionProvider create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<RequiredActionProvider>
-
init
public void init(Config.Scope config)
Description copied from interface:ProviderFactory
Only called once when the factory is first created. This config is pulled from keycloak_server.json- Specified by:
init
in interfaceProviderFactory<RequiredActionProvider>
-
postInit
public void postInit(KeycloakSessionFactory factory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<RequiredActionProvider>
-
isOneTimeAction
public boolean isOneTimeAction()
Description copied from interface:RequiredActionFactory
Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.- Specified by:
isOneTimeAction
in interfaceRequiredActionFactory
- Returns:
-
initiatedActionSupport
public InitiatedActionSupport initiatedActionSupport()
Description copied from interface:RequiredActionProvider
Determines what type of support is provided for application-initiated actions.- Specified by:
initiatedActionSupport
in interfaceRequiredActionProvider
- Returns:
- InititatedActionsSupport
-
evaluateTriggers
public void evaluateTriggers(RequiredActionContext context)
Description copied from interface:RequiredActionProvider
Called every time a user authenticates. This checks to see if this required action should be triggered. The implementation of this method is responsible for setting the required action on the UserModel. For example, the UpdatePassword required actions checks the password policies to see if the password has expired.- Specified by:
evaluateTriggers
in interfaceRequiredActionProvider
-
requiredActionChallenge
public void requiredActionChallenge(RequiredActionContext context)
Description copied from interface:RequiredActionProvider
If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser. Return null if no action should be done.- Specified by:
requiredActionChallenge
in interfaceRequiredActionProvider
-
processAction
public void processAction(RequiredActionContext reqActionContext)
Description copied from interface:RequiredActionProvider
Called when a required action has form input you want to process.- Specified by:
processAction
in interfaceRequiredActionProvider
-
createFromValues
protected RecoveryAuthnCodesCredentialModel createFromValues(List<String> generatedCodes, Long generatedAtTime, String generatedUserLabel)
-
close
public void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProvider
- Specified by:
close
in interfaceProviderFactory<RequiredActionProvider>
-
isSupported
public boolean isSupported()
- Specified by:
isSupported
in interfaceEnvironmentDependentProviderFactory
- Returns:
true
if the provider is supported and should be available,false
otherwise
-
-