Class TermsAndConditions
- java.lang.Object
-
- org.keycloak.authentication.requiredactions.TermsAndConditions
-
- All Implemented Interfaces:
RequiredActionFactory
,RequiredActionProvider
,Provider
,ProviderFactory<RequiredActionProvider>
public class TermsAndConditions extends Object implements RequiredActionProvider, RequiredActionFactory
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROVIDER_ID
static String
USER_ATTRIBUTE
-
Constructor Summary
Constructors Constructor Description TermsAndConditions()
-
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)
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.void
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initializedvoid
processAction(RequiredActionContext context)
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.ProviderFactory
getConfigMetadata, order
-
Methods inherited from interface org.keycloak.authentication.RequiredActionFactory
isOneTimeAction
-
Methods inherited from interface org.keycloak.authentication.RequiredActionProvider
getMaxAuthAge, initiatedActionCanceled, initiatedActionSupport
-
-
-
-
Field Detail
-
PROVIDER_ID
public static final String PROVIDER_ID
-
USER_ATTRIBUTE
public static final String USER_ATTRIBUTE
- See Also:
- Constant Field Values
-
-
Method Detail
-
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>
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<RequiredActionProvider>
-
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 context)
Description copied from interface:RequiredActionProvider
Called when a required action has form input you want to process.- Specified by:
processAction
in interfaceRequiredActionProvider
-
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:
-
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>
-
-