Class AbstractX509ClientCertificateAuthenticatorFactory
- java.lang.Object
-
- org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticatorFactory
-
- All Implemented Interfaces:
AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,ConfiguredProvider
,ProviderFactory<Authenticator>
- Direct Known Subclasses:
ValidateX509CertificateUsernameFactory
,X509ClientCertificateAuthenticatorFactory
public abstract class AbstractX509ClientCertificateAuthenticatorFactory extends Object implements AuthenticatorFactory
- Version:
- $Revision: 1 $
- Author:
- Peter Nalyvayko
-
-
Field Summary
Fields Modifier and Type Field Description protected static List<ProviderConfigProperty>
configProperties
protected static ServicesLogger
logger
-
Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
REQUIREMENT_CHOICES
-
-
Constructor Summary
Constructors Constructor Description AbstractX509ClientCertificateAuthenticatorFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
This is called when the server shuts down.List<ProviderConfigProperty>
getConfigProperties()
String
getReferenceCategory()
General authenticator type, i.e.void
init(Config.Scope config)
Only called once when the factory is first created.boolean
isConfigurable()
Is this authenticator configurable?boolean
isUserSetupAllowed()
Does this authenticator have required actions that can set if the user does not have this authenticator set up?void
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initialized-
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, getRequirementChoices
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getHelpText
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
create, getConfigMetadata, getId, order
-
-
-
-
Field Detail
-
logger
protected static ServicesLogger logger
-
configProperties
protected static final List<ProviderConfigProperty> configProperties
-
-
Method Detail
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
getReferenceCategory
public String getReferenceCategory()
Description copied from interface:ConfigurableAuthenticatorFactory
General authenticator type, i.e. totp, password, cert.- Specified by:
getReferenceCategory
in interfaceConfigurableAuthenticatorFactory
- Returns:
- null if not a referencable category
-
isConfigurable
public boolean isConfigurable()
Description copied from interface:ConfigurableAuthenticatorFactory
Is this authenticator configurable?- Specified by:
isConfigurable
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
isUserSetupAllowed
public boolean isUserSetupAllowed()
Description copied from interface:ConfigurableAuthenticatorFactory
Does this authenticator have required actions that can set if the user does not have this authenticator set up?- Specified by:
isUserSetupAllowed
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
init
public void init(Config.Scope config)
Description copied from interface:ProviderFactory
Only called once when the factory is first created. This config is pulled from keycloak_server.json- Specified by:
init
in interfaceProviderFactory<Authenticator>
-
postInit
public void postInit(KeycloakSessionFactory factory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<Authenticator>
-
close
public void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<Authenticator>
-
-