org.keycloak.authentication.requiredactions

Class WebAuthnRegisterFactory

java.lang.Object

org.keycloak.authentication.requiredactions.WebAuthnRegisterFactory

All Implemented Interfaces:

DisplayTypeRequiredActionFactory, RequiredActionFactory, EnvironmentDependentProviderFactory, ProviderFactory<RequiredActionProvider>

Direct Known Subclasses:

WebAuthnPasswordlessRegisterFactory

public class WebAuthnRegisterFactory
extends Object
implements RequiredActionFactory, DisplayTypeRequiredActionFactory, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_ID

Constructor Summary

Constructors

Constructor and Description
WebAuthnRegisterFactory()

Method Summary

Modifier and Type	Method and Description
void	close() This is called when the server shuts down.
RequiredActionProvider	create(KeycloakSession session)
RequiredActionProvider	createDisplay(KeycloakSession session, String displayType)
protected WebAuthnRegister	createProvider(KeycloakSession session, com.webauthn4j.validator.attestation.trustworthiness.certpath.CertPathTrustworthinessValidator trustValidator)
String	getDisplayText() Display text used in admin console to reference this required action
String	getId()
void	init(Config.Scope config) Only called once when the factory is first created.
boolean	isSupported()
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.RequiredActionFactory

isOneTimeAction

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

WebAuthnRegisterFactory

public WebAuthnRegisterFactory()

Method Detail

create

public RequiredActionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RequiredActionProvider>

createProvider

protected WebAuthnRegister createProvider(KeycloakSession session,
                                          com.webauthn4j.validator.attestation.trustworthiness.certpath.CertPathTrustworthinessValidator trustValidator)

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<RequiredActionProvider>

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<RequiredActionProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

createDisplay

public RequiredActionProvider createDisplay(KeycloakSession session,
                                            String displayType)

Specified by:

createDisplay in interface DisplayTypeRequiredActionFactory

getDisplayText

public String getDisplayText()

Description copied from interface: RequiredActionFactory

Display text used in admin console to reference this required action

Specified by:

getDisplayText in interface RequiredActionFactory

Returns:

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise