org.keycloak.authentication.requiredactions

Class ConsoleTermsAndConditions

java.lang.Object

org.keycloak.authentication.requiredactions.ConsoleTermsAndConditions

All Implemented Interfaces:

RequiredActionProvider, Provider

public class ConsoleTermsAndConditions
extends Object
implements RequiredActionProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static ConsoleTermsAndConditions	SINGLETON
static String	USER_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ConsoleTermsAndConditions()

Method Summary

Modifier and Type	Method and Description
void	close()
void	evaluateTriggers(RequiredActionContext context) Called every time a user authenticates.
void	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.authentication.RequiredActionProvider

initiatedActionCanceled, initiatedActionSupport

Field Detail

SINGLETON

public static final ConsoleTermsAndConditions SINGLETON

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

ConsoleTermsAndConditions

public ConsoleTermsAndConditions()

Method Detail

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 interface RequiredActionProvider

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 interface RequiredActionProvider

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 interface RequiredActionProvider

close

public void close()

Specified by:

close in interface Provider