Package org.keycloak.models.map.storage.hotRod

Class HotRodMapStorage<K,E extends AbstractHotRodEntity,V extends AbstractEntity & HotRodEntityDelegate<E>,M>

java.lang.Object

org.keycloak.models.map.storage.hotRod.HotRodMapStorage<K,E,V,M>

All Implemented Interfaces:

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

Direct Known Subclasses:

SingleUseObjectHotRodMapStorage

public class HotRodMapStorage<K,E extends AbstractHotRodEntity,V extends AbstractEntity & HotRodEntityDelegate<E>,M>
extends Object
implements MapStorage<V,M>, ConcurrentHashMapCrudOperations<V,M>

Field Summary

Fields

Modifier and Type	Field	Description
protected DeepCloner	cloner
protected boolean	isExpirableEntity
protected StringKeyConverter<K>	keyConverter
protected HotRodEntityDescriptor<E,V>	storedEntityDescriptor

Constructor Summary

Constructors

Constructor	Description
HotRodMapStorage(org.infinispan.client.hotrod.RemoteCache<K,E> remoteCache, StringKeyConverter<K> keyConverter, HotRodEntityDescriptor<E,V> storedEntityDescriptor, DeepCloner cloner, AllAreasHotRodTransactionsWrapper txWrapper)

Method Summary

Modifier and Type	Method	Description
V	create(V value)	Creates an object in the store.
IckleQueryMapModelCriteriaBuilder<E,M>	createCriteriaBuilder()
MapKeycloakTransaction<V,M>	createTransaction(KeycloakSession session)	Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage.
protected MapKeycloakTransaction<V,M>	createTransactionInternal(KeycloakSession session)
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.
boolean	exists(String key)	Returns true if the object with the given key exists in the storage.
long	getCount(QueryParameters<M> queryParameters)	Returns the number 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.
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

Field Detail

keyConverter

protected final StringKeyConverter<K> keyConverter

storedEntityDescriptor

protected final HotRodEntityDescriptor<E extends AbstractHotRodEntity,V extends AbstractEntity & HotRodEntityDelegate<E>> storedEntityDescriptor

cloner

protected final DeepCloner cloner

isExpirableEntity

protected boolean isExpirableEntity

Constructor Detail

HotRodMapStorage

public HotRodMapStorage(org.infinispan.client.hotrod.RemoteCache<K,E> remoteCache,
                        StringKeyConverter<K> keyConverter,
                        HotRodEntityDescriptor<E,V> storedEntityDescriptor,
                        DeepCloner cloner,
                        AllAreasHotRodTransactionsWrapper txWrapper)

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,E extends AbstractHotRodEntity>

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,E extends AbstractHotRodEntity>

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,E extends AbstractHotRodEntity>

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,E extends AbstractHotRodEntity>

Returns:

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

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,E extends AbstractHotRodEntity>

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,E extends AbstractHotRodEntity>

Parameters:

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

Returns:

Number of objects. Never returns null.

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,E extends AbstractHotRodEntity>

Parameters:

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

Returns:

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

exists

public boolean exists(String key)

Description copied from interface: ConcurrentHashMapCrudOperations

Returns true if the object with the given key exists in the storage. false otherwise.

Specified by:

exists in interface ConcurrentHashMapCrudOperations<K,E extends AbstractHotRodEntity>

Parameters:

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

Returns:

See description

createCriteriaBuilder

public IckleQueryMapModelCriteriaBuilder<E,M> createCriteriaBuilder()

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,E extends AbstractHotRodEntity>

Returns:

See description. Never returns null

createTransactionInternal

protected MapKeycloakTransaction<V,M> createTransactionInternal(KeycloakSession session)