org.keycloak.models.map.storage.chm

Class ConcurrentHashMapStorage<K,V extends AbstractEntity<K>,M>

java.lang.Object

org.keycloak.models.map.storage.chm.ConcurrentHashMapStorage<K,V,M>

All Implemented Interfaces:

MapStorage<K,V,M>

Direct Known Subclasses:

UserSessionConcurrentHashMapStorage

public class ConcurrentHashMapStorage<K,V extends AbstractEntity<K>,M>
extends Object
implements MapStorage<K,V,M>

Author:

hmlnarik

Constructor Summary

Constructors

Constructor and Description
ConcurrentHashMapStorage(Class<M> modelClass, StringKeyConvertor<K> keyConvertor)

Method Summary

Modifier and Type	Method and Description
V	create(K key, V value) Creates an object in the store identified by given key.
ModelCriteriaBuilder<M>	createCriteriaBuilder() Returns criteria builder for the storage engine.
MapKeycloakTransaction<K,V,M>	createTransaction(KeycloakSession session) Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage.
boolean	delete(K key) Deletes object with the given key from the storage, if exists, no-op otherwise.
long	delete(ModelCriteriaBuilder<M> criteria) Deletes objects that match the given criteria.
long	getCount(ModelCriteriaBuilder<M> criteria) Returns the number of objects satisfying given criteria from the storage.
StringKeyConvertor<K>	getKeyConvertor() Returns a StringKeyConvertor that is used to convert primary keys from String to internal representation and vice versa.
V	read(K key) Returns object with the given key from the storage or null if object does not exist.
Stream<V>	read(ModelCriteriaBuilder<M> criteria) Returns stream of objects satisfying given criteria from the storage.
V	update(K key, V value) Updates the object with the given id in the storage if it already exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentHashMapStorage

public ConcurrentHashMapStorage(Class<M> modelClass,
                                StringKeyConvertor<K> keyConvertor)

Method Detail

create

public V create(K key,
                V value)

Description copied from interface: MapStorage

Creates an object in the store identified by given key.

Specified by:

create in interface MapStorage<K,V extends AbstractEntity<K>,M>

Parameters:

key - Key of the object as seen in the logical level

value - Entity

Returns:

Reference to the entity created in the store

read

public V read(K key)

Description copied from interface: MapStorage

Returns object with the given key from the storage or null if object does not exist.
TODO: Consider returning Optional<V> instead.

Specified by:

read in interface MapStorage<K,V extends AbstractEntity<K>,M>

Parameters:

key - Key of the object. Must not be null.

Returns:

See description

update

public V update(K key,
                V value)

Description copied from interface: MapStorage

Updates the object with the given id in the storage if it already exists.

Specified by:

update in interface MapStorage<K,V extends AbstractEntity<K>,M>

Parameters:

key - Primary key of the object to update

value - Updated value

delete

public boolean delete(K key)

Description copied from interface: MapStorage

Deletes object with the given key from the storage, if exists, no-op otherwise.

Specified by:

delete in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

Returns true if the object has been deleted or result cannot be determined, false otherwise.

delete

public long delete(ModelCriteriaBuilder<M> criteria)

Description copied from interface: MapStorage

Deletes objects that match the given criteria.

Specified by:

delete in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

Number of removed objects (might return -1 if not supported)

createCriteriaBuilder

public ModelCriteriaBuilder<M> createCriteriaBuilder()

Description copied from interface: MapStorage

Returns criteria builder for the storage engine. The criteria are specified in the given criteria builder based on model properties.
Note: While the criteria are formulated in terms of model properties, the storage engine may in turn process them into the best form that suits the underlying storage engine query language, e.g. to conditions on storage attributes or REST query parameters. If possible, do not delay filtering after the models are reconstructed from storage entities, in most cases this would be highly inefficient.

Specified by:

createCriteriaBuilder in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

See description. Never returns null

createTransaction

public MapKeycloakTransaction<K,V,M> createTransaction(KeycloakSession session)

Description copied from interface: MapStorage

Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage. In case of JPA or similar, the transaction object might be supplied by the container (via JTA) or shared same across storages accessing the same database within the same session; in other cases (e.g. plain map) a separate transaction handler might be created per each storage.

Specified by:

createTransaction in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

See description. Never returns null

getKeyConvertor

public StringKeyConvertor<K> getKeyConvertor()

Description copied from interface: MapStorage

Returns a StringKeyConvertor that is used to convert primary keys from String to internal representation and vice versa.

Specified by:

getKeyConvertor in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

See above. Never returns null.

read

public Stream<V> read(ModelCriteriaBuilder<M> criteria)

Description copied from interface: MapStorage

Returns stream of objects satisfying given criteria from the storage. The criteria are specified in the given criteria builder based on model properties.

Specified by:

read in interface MapStorage<K,V extends AbstractEntity<K>,M>

Parameters:

criteria - Criteria filtering out the object, originally obtained from MapStorage.createCriteriaBuilder() method of this object. If null, it returns an empty stream.

Returns:

Stream of objects. Never returns null.

getCount

public long getCount(ModelCriteriaBuilder<M> criteria)

Description copied from interface: MapStorage

Returns the number of objects satisfying given criteria from the storage. The criteria are specified in the given criteria builder based on model properties.

Specified by:

getCount in interface MapStorage<K,V extends AbstractEntity<K>,M>

Returns:

Number of objects. Never returns null.