Package org.keycloak.models.map.storage.jpa

Class JpaMapStorageProviderFactory

java.lang.Object

org.keycloak.models.map.storage.jpa.JpaMapStorageProviderFactory

All Implemented Interfaces:

AmphibianProviderFactory<MapStorageProvider>, ComponentFactory<MapStorageProvider,MapStorageProvider>, MapStorageProviderFactory, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<MapStorageProvider>

public class JpaMapStorageProviderFactory
extends Object
implements AmphibianProviderFactory<MapStorageProvider>, MapStorageProviderFactory, EnvironmentDependentProviderFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.storage.MapStorageProviderFactory

MapStorageProviderFactory.Flag

Field Summary

Fields

Modifier and Type	Field	Description
static final DeepCloner	CLONER
static final String	HIBERNATE_DEFAULT_SCHEMA
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
JpaMapStorageProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
MapStorageProvider	create(KeycloakSession session)
protected jakarta.persistence.EntityManagerFactory	createEntityManagerFactory()
MapStorage	createMapStorage(KeycloakSession session, Class<?> modelType, jakarta.persistence.EntityManager em)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
protected Connection	getConnection()
protected jakarta.persistence.EntityManager	getEntityManager()
protected jakarta.persistence.EntityManagerFactory	getEntityManagerFactory()
String	getHelpText()
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
void	validateAndUpdateSchema(KeycloakSession session, Class<?> modelType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.component.AmphibianProviderFactory

create, getConfigProperties, onUpdate, preRemove

Methods inherited from interface org.keycloak.component.ComponentFactory

getCommonProviderConfigProperties, getTypeMetadata, onCreate, validateConfiguration

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.EnvironmentDependentProviderFactory

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

HIBERNATE_DEFAULT_SCHEMA

public static final String HIBERNATE_DEFAULT_SCHEMA

See Also:

• Constant Field Values

CLONER

public static final DeepCloner CLONER

Constructor Details

JpaMapStorageProviderFactory

public JpaMapStorageProviderFactory()

Method Details

createMapStorage

public MapStorage createMapStorage(KeycloakSession session,
 Class<?> modelType,
 jakarta.persistence.EntityManager em)

create

public MapStorageProvider create(KeycloakSession session)

Specified by:

create in interface AmphibianProviderFactory<MapStorageProvider>

Specified by:

create in interface ComponentFactory<MapStorageProvider,MapStorageProvider>

Specified by:

create in interface ProviderFactory<MapStorageProvider>

getEntityManager

protected jakarta.persistence.EntityManager getEntityManager()

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

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

getId

public String getId()

Specified by:

getId in interface ProviderFactory<MapStorageProvider>

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface AmphibianProviderFactory<MapStorageProvider>

Specified by:

close in interface ProviderFactory<MapStorageProvider>

createEntityManagerFactory

protected jakarta.persistence.EntityManagerFactory createEntityManagerFactory()

getEntityManagerFactory

protected jakarta.persistence.EntityManagerFactory getEntityManagerFactory()

validateAndUpdateSchema

public void validateAndUpdateSchema(KeycloakSession session,
 Class<?> modelType)

getConnection

protected Connection getConnection()

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<MapStorageProvider>

Returns:

a list with the metadata for each configuration property supported by this factory