Package org.keycloak.authentication.forms

Class AbstractRegistrationRecaptcha

java.lang.Object

org.keycloak.authentication.forms.AbstractRegistrationRecaptcha

All Implemented Interfaces:

org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.authentication.FormAction, org.keycloak.authentication.FormActionFactory, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

Direct Known Subclasses:

RegistrationRecaptcha, RegistrationRecaptchaEnterprise

public abstract class AbstractRegistrationRecaptcha
extends Object
implements org.keycloak.authentication.FormAction, org.keycloak.authentication.FormActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION
static final String	G_RECAPTCHA_RESPONSE
static final String	INVISIBLE
static final String	RECAPTCHA_REFERENCE_CATEGORY
static final String	SITE_KEY
static final String	USE_RECAPTCHA_NET

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
AbstractRegistrationRecaptcha()

Method Summary

Modifier and Type	Method	Description
void	buildPage(org.keycloak.authentication.FormContext context, org.keycloak.forms.login.LoginFormsProvider form)
void	close()
boolean	configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
org.keycloak.authentication.FormAction	create(org.keycloak.models.KeycloakSession session)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
protected String	getRecaptchaDomain(Map<String,String> config)
String	getReferenceCategory()
org.keycloak.models.AuthenticationExecutionModel.Requirement[]	getRequirementChoices()
protected abstract String	getScriptUrl(Map<String,String> config, String userLanguageTag)
void	init(org.keycloak.Config.Scope config)
boolean	isConfigurable()
boolean	isUserSetupAllowed()
void	postInit(org.keycloak.models.KeycloakSessionFactory factory)
boolean	requiresUser()
void	setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
void	success(org.keycloak.authentication.FormContext context)
void	validate(org.keycloak.authentication.ValidationContext context)
protected abstract boolean	validate(org.keycloak.authentication.ValidationContext context, String captcha, Map<String,String> config)
protected abstract boolean	validateConfig(Map<String,String> config)

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.ConfigurableAuthenticatorFactory

getDisplayType, getOptionalReferenceCategories

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, getId, order

Field Details

G_RECAPTCHA_RESPONSE

public static final String G_RECAPTCHA_RESPONSE

See Also:

• Constant Field Values

RECAPTCHA_REFERENCE_CATEGORY

public static final String RECAPTCHA_REFERENCE_CATEGORY

See Also:

• Constant Field Values

SITE_KEY

public static final String SITE_KEY

See Also:

• Constant Field Values

ACTION

public static final String ACTION

See Also:

• Constant Field Values

INVISIBLE

public static final String INVISIBLE

See Also:

• Constant Field Values

USE_RECAPTCHA_NET

public static final String USE_RECAPTCHA_NET

See Also:

• Constant Field Values

Constructor Details

AbstractRegistrationRecaptcha

public AbstractRegistrationRecaptcha()

Method Details

getReferenceCategory

public String getReferenceCategory()

Specified by:

getReferenceCategory in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getRequirementChoices

public org.keycloak.models.AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Specified by:

getRequirementChoices in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getRecaptchaDomain

protected String getRecaptchaDomain(Map<String,String> config)

buildPage

public void buildPage(org.keycloak.authentication.FormContext context,
 org.keycloak.forms.login.LoginFormsProvider form)

Specified by:

buildPage in interface org.keycloak.authentication.FormAction

getScriptUrl

protected abstract String getScriptUrl(Map<String,String> config,
 String userLanguageTag)

validateConfig

protected abstract boolean validateConfig(Map<String,String> config)

validate

public void validate(org.keycloak.authentication.ValidationContext context)

Specified by:

validate in interface org.keycloak.authentication.FormAction

validate

protected abstract boolean validate(org.keycloak.authentication.ValidationContext context,
 String captcha,
 Map<String,String> config)

success

public void success(org.keycloak.authentication.FormContext context)

Specified by:

success in interface org.keycloak.authentication.FormAction

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface org.keycloak.authentication.FormAction

configuredFor

public boolean configuredFor(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user)

Specified by:

configuredFor in interface org.keycloak.authentication.FormAction

setRequiredActions

public void setRequiredActions(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user)

Specified by:

setRequiredActions in interface org.keycloak.authentication.FormAction

isUserSetupAllowed

public boolean isUserSetupAllowed()

Specified by:

isUserSetupAllowed in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

close

public void close()

Specified by:

close in interface org.keycloak.provider.Provider

Specified by:

close in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

create

public org.keycloak.authentication.FormAction create(org.keycloak.models.KeycloakSession session)

Specified by:

create in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

init

public void init(org.keycloak.Config.Scope config)

Specified by:

init in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

postInit

public void postInit(org.keycloak.models.KeycloakSessionFactory factory)

Specified by:

postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider