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

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

java.lang.Object

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

All Implemented Interfaces:

KeycloakTransaction, HasRealmId, MapKeycloakTransaction<V,M>

Direct Known Subclasses:

FileMapKeycloakTransaction, HotRodUserSessionTransaction, SingleUseObjectKeycloakTransaction

public class ConcurrentHashMapKeycloakTransaction<K,V extends AbstractEntity & UpdatableEntity,M>
extends Object
implements MapKeycloakTransaction<V,M>, HasRealmId

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ConcurrentHashMapKeycloakTransaction.MapTaskWithValue

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected DeepCloner	cloner
protected Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>>	fieldPredicates
protected StringKeyConverter<K>	keyConverter
protected ConcurrentHashMapCrudOperations<V,M>	map
protected EntityField<V>	realmIdEntityField
protected boolean	rollback
protected Map<String,ConcurrentHashMapKeycloakTransaction.MapTaskWithValue>	tasks

Constructor Summary

Constructors

Constructor	Description
ConcurrentHashMapKeycloakTransaction(ConcurrentHashMapCrudOperations<V,M> map, StringKeyConverter<K> keyConverter, DeepCloner cloner, Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>> fieldPredicates)
ConcurrentHashMapKeycloakTransaction(ConcurrentHashMapCrudOperations<V,M> map, StringKeyConverter<K> keyConverter, DeepCloner cloner, Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>> fieldPredicates, EntityField<V> realmIdEntityField)

Method Summary

Modifier and Type	Method	Description
protected void	addTask(String key, ConcurrentHashMapKeycloakTransaction.MapTaskWithValue task)	Adds a given task if not exists for the given key
void	begin()
void	commit()
V	create(V value)	Instructs this transaction to add a new value into the underlying store on commit.
boolean	delete(String key)	Instructs this transaction to delete a value associated with the identifier key from the underlying store on commit.
long	delete(QueryParameters<M> queryParameters)	Instructs this transaction to remove values (identified by mcb filter) from the underlying store on commit.
boolean	exists(String key)	Returns true if the object with the given key exists in the underlying storage with respect to changes done in current transaction.
long	getCount(QueryParameters<M> queryParameters)	Returns a number of values present in the underlying storage that fulfill the given criteria with respect to changes done in the current transaction.
String	getRealmId()	Returns realm ID of the entity.
boolean	getRollbackOnly()
boolean	isActive()
V	read(String sKey)	Provides possibility to lookup for values by a key in the underlying store with respect to changes done in current transaction.
Stream<V>	read(QueryParameters<M> queryParameters)	Returns the stream of records that match given criteria and includes changes made in this transaction, i.e.
V	registerEntityForChanges(V origEntity)	Returns a deep clone of an entity.
void	rollback()
void	setRealmId(String realmId)	Sets the realm ID of this object.
void	setRollbackOnly()
V	updateIfChanged(V value, Predicate<V> shouldPut)

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.MapKeycloakTransaction

exists

Field Detail

active

protected boolean active

rollback

protected boolean rollback

tasks

protected final Map<String,ConcurrentHashMapKeycloakTransaction.MapTaskWithValue> tasks

map

protected final ConcurrentHashMapCrudOperations<V extends AbstractEntity & UpdatableEntity,M> map

keyConverter

protected final StringKeyConverter<K> keyConverter

cloner

protected final DeepCloner cloner

fieldPredicates

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

realmIdEntityField

protected final EntityField<V extends AbstractEntity & UpdatableEntity> realmIdEntityField

Constructor Detail

ConcurrentHashMapKeycloakTransaction

public ConcurrentHashMapKeycloakTransaction(ConcurrentHashMapCrudOperations<V,M> map,
                                            StringKeyConverter<K> keyConverter,
                                            DeepCloner cloner,
                                            Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>> fieldPredicates)

ConcurrentHashMapKeycloakTransaction

public ConcurrentHashMapKeycloakTransaction(ConcurrentHashMapCrudOperations<V,M> map,
                                            StringKeyConverter<K> keyConverter,
                                            DeepCloner cloner,
                                            Map<SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>> fieldPredicates,
                                            EntityField<V> realmIdEntityField)

Method Detail

begin

public void begin()

Specified by:

begin in interface KeycloakTransaction

commit

public void commit()

Specified by:

commit in interface KeycloakTransaction

rollback

public void rollback()

Specified by:

rollback in interface KeycloakTransaction

setRollbackOnly

public void setRollbackOnly()

Specified by:

setRollbackOnly in interface KeycloakTransaction

getRollbackOnly

public boolean getRollbackOnly()

Specified by:

getRollbackOnly in interface KeycloakTransaction

isActive

public boolean isActive()

Specified by:

isActive in interface KeycloakTransaction

addTask

protected void addTask(String key,
                       ConcurrentHashMapKeycloakTransaction.MapTaskWithValue task)

Adds a given task if not exists for the given key

registerEntityForChanges

public V registerEntityForChanges(V origEntity)

Returns a deep clone of an entity. If the clone is already in the transaction, returns this one.

Usually used before giving an entity from a source back to the caller, to prevent changing it directly in the data store, but to keep transactional properties.

Parameters:

origEntity - Original entity

Returns:

read

public V read(String sKey)

Description copied from interface: MapKeycloakTransaction

Provides possibility to lookup for values by a key in the underlying store with respect to changes done in current transaction. Updates to the returned instance would be visible in the current transaction and will propagate into the underlying store upon commit. If V implements ExpirableEntity this method should not return entities that are expired. See ExpirableEntity JavaDoc for more details.

Specified by:

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

Parameters:

sKey - identifier of a value

Returns:

a value associated with the given key

read

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

Returns the stream of records that match given criteria and includes changes made in this transaction, i.e. the result contains updates and excludes records that have been deleted in this transaction.

Specified by:

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

Parameters:

queryParameters -

Returns:

getCount

public long getCount(QueryParameters<M> queryParameters)

Description copied from interface: MapKeycloakTransaction

Returns a number of values present in the underlying storage that fulfill the given criteria with respect to changes done in the current transaction.

Specified by:

getCount in interface MapKeycloakTransaction<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

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

Returns:

number of values present in the storage that fulfill the given criteria

create

public V create(V value)

Description copied from interface: MapKeycloakTransaction

Instructs this transaction to add a new value into the underlying store on commit.

Updates to the returned instances of V would be visible in the current transaction and will propagate into the underlying store upon commit. The ID of the entity passed in the parameter might change to a different value in the returned value if the underlying storage decided this was necessary. If the ID of the entity was null before, it will be set on the returned value.

Specified by:

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

Parameters:

value - the value

Returns:

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

updateIfChanged

public V updateIfChanged(V value,
                         Predicate<V> shouldPut)

delete

public boolean delete(String key)

Description copied from interface: MapKeycloakTransaction

Instructs this transaction to delete a value associated with the identifier key from the underlying store on commit.

Specified by:

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

Parameters:

key - identifier of a value

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

Instructs this transaction to remove values (identified by mcb filter) from the underlying store on commit.

Specified by:

delete in interface MapKeycloakTransaction<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)

exists

public boolean exists(String key)

Description copied from interface: MapKeycloakTransaction

Returns true if the object with the given key exists in the underlying storage with respect to changes done in current transaction. false otherwise.

Specified by:

exists in interface MapKeycloakTransaction<K,V extends AbstractEntity & UpdatableEntity>

Parameters:

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

Returns:

See description

getRealmId

public String getRealmId()

Description copied from interface: HasRealmId

Returns realm ID of the entity.

Specified by:

getRealmId in interface HasRealmId

Returns:

See description

setRealmId

public void setRealmId(String realmId)

Description copied from interface: HasRealmId

Sets the realm ID of this object.

Specified by:

setRealmId in interface HasRealmId

Parameters:

realmId - Realm ID.