Package org.keycloak.keys

Interface KeyProviderFactory<T extends KeyProvider>

All Superinterfaces:

ComponentFactory<T,KeyProvider>, ConfiguredProvider, ProviderFactory<KeyProvider>

All Known Implementing Classes:

AbstractEcdsaKeyProviderFactory, AbstractGeneratedRsaKeyProviderFactory, AbstractGeneratedSecretKeyProviderFactory, AbstractImportedRsaKeyProviderFactory, AbstractRsaKeyProviderFactory, GeneratedAesKeyProviderFactory, GeneratedEcdsaKeyProviderFactory, GeneratedHmacKeyProviderFactory, GeneratedRsaEncKeyProviderFactory, GeneratedRsaKeyProviderFactory, ImportedRsaEncKeyProviderFactory, ImportedRsaKeyProviderFactory, JavaKeystoreKeyProviderFactory

public interface KeyProviderFactory<T extends KeyProvider>
extends ComponentFactory<T,KeyProvider>

Author:

Stian Thorgersen

Method Summary

Modifier and Type	Method	Description
default void	close()	This is called when the server shuts down.
T	create(KeycloakSession session, ComponentModel model)
default boolean	createFallbackKeys(KeycloakSession session, KeyUse keyUse, String algorithm)
default void	init(Config.Scope config)	Only called once when the factory is first created.
default void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from interface org.keycloak.component.ComponentFactory

create, getCommonProviderConfigProperties, getTypeMetadata, onCreate, onUpdate, preRemove, validateConfiguration

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, getId, order

Method Detail

create

T create(KeycloakSession session,
         ComponentModel model)

Specified by:

create in interface ComponentFactory<T extends KeyProvider,KeyProvider>

createFallbackKeys

default boolean createFallbackKeys(KeycloakSession session,
                                   KeyUse keyUse,
                                   String algorithm)

init

default 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<T extends KeyProvider>

postInit

default void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<T extends KeyProvider>

close

default void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<T extends KeyProvider>