Package org.keycloak.authentication.authenticators.browser

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

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 authenticator
String	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	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	setMetadata(ScriptProviderMetadata metadata)

Methods inherited from class org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory

close, getReferenceCategory, getRequirementChoices, isConfigurable

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 Details

DeployedScriptAuthenticatorFactory

public DeployedScriptAuthenticatorFactory(ScriptProviderMetadata metadata)

DeployedScriptAuthenticatorFactory

public DeployedScriptAuthenticatorFactory()

Method Details

create

public Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

Overrides:

create in class ScriptBasedAuthenticatorFactory

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Authenticator>

Overrides:

getId in class ScriptBasedAuthenticatorFactory

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

Overrides:

isUserSetupAllowed in class ScriptBasedAuthenticatorFactory

Returns:

getDisplayType

public String getDisplayType()

Description copied from interface: ConfigurableAuthenticatorFactory

Friendly name for the authenticator

Specified by:

getDisplayType in interface ConfigurableAuthenticatorFactory

Overrides:

getDisplayType in class ScriptBasedAuthenticatorFactory

Returns:

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class ScriptBasedAuthenticatorFactory

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Overrides:

isSupported in class ScriptBasedAuthenticatorFactory

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 interface ProviderFactory<Authenticator>

Overrides:

init in class ScriptBasedAuthenticatorFactory

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<Authenticator>

Overrides:

postInit in class ScriptBasedAuthenticatorFactory

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Overrides:

getConfigProperties in class ScriptBasedAuthenticatorFactory

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()