org.keycloak.authentication.requiredactions

Class TermsAndConditions

java.lang.Object

org.keycloak.authentication.requiredactions.TermsAndConditions

All Implemented Interfaces:

DisplayTypeRequiredActionFactory, RequiredActionFactory, RequiredActionProvider, Provider, ProviderFactory<RequiredActionProvider>

public class TermsAndConditions
extends Object
implements RequiredActionProvider, RequiredActionFactory, DisplayTypeRequiredActionFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_ID
static String	USER_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
TermsAndConditions()

Method Summary

Modifier and Type	Method and Description
void	close()
RequiredActionProvider	create(KeycloakSession session)
RequiredActionProvider	createDisplay(KeycloakSession session, String displayType)
void	evaluateTriggers(RequiredActionContext context)
String	getDisplayText()
String	getId()
void	init(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)
void	processAction(RequiredActionContext context)
void	requiredActionChallenge(RequiredActionContext context)

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

getMaxAuthAge, initiatedActionCanceled, initiatedActionSupport

Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

isOneTimeAction

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

TermsAndConditions

public TermsAndConditions()

Method Detail

create

public RequiredActionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RequiredActionProvider>

createDisplay

public RequiredActionProvider createDisplay(KeycloakSession session,
                                            String displayType)

Specified by:

createDisplay in interface DisplayTypeRequiredActionFactory

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>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<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 context)

Specified by:

processAction in interface RequiredActionProvider

getDisplayText

public String getDisplayText()

Specified by:

getDisplayText in interface RequiredActionFactory

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>