Package org.keycloak.models.map.storage.chm

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

java.lang.Object

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

All Implemented Interfaces:

ConcurrentHashMapCrudOperations<V,M>, MapStorage<V,M>

Direct Known Subclasses:

SingleUseObjectConcurrentHashMapStorage

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

It contains basic object CRUD operations as well as bulk read(org.keycloak.models.map.storage.QueryParameters) and bulk delete(org.keycloak.models.map.storage.QueryParameters) operations, and operation for determining the number of the objects satisfying given criteria (getCount(org.keycloak.models.map.storage.QueryParameters)).

Author:

hmlnarik

Field Summary

Fields

Modifier and Type	Field	Description
protected DeepCloner	cloner
protected Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>>	fieldPredicates
protected StringKeyConverter<K>	keyConverter
protected ConcurrentMap<K,V>	store

Constructor Summary

Constructors

Constructor	Description
ConcurrentHashMapStorage(Class<M> modelClass, StringKeyConverter<K> keyConverter, DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
V	create(V value)	Creates an object in the store.
MapModelCriteriaBuilder<K,V,M>	createCriteriaBuilder()
MapKeycloakTransaction<V,M>	createTransaction(KeycloakSession session)	Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage.
boolean	delete(String key)	Deletes object with the given key from the storage, if exists, no-op otherwise.
long	delete(QueryParameters<M> queryParameters)	Deletes objects that match the given criteria.
long	getCount(QueryParameters<M> queryParameters)	Returns the number of objects satisfying given criteria from the storage.
StringKeyConverter<K>	getKeyConverter()
V	read(String key)	Returns object with the given key from the storage or null if object does not exist.
Stream<V>	read(QueryParameters<M> queryParameters)	Returns stream of objects satisfying given criteria from the storage.
V	update(V value)	Updates the object with the key of the value's 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

Methods inherited from interface org.keycloak.models.map.storage.chm.ConcurrentHashMapCrudOperations

determineKeyFromValue, exists, exists

Field Detail

store

protected final ConcurrentMap<K,V extends AbstractEntity & UpdatableEntity> store

fieldPredicates

protected final Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V extends AbstractEntity & UpdatableEntity,M>> fieldPredicates

keyConverter

protected final StringKeyConverter<K> keyConverter

cloner

protected final DeepCloner cloner

Constructor Detail

ConcurrentHashMapStorage

public ConcurrentHashMapStorage(Class<M> modelClass,
                                StringKeyConverter<K> keyConverter,
                                DeepCloner cloner)

Method Detail

create

public V create(V value)

Description copied from interface: ConcurrentHashMapCrudOperations

Creates an object in the store. ID of the value may be prescribed in id of the value. If the id is null or its format is not matching the store internal format for ID, then the value's ID will be generated and returned in the id of the return value.

Specified by:

create in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

value - Entity to create in the store

Returns:

Entity representing the value in the store. It may or may not be the same instance as value

See Also:

AbstractEntity.getId()

read

public V read(String key)

Description copied from interface: ConcurrentHashMapCrudOperations

Returns object with the given key from the storage or null if object does not exist.
If V implements ExpirableEntity this method should not return entities that are expired. See ExpirableEntity JavaDoc for more details. TODO: Consider returning Optional<V> instead.

Specified by:

read in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

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

Returns:

See description

update

public V update(V value)

Description copied from interface: ConcurrentHashMapCrudOperations

Updates the object with the key of the value's ID in the storage if it already exists.

Specified by:

update in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

value - Updated value

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)

See Also:

AbstractEntity.getId()

delete

public boolean delete(String key)

Description copied from interface: ConcurrentHashMapCrudOperations

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

Specified by:

delete in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Returns:

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

delete

public long delete(QueryParameters<M> queryParameters)

Description copied from interface: ConcurrentHashMapCrudOperations

Deletes objects that match the given criteria.

Specified by:

delete in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

queryParameters - parameters for the query like firstResult, maxResult, requested ordering, etc.

Returns:

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

createTransaction

public MapKeycloakTransaction<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 & UpdatableEntity>

Returns:

See description. Never returns null

createCriteriaBuilder

public MapModelCriteriaBuilder<K,V,M> createCriteriaBuilder()

getKeyConverter

public StringKeyConverter<K> getKeyConverter()

read

public Stream<V> read(QueryParameters<M> queryParameters)

Description copied from interface: ConcurrentHashMapCrudOperations

Returns stream of objects satisfying given criteria from the storage. The criteria are specified in the given criteria builder based on model properties. If V implements ExpirableEntity this method should not return entities that are expired. See ExpirableEntity JavaDoc for more details.

Specified by:

read in interface ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

queryParameters - parameters for the query like firstResult, maxResult, requested ordering, etc.

Returns:

Stream of objects. Never returns null.

getCount

public long getCount(QueryParameters<M> queryParameters)

Description copied from interface: ConcurrentHashMapCrudOperations

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 ConcurrentHashMapCrudOperations<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

queryParameters - parameters for the query like firstResult, maxResult, requested ordering, etc.

Returns:

Number of objects. Never returns null.