org.keycloak.models.map.storage

Interface MapKeycloakTransaction<K,V extends AbstractEntity<K>,M>

All Superinterfaces:

KeycloakTransaction

All Known Implementing Classes:

ConcurrentHashMapKeycloakTransaction

public interface MapKeycloakTransaction<K,V extends AbstractEntity<K>,M>
extends KeycloakTransaction

Method Summary

Modifier and Type	Method and Description
void	create(K key, V value) Instructs this transaction to add a new value into the underlying store on commit.
void	delete(K key) Instructs this transaction to delete a value associated with the identifier key from the underlying store on commit.
long	delete(K artificialKey, ModelCriteriaBuilder<M> mcb) Instructs this transaction to remove values (identified by mcb filter) from the underlying store on commit.
long	getCount(ModelCriteriaBuilder<M> mcb) Returns a number of values present in the underlying storage that fulfill the given criteria with respect to changes done in the current transaction.
default V	getUpdated(V orig) Returns an updated version of the orig object as updated in this transaction.
V	read(K key) Provides possibility to lookup for values by a key in the underlying store with respect to changes done in current transaction.
V	read(K key, Function<K,V> defaultValueFunc) Looks up a value in the current transaction with corresponding key, returns defaultValueFunc when the transaction does not contain a value for the key identifier.
Stream<V>	read(ModelCriteriaBuilder<M> mcb) Returns a stream of values from underlying storage that are updated based on the current transaction changes; i.e.
void	update(K key, V value) Instructs this transaction to force-update the value associated with the identifier key in the underlying store on commit.
void	updateIfChanged(K key, V value, Predicate<V> shouldPut) Instructs this transaction to update the value associated with the identifier key in the underlying store on commit, if by the time of commit the shouldPut predicate returns true

Methods inherited from interface org.keycloak.models.KeycloakTransaction

begin, commit, getRollbackOnly, isActive, rollback, setRollbackOnly

Method Detail

create

void create(K key,
            V value)

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

Parameters:

key - an identifier that will be associated with the value

value - the value

read

V read(K key)

Provides possibility to lookup for values by a key in the underlying store with respect to changes done in current transaction.

Parameters:

key - identifier of a value

Returns:

a value associated with the given key

read

V read(K key,
       Function<K,V> defaultValueFunc)

Looks up a value in the current transaction with corresponding key, returns defaultValueFunc when the transaction does not contain a value for the key identifier.

Parameters:

key - identifier of a value

defaultValueFunc - fallback function if the transaction does not contain a value that corresponds to key

Returns:

a value associated with the given key, or the result of defaultValueFunc

read

Stream<V> read(ModelCriteriaBuilder<M> mcb)

Returns a stream of values from underlying storage that are updated based on the current transaction changes; i.e. the result contains updates and excludes of records that have been created, updated or deleted in this transaction by methods create(K, V), update(K, V), delete(K), etc.

Parameters:

mcb - criteria to filter values

Returns:

values that fulfill the given criteria, that are updated based on changes in the current transaction

getCount

long getCount(ModelCriteriaBuilder<M> mcb)

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

Parameters:

mcb - criteria to filter values

Returns:

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

update

void update(K key,
            V value)

Instructs this transaction to force-update the value associated with the identifier key in the underlying store on commit.

Parameters:

key - identifier of the value

value - updated version of the value

getUpdated

default V getUpdated(V orig)

Returns an updated version of the orig object as updated in this transaction. If the underlying store handles transactions on its own, this can return orig directly.

Parameters:

orig - possibly stale version of some object from the underlying store

Returns:

the orig object as visible from this transaction, or null if the object has been removed.

updateIfChanged

void updateIfChanged(K key,
                     V value,
                     Predicate<V> shouldPut)

Instructs this transaction to update the value associated with the identifier key in the underlying store on commit, if by the time of commit the shouldPut predicate returns true

Parameters:

key - identifier of the value

value - new version of the value

shouldPut - predicate to check in commit phase

delete

void delete(K key)

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

Parameters:

key - identifier of a value

delete

long delete(K artificialKey,
            ModelCriteriaBuilder<M> mcb)

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

Parameters:

artificialKey - key to record the transaction with, must be a key that does not exist in this transaction to prevent collisions with other operations in this transaction

mcb - criteria to delete values