Class DeployedScriptAuthenticatorFactory
- java.lang.Object
-
- org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory
-
- org.keycloak.authentication.authenticators.browser.DeployedScriptAuthenticatorFactory
-
- All Implemented Interfaces:
AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,ConfiguredProvider
,EnvironmentDependentProviderFactory
,ProviderFactory<Authenticator>
public final class DeployedScriptAuthenticatorFactory extends ScriptBasedAuthenticatorFactory
- Author:
- Pedro Igor
-
-
Field Summary
-
Fields inherited from class org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory
PROVIDER_ID
-
-
Constructor Summary
Constructors Constructor Description DeployedScriptAuthenticatorFactory()
DeployedScriptAuthenticatorFactory(ScriptProviderMetadata metadata)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Authenticator
create(KeycloakSession session)
AuthenticatorConfigModel
getConfig()
Returns a default configuration for this provider.List<ProviderConfigProperty>
getConfigProperties()
String
getDisplayType()
Friendly name for the authenticatorString
getHelpText()
String
getId()
ScriptProviderMetadata
getMetadata()
void
init(Config.Scope config)
Only called once when the factory is first created.boolean
isSupported()
boolean
isUserSetupAllowed()
Does this authenticator have required actions that can set if the user does not have this authenticator set up?void
setMetadata(ScriptProviderMetadata metadata)
-
Methods inherited from class org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory
close, getReferenceCategory, getRequirementChoices, isConfigurable, postInit
-
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.EnvironmentDependentProviderFactory
isSupported
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
-
-
-
Constructor Detail
-
DeployedScriptAuthenticatorFactory
public DeployedScriptAuthenticatorFactory(ScriptProviderMetadata metadata)
-
DeployedScriptAuthenticatorFactory
public DeployedScriptAuthenticatorFactory()
-
-
Method Detail
-
create
public Authenticator create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<Authenticator>
- Overrides:
create
in classScriptBasedAuthenticatorFactory
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<Authenticator>
- Overrides:
getId
in classScriptBasedAuthenticatorFactory
-
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
- Overrides:
isUserSetupAllowed
in classScriptBasedAuthenticatorFactory
- Returns:
-
getDisplayType
public String getDisplayType()
Description copied from interface:ConfigurableAuthenticatorFactory
Friendly name for the authenticator- Specified by:
getDisplayType
in interfaceConfigurableAuthenticatorFactory
- Overrides:
getDisplayType
in classScriptBasedAuthenticatorFactory
- Returns:
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
- Overrides:
getHelpText
in classScriptBasedAuthenticatorFactory
-
isSupported
public boolean isSupported()
- Specified by:
isSupported
in interfaceEnvironmentDependentProviderFactory
- Overrides:
isSupported
in classScriptBasedAuthenticatorFactory
- Returns:
true
if the provider is supported and should be available,false
otherwise
-
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>
- Overrides:
init
in classScriptBasedAuthenticatorFactory
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
- Overrides:
getConfigProperties
in classScriptBasedAuthenticatorFactory
-
getConfig
public AuthenticatorConfigModel getConfig()
Description copied from interface:ConfiguredProvider
Returns a default configuration for this provider.- Returns:
- the default configuration
-
setMetadata
public void setMetadata(ScriptProviderMetadata metadata)
-
getMetadata
public ScriptProviderMetadata getMetadata()
-
-