Package org.keycloak.storage.configuration.jpa

Class JpaServerConfigStorageProvider

java.lang.Object

org.keycloak.storage.configuration.jpa.JpaServerConfigStorageProvider

All Implemented Interfaces:

Provider, ServerConfigStorageProvider

public class JpaServerConfigStorageProvider
extends Object
implements ServerConfigStorageProvider

A ServerConfigStorageProvider that stores its data in the database, using the EntityManager.

Constructor Summary

Constructors

Constructor	Description
JpaServerConfigStorageProvider(jakarta.persistence.EntityManager entityManager)

Method Summary

Modifier and Type	Method	Description
void	close()
Optional<String>	find(String key)	Returns the value to which the specified key.
String	loadOrCreate(String key, Supplier<String> valueGenerator)	Returns the value to which the specified key or, if not found, stores the value returned by the valueGenerator.
void	remove(String key)	Removes the value specified by the key.
boolean	replace(String key, Predicate<String> replacePredicate, Supplier<String> valueGenerator)	Replaces the value specified by key if the Predicate return a true value.
void	store(String key, String value)	Stores the specified value with the specified key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.storage.configuration.ServerConfigStorageProvider

loadOrCreate, replace

Constructor Details

JpaServerConfigStorageProvider

public JpaServerConfigStorageProvider(jakarta.persistence.EntityManager entityManager)

Method Details

find

public Optional<String> find(String key)

Description copied from interface: ServerConfigStorageProvider

Returns the value to which the specified key.

Specified by:

find in interface ServerConfigStorageProvider

Parameters:

key - The key whose associated value is to be returned.

Returns:

The value from the specified key.

store

public void store(String key,
 String value)

Description copied from interface: ServerConfigStorageProvider

Stores the specified value with the specified key.

If the key exists, its value is updated.

Specified by:

store in interface ServerConfigStorageProvider

Parameters:

key - The key with which the specified value is to be stored.

value - The value to be associated with the specified key.

remove

public void remove(String key)

Description copied from interface: ServerConfigStorageProvider

Removes the value specified by the key.

Specified by:

remove in interface ServerConfigStorageProvider

Parameters:

key - The key whose value is to be removed.

loadOrCreate

public String loadOrCreate(String key,
 Supplier<String> valueGenerator)

Description copied from interface: ServerConfigStorageProvider

Returns the value to which the specified key or, if not found, stores the value returned by the valueGenerator.

Specified by:

loadOrCreate in interface ServerConfigStorageProvider

Parameters:

key - The key whose associated value is to be returned or stored.

valueGenerator - The Supplier to generate the value if it is not found.

Returns:

The {value stored by the key, or the value generated by the Supplier.

replace

public boolean replace(String key,
 Predicate<String> replacePredicate,
 Supplier<String> valueGenerator)

Description copied from interface: ServerConfigStorageProvider

Replaces the value specified by key if the Predicate return a true value.

Specified by:

replace in interface ServerConfigStorageProvider

Parameters:

key - The key whose associated value is to be replaced.

replacePredicate - The Predicate to signal if the value should be replaced.

valueGenerator - The Supplier to generate the value if it is should be replaced.

Returns:

true if the value is replaced, and false otherwise.

close

public void close()

Specified by:

close in interface Provider