Package org.keycloak.authentication.forms

Class RegistrationTermsAndConditions

java.lang.Object

org.keycloak.authentication.forms.RegistrationTermsAndConditions

All Implemented Interfaces:

ConfigurableAuthenticatorFactory, FormAction, FormActionFactory, ConfiguredProvider, Provider, ProviderFactory<FormAction>

public class RegistrationTermsAndConditions
extends Object
implements FormAction, FormActionFactory, ConfiguredProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	FIELD
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
RegistrationTermsAndConditions()

Method Summary

Modifier and Type	Method	Description
void	buildPage(FormContext context, LoginFormsProvider form)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
FormAction	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()
String	getHelpText()
String	getId()
String	getReferenceCategory()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
void	init(Config.Scope config)
boolean	isConfigurable()
boolean	isUserSetupAllowed()
void	postInit(KeycloakSessionFactory factory)
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
void	success(FormContext context)
void	validate(ValidationContext 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.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

FIELD

protected static final String FIELD

See Also:

• Constant Field Values

Constructor Details

RegistrationTermsAndConditions

public RegistrationTermsAndConditions()

Method Details

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

getReferenceCategory

public String getReferenceCategory()

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

isUserSetupAllowed

public boolean isUserSetupAllowed()

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

buildPage

public void buildPage(FormContext context,
 LoginFormsProvider form)

Specified by:

buildPage in interface FormAction

validate

public void validate(ValidationContext context)

Specified by:

validate in interface FormAction

success

public void success(FormContext context)

Specified by:

success in interface FormAction

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface FormAction

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

configuredFor in interface FormAction

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

setRequiredActions in interface FormAction

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

create

public FormAction create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<FormAction>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<FormAction>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<FormAction>

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<FormAction>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<FormAction>