Package org.keycloak.storage.configuration.jpa

Class JpaServerConfigStorageProviderFactory

java.lang.Object

org.keycloak.storage.configuration.jpa.JpaServerConfigStorageProviderFactory

All Implemented Interfaces:

ProviderFactory<ServerConfigStorageProvider>, ServerConfigStorageProviderFactory

public class JpaServerConfigStorageProviderFactory
extends Object
implements ServerConfigStorageProviderFactory

A ServerConfigStorageProviderFactory that instantiates JpaServerConfigStorageProvider.

Constructor Summary

Constructors

Constructor	Description
JpaServerConfigStorageProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
JpaServerConfigStorageProvider	create(KeycloakSession session)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
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.provider.ProviderFactory

getConfigMetadata, order

Constructor Details

JpaServerConfigStorageProviderFactory

public JpaServerConfigStorageProviderFactory()

Method Details

create

public JpaServerConfigStorageProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ServerConfigStorageProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<ServerConfigStorageProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ServerConfigStorageProvider>

dependsOn

public Set<Class<? extends Provider>> dependsOn()

Description copied from interface: ProviderFactory

Optional method used to declare that a ProviderFactory has a dependency on one or more Providers. If a Provider is declared here, it is guaranteed that the dependencies ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory) method will be executed before this ProviderFactory's ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory). Similarly, it's guaranteed that ProviderFactory.close() will be called on this ProviderFactory before ProviderFactory.close() is called on any of the dependent ProviderFactory implementations.

Specified by:

dependsOn in interface ProviderFactory<ServerConfigStorageProvider>