Package org.keycloak.authentication.forms

Class RegistrationRecaptcha

java.lang.Object

org.keycloak.authentication.forms.AbstractRegistrationRecaptcha

org.keycloak.authentication.forms.RegistrationRecaptcha

All Implemented Interfaces:

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

public class RegistrationRecaptcha
extends AbstractRegistrationRecaptcha

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID
static final String	SECRET_KEY

Fields inherited from class org.keycloak.authentication.forms.AbstractRegistrationRecaptcha

ACTION, G_RECAPTCHA_RESPONSE, INVISIBLE, RECAPTCHA_REFERENCE_CATEGORY, SITE_KEY, USE_RECAPTCHA_NET

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
RegistrationRecaptcha()

Method Summary

Modifier and Type	Method	Description
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()	Friendly name for the authenticator
String	getHelpText()
String	getId()
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()	What requirement settings are allowed.
protected String	getScriptUrl(Map<String,String> config, String userLanguageTag)
protected boolean	validate(ValidationContext context, String captcha, Map<String,String> config)
protected boolean	validateConfig(Map<String,String> config)

Methods inherited from class org.keycloak.authentication.forms.AbstractRegistrationRecaptcha

buildPage, close, configuredFor, create, getRecaptchaDomain, getReferenceCategory, init, isConfigurable, isUserSetupAllowed, postInit, requiresUser, setRequiredActions, success, validate

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

getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

SECRET_KEY

public static final String SECRET_KEY

See Also:

• Constant Field Values

Constructor Details

RegistrationRecaptcha

public RegistrationRecaptcha()

Method Details

getDisplayType

public String getDisplayType()

Description copied from interface: ConfigurableAuthenticatorFactory

Friendly name for the authenticator

Returns:

getHelpText

public String getHelpText()

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Description copied from interface: ConfigurableAuthenticatorFactory

What requirement settings are allowed.

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

Overrides:

getRequirementChoices in class AbstractRegistrationRecaptcha

Returns:

validateConfig

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

Specified by:

validateConfig in class AbstractRegistrationRecaptcha

validate

protected boolean validate(ValidationContext context,
 String captcha,
 Map<String,String> config)

Specified by:

validate in class AbstractRegistrationRecaptcha

getScriptUrl

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

Specified by:

getScriptUrl in class AbstractRegistrationRecaptcha

getId

public String getId()

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Overrides:

getConfigProperties in class AbstractRegistrationRecaptcha