Class RegistrationRecaptcha
- java.lang.Object
-
- org.keycloak.authentication.forms.RegistrationRecaptcha
-
- 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>
public class RegistrationRecaptcha extends Object implements org.keycloak.authentication.FormAction, org.keycloak.authentication.FormActionFactory, org.keycloak.provider.ConfiguredProvider
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static String
G_RECAPTCHA_RESPONSE
static String
PROVIDER_ID
static String
RECAPTCHA_REFERENCE_CATEGORY
static String
SITE_KEY
static String
SITE_SECRET
static String
USE_RECAPTCHA_NET
-
Constructor Summary
Constructors Constructor Description RegistrationRecaptcha()
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
String
getDisplayType()
String
getHelpText()
String
getId()
String
getReferenceCategory()
org.keycloak.models.AuthenticationExecutionModel.Requirement[]
getRequirementChoices()
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 boolean
validateRecaptcha(org.keycloak.authentication.ValidationContext context, boolean success, String captcha, String secret)
-
-
-
Field Detail
-
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
-
SITE_SECRET
public static final String SITE_SECRET
- See Also:
- Constant Field Values
-
USE_RECAPTCHA_NET
public static final String USE_RECAPTCHA_NET
- See Also:
- Constant Field Values
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDisplayType
public String getDisplayType()
- Specified by:
getDisplayType
in interfaceorg.keycloak.authentication.ConfigurableAuthenticatorFactory
-
getReferenceCategory
public String getReferenceCategory()
- Specified by:
getReferenceCategory
in interfaceorg.keycloak.authentication.ConfigurableAuthenticatorFactory
-
isConfigurable
public boolean isConfigurable()
- Specified by:
isConfigurable
in interfaceorg.keycloak.authentication.ConfigurableAuthenticatorFactory
-
getRequirementChoices
public org.keycloak.models.AuthenticationExecutionModel.Requirement[] getRequirementChoices()
- Specified by:
getRequirementChoices
in interfaceorg.keycloak.authentication.ConfigurableAuthenticatorFactory
-
buildPage
public void buildPage(org.keycloak.authentication.FormContext context, org.keycloak.forms.login.LoginFormsProvider form)
- Specified by:
buildPage
in interfaceorg.keycloak.authentication.FormAction
-
validate
public void validate(org.keycloak.authentication.ValidationContext context)
- Specified by:
validate
in interfaceorg.keycloak.authentication.FormAction
-
validateRecaptcha
protected boolean validateRecaptcha(org.keycloak.authentication.ValidationContext context, boolean success, String captcha, String secret)
-
success
public void success(org.keycloak.authentication.FormContext context)
- Specified by:
success
in interfaceorg.keycloak.authentication.FormAction
-
requiresUser
public boolean requiresUser()
- Specified by:
requiresUser
in interfaceorg.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 interfaceorg.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 interfaceorg.keycloak.authentication.FormAction
-
isUserSetupAllowed
public boolean isUserSetupAllowed()
- Specified by:
isUserSetupAllowed
in interfaceorg.keycloak.authentication.ConfigurableAuthenticatorFactory
-
close
public void close()
- Specified by:
close
in interfaceorg.keycloak.provider.Provider
- Specified by:
close
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
-
create
public org.keycloak.authentication.FormAction create(org.keycloak.models.KeycloakSession session)
- Specified by:
create
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
-
init
public void init(org.keycloak.Config.Scope config)
- Specified by:
init
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
-
postInit
public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
- Specified by:
postInit
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
-
getId
public String getId()
- Specified by:
getId
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.authentication.FormAction>
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceorg.keycloak.provider.ConfiguredProvider
-
getConfigProperties
public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceorg.keycloak.provider.ConfiguredProvider
-
-