Package org.keycloak.authentication.authenticators.conditional

Interface ConditionalAuthenticatorFactory

All Superinterfaces:

AuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, DisplayTypeAuthenticatorFactory, ProviderFactory<Authenticator>

All Known Implementing Classes:

ConditionalLoaAuthenticatorFactory, ConditionalRoleAuthenticatorFactory, ConditionalUserAttributeValueFactory, ConditionalUserConfiguredAuthenticatorFactory

public interface ConditionalAuthenticatorFactory
extends AuthenticatorFactory, DisplayTypeAuthenticatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
static String	REFERENCE_CATEGORY

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Method Summary

Modifier and Type	Method	Description
default Authenticator	create(KeycloakSession session)
default Authenticator	createDisplay(KeycloakSession session, String displayType)
default String	getReferenceCategory()	General authenticator type, i.e.
ConditionalAuthenticator	getSingleton()

Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

getDisplayType, getRequirementChoices, isConfigurable, isUserSetupAllowed

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, getConfigMetadata, getId, init, order, postInit

Field Detail

REFERENCE_CATEGORY

static final String REFERENCE_CATEGORY

See Also:

Constant Field Values

Method Detail

create

default Authenticator create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<Authenticator>

createDisplay

default Authenticator createDisplay(KeycloakSession session,
                                    String displayType)

Specified by:

createDisplay in interface DisplayTypeAuthenticatorFactory

displayType - i.e. "console", "wap", "popup" are examples

Returns:

null if display type isn't support.

getReferenceCategory

default String getReferenceCategory()

Description copied from interface: ConfigurableAuthenticatorFactory

General authenticator type, i.e. totp, password, cert.

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

Returns:

null if not a referencable category

getSingleton

ConditionalAuthenticator getSingleton()