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:

MapStorage<V,M>

Direct Known Subclasses:

UserSessionConcurrentHashMapStorage

public class ConcurrentHashMapStorage<K,V extends AbstractEntity & UpdatableEntity,M>
extends Object
implements MapStorage<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(V value) Creates an object in the store.
ModelCriteriaBuilder<M>	createCriteriaBuilder() Returns criteria builder for the storage engine.
MapKeycloakTransaction<V,M>	createTransaction(KeycloakSession session) Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage.
long	delete(QueryParameters<M> queryParameters) Deletes objects that match the given criteria.
boolean	delete(String key) Deletes object with the given key from the storage, if exists, no-op otherwise.
long	getCount(QueryParameters<M> queryParameters) Returns the number of objects satisfying given criteria from the storage.
StringKeyConvertor<K>	getKeyConvertor()
Stream<V>	read(QueryParameters<M> queryParameters) Returns stream of objects satisfying given criteria from the storage.
V	read(String key) Returns object with the given key from the storage or null if object does not exist.
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

Constructor Detail

ConcurrentHashMapStorage

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

Method Detail

create

public V create(V value)

Description copied from interface: MapStorage

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 MapStorage<V extends AbstractEntity & UpdatableEntity,M>

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: 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<V extends AbstractEntity & UpdatableEntity,M>

Parameters:

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

Returns:

See description

update

public V update(V value)

Description copied from interface: MapStorage

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

Specified by:

update in interface MapStorage<V extends AbstractEntity & UpdatableEntity,M>

Parameters:

value - Updated value

See Also:

AbstractEntity.getId()

delete

public boolean delete(String 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<V extends AbstractEntity & UpdatableEntity,M>

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: MapStorage

Deletes objects that match the given criteria.

Specified by:

delete in interface MapStorage<V extends AbstractEntity & UpdatableEntity,M>

Parameters:

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

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

Returns:

See description. Never returns null

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

Returns:

See description. Never returns null

getKeyConvertor

public StringKeyConvertor<K> getKeyConvertor()

read

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

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

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: 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<V extends AbstractEntity & UpdatableEntity,M>

Parameters:

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

Returns:

Number of objects. Never returns null.