org.gridgain.grid.kernal.processors.cache

Interface GridCacheTxLocalEx<K,V>

All Superinterfaces:

AutoCloseable, GridCacheTx, GridCacheTxEx<K,V>, GridMetadataAware, GridTimeoutObject, Serializable

All Known Implementing Classes:

GridCacheTxLocalAdapter, GridDhtColocatedTxLocal, GridDhtTxLocal, GridDhtTxLocalAdapter

public interface GridCacheTxLocalEx<K,V>
extends GridCacheTxEx<K,V>

Local transaction API.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheTxEx

GridCacheTxEx.FinalizationStatus

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	commitError()
void	commitError(Throwable e)
boolean	finish(boolean commit) Finishes transaction (either commit or rollback).
GridFuture<GridCacheTxEx<K,V>>	future()
GridFuture<Map<K,V>>	getAllAsync(Collection<? extends K> keys, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<?>	groupLockAsync(Collection<K> keys) Performs keys locking for affinity-based group lock transactions.
GridCacheTxEntry<K,V>	groupLockEntry()
GridFuture<Boolean>	loadMissing(boolean async, Collection<? extends K> keys, GridBiInClosure<K,V> c)
GridCacheVersion	minVersion()
boolean	partitionLock()
V	put(K key, V val, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridCacheReturn<V>	putAll(Map<? extends K,? extends V> map, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<GridCacheReturn<V>>	putAllAsync(Map<? extends K,? extends V> map, boolean retval, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
void	putAllDr(Map<? extends K,GridCacheDrInfo<V>> drMap)
GridFuture<?>	putAllDrAsync(Map<? extends K,GridCacheDrInfo<V>> drMap)
GridFuture<V>	putAsync(K key, V val, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<V>	putAsync(K key, V val, GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	putx(K key, V val, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	putx(K key, V val, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<Boolean>	putxAsync(K key, V val, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<Boolean>	putxAsync(K key, V val, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<GridCacheReturn<V>>	putxAsync0(K key, V val, GridCacheEntryEx<K,V> cached, long ttl, GridPredicate<GridCacheEntry<K,V>>[] filter)
V	remove(K key, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridCacheReturn<V>	removeAll(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<GridCacheReturn<V>>	removeAllAsync(Collection<? extends K> keys, GridCacheEntryEx<K,V> cached, boolean implicit, boolean retval, GridPredicate<GridCacheEntry<K,V>>[] filter)
void	removeAllDr(Map<? extends K,GridCacheVersion> drMap)
GridFuture<?>	removeAllDrAsync(Map<? extends K,GridCacheVersion> drMap)
GridFuture<V>	removeAsync(K key, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter) Asynchronous remove.
boolean	removex(K key, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<Boolean>	removexAsync(K key, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter) Asynchronous remove.
GridFuture<GridCacheReturn<V>>	removexAsync0(K key, GridCacheEntryEx<K,V> cached, GridPredicate<GridCacheEntry<K,V>>[] filter) Asynchronous remove.
boolean	transform(K key, GridClosure<V,V> valTransform)
void	transformAll(Map<? extends K,? extends GridClosure<V,V>> map)
GridFuture<?>	transformAllAsync(Map<? extends K,? extends GridClosure<V,V>> map)
GridFuture<Boolean>	transformAsync(K key, GridClosure<V,V> transformer, GridCacheEntryEx<K,V> cached, long ttl)
<R> R	transformCompute(K key, GridClosure<V,GridBiTuple<V,R>> transformer)
void	userCommit()
void	userRollback()

Methods inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheTxEx

addInvalidPartition, addLocalCandidates, allEntries, alternateVersions, colocated, commitVersion, commitVersion, completedVersions, dht, done, empty, endVersion, endVersion, enforceSerializable, entry, eventNodeId, finishFuture, groupLock, groupLockKey, hasReadKey, hasWriteKey, implicitSingle, internal, invalidate, invalidPartitions, isSystemInvalidate, local, localCandidates, markFinalizing, markPreparing, masterNodeIds, near, nearXidVersion, needsCompletedVersions, onePhaseCommit, onOwnerChanged, optimistic, optimisticLockEntries, originatingNodeId, otherNodeId, ownedVersion, ownsLock, ownsLockUnsafe, peek, pessimistic, prepare, prepareAsync, readCommitted, readEntries, readMap, readSet, recoveryWrites, remainingTime, removed, repeatableRead, replicated, rollbackAsync, seal, serializable, size, startVersion, state, subjectId, syncCommit, syncRollback, systemInvalidate, timedOut, topologyVersion, topologyVersion, transactionNodes, user, writeEntries, writeMap, writeSet, writeVersion, writeVersion, xidVersion

Methods inherited from interface org.gridgain.grid.cache.GridCacheTx

close, commit, commitAsync, concurrency, implicit, isInvalidate, isolation, isRollbackOnly, nodeId, rollback, setRollbackOnly, startTime, state, threadId, timeout, timeout, xid

Methods inherited from interface org.gridgain.grid.GridMetadataAware

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, removeMeta, removeMeta, replaceMeta

Methods inherited from interface org.gridgain.grid.kernal.processors.timeout.GridTimeoutObject

endTime, onTimeout, timeoutId

Method Detail

minVersion

GridCacheVersion minVersion()

Returns:

Minimum version involved in transaction.

future

GridFuture<GridCacheTxEx<K,V>> future()

Returns:

Future for this transaction.

commitError

@Nullable
Throwable commitError()

Returns:

Commit error.

commitError

void commitError(Throwable e)

Parameters:

e - Commit error.

userCommit

void userCommit()
                throws GridException

Throws:

GridException - If commit failed.

userRollback

void userRollback()
                  throws GridException

Throws:

GridException - If rollback failed.

groupLockEntry

@Nullable
GridCacheTxEntry<K,V> groupLockEntry()

Returns:

Group lock entry if this is a group-lock transaction.

getAllAsync

GridFuture<Map<K,V>> getAllAsync(Collection<? extends K> keys,
                               @Nullable
                               GridCacheEntryEx<K,V> cached,
                               GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

keys - Keys to get.

cached - Cached entry if this method is called from entry wrapper. Cached entry is passed if and only if there is only one key in collection of keys.

filter - Entry filter.

Returns:

Future for this get.

put

V put(K key,
    V val,
    @Nullable
    GridCacheEntryEx<K,V> cached,
    long ttl,
    GridPredicate<GridCacheEntry<K,V>>[] filter)
      throws GridException

Parameters:

key - Key.

val - Value.

cached - Cached cache entry, if called from entry wrapper.

ttl - Entry time-to-live value. If negative, leave unchanged.

filter - Filter.

Returns:

Old value.

Throws:

GridException - If put failed.

putx

boolean putx(K key,
           V val,
           GridPredicate<GridCacheEntry<K,V>>[] filter)
             throws GridException

Parameters:

key - Key.

val - Value.

filter - Filter.

Returns:

True if put succeeded.

Throws:

GridException - If put failed.

transform

boolean transform(K key,
                GridClosure<V,V> valTransform)
                  throws GridException

Parameters:

key - Key.

valTransform - Value transform closure.

Returns:

True if put succeeded.

Throws:

GridException - If put failed.

transformCompute

<R> R transformCompute(K key,
                     GridClosure<V,GridBiTuple<V,R>> transformer)
                   throws GridException

Parameters:

key - Key.

transformer - Closure.

Returns:

Value computed by the given closure.

Throws:

GridException - If failed.

putx

boolean putx(K key,
           V val,
           @Nullable
           GridCacheEntryEx<K,V> cached,
           long ttl,
           GridPredicate<GridCacheEntry<K,V>>[] filter)
             throws GridException

Parameters:

key - Key.

val - Value.

cached - Cached cache entry, if called from entry wrapper.

ttl - Time to live for entry. If negative, leave unchanged.

filter - Filter.

Returns:

True if put succeeded.

Throws:

GridException - If put failed.

putAll

GridCacheReturn<V> putAll(Map<? extends K,? extends V> map,
                        GridPredicate<GridCacheEntry<K,V>>[] filter)
                          throws GridException

Parameters:

map - Map to put.

filter - Filter.

Returns:

Old value for the first key in the map.

Throws:

GridException - If put failed.

putAllDr

void putAllDr(Map<? extends K,GridCacheDrInfo<V>> drMap)
              throws GridException

Parameters:

drMap - DR map to put.

Throws:

GridException - If put failed.

putAllDrAsync

GridFuture<?> putAllDrAsync(Map<? extends K,GridCacheDrInfo<V>> drMap)

Parameters:

drMap - DR map to put.

Returns:

Future all the put operation which will return value as if put(Object, Object, GridCacheEntryEx, long, GridPredicate[]) was called.

transformAll

void transformAll(@Nullable
                Map<? extends K,? extends GridClosure<V,V>> map)
                  throws GridException

Parameters:

map - Map to put.

Throws:

GridException - If put failed.

putAsync

GridFuture<V> putAsync(K key,
                     V val,
                     GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key.

val - Value.

filter - Filter.

Returns:

Value future.

putAsync

GridFuture<V> putAsync(K key,
                     V val,
                     @Nullable
                     GridCacheEntryEx<K,V> cached,
                     long ttl,
                     GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key.

val - Value.

cached - Optional cached cache entry.

ttl - Time to live for entry. If negative, leave unchanged.

filter - Filter.

Returns:

Value future.

putxAsync

GridFuture<Boolean> putxAsync(K key,
                            V val,
                            GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key.

val - Value.

filter - Filter.

Returns:

Value future.

putxAsync

GridFuture<Boolean> putxAsync(K key,
                            V val,
                            @Nullable
                            GridCacheEntryEx<K,V> cached,
                            long ttl,
                            GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key.

val - Value.

cached - Optional cached cache entry.

ttl - Time to live for entry. If negative, leave unchanged.

filter - Filter.

Returns:

Value future.

putxAsync0

GridFuture<GridCacheReturn<V>> putxAsync0(K key,
                                        V val,
                                        @Nullable
                                        GridCacheEntryEx<K,V> cached,
                                        long ttl,
                                        GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key.

val - Value.

cached - Optional cached cache entry.

ttl - Time to live for entry. If negative, leave unchanged.

filter - Filter.

Returns:

Value future.

transformAsync

GridFuture<Boolean> transformAsync(K key,
                                 GridClosure<V,V> transformer,
                                 @Nullable
                                 GridCacheEntryEx<K,V> cached,
                                 long ttl)

Parameters:

key - Key.

transformer - Value transform closure.

cached - Cached entry, if called from entry wrapper.

ttl - Entry time-to-live value. If negative, leave unchanged.

Returns:

Transform operation future.

remove

V remove(K key,
       @Nullable
       GridCacheEntryEx<K,V> cached,
       GridPredicate<GridCacheEntry<K,V>>[] filter)
         throws GridException

Parameters:

key - Key.

cached - Cached entry, if any.

filter - Filter.

Returns:

Value.

Throws:

GridException - If remove failed.

removex

boolean removex(K key,
              @Nullable
              GridCacheEntryEx<K,V> cached,
              GridPredicate<GridCacheEntry<K,V>>[] filter)
                throws GridException

Parameters:

key - Key.

cached - Cached entry, if any.

filter - Filter.

Returns:

Value.

Throws:

GridException - If remove failed.

removeAll

GridCacheReturn<V> removeAll(Collection<? extends K> keys,
                           GridPredicate<GridCacheEntry<K,V>>[] filter)
                             throws GridException

Parameters:

keys - Keys to remove.

filter - Filter.

Returns:

Value of first removed key.

Throws:

GridException - If remove failed.

removeAsync

GridFuture<V> removeAsync(K key,
                        @Nullable
                        GridCacheEntryEx<K,V> cached,
                        GridPredicate<GridCacheEntry<K,V>>[] filter)

Asynchronous remove.

Parameters:

key - Key to remove.

cached - Cached entry, if any.

filter - Filter.

Returns:

Removed value.

removexAsync

GridFuture<Boolean> removexAsync(K key,
                               @Nullable
                               GridCacheEntryEx<K,V> cached,
                               GridPredicate<GridCacheEntry<K,V>>[] filter)

Asynchronous remove.

Parameters:

key - Key to remove.

cached - Cached entry, if any.

filter - Filter.

Returns:

Removed value.

removexAsync0

GridFuture<GridCacheReturn<V>> removexAsync0(K key,
                                           @Nullable
                                           GridCacheEntryEx<K,V> cached,
                                           GridPredicate<GridCacheEntry<K,V>>[] filter)

Asynchronous remove.

Parameters:

key - Key to remove.

cached - Optional cached entry.

filter - Filter.

Returns:

Removed value.

removeAllDr

void removeAllDr(Map<? extends K,GridCacheVersion> drMap)
                 throws GridException

Parameters:

drMap - DR map.

Throws:

GridException - If remove failed.

removeAllDrAsync

GridFuture<?> removeAllDrAsync(Map<? extends K,GridCacheVersion> drMap)

Parameters:

drMap - DR map.

Returns:

Future for asynchronous remove.

putAllAsync

GridFuture<GridCacheReturn<V>> putAllAsync(Map<? extends K,? extends V> map,
                                         boolean retval,
                                         @Nullable
                                         GridCacheEntryEx<K,V> cached,
                                         long ttl,
                                         GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

map - Map to put.

retval - Flag indicating whether a value should be returned.

cached - Cached entry, if any. Will be provided only if map has size 1.

filter - Filter.

ttl - Time to live for entry. If negative, leave unchanged.

Returns:

Future all the put operation which will return value as if put(Object, Object, GridCacheEntryEx, long, GridPredicate[]) was called.

transformAllAsync

GridFuture<?> transformAllAsync(@Nullable
                              Map<? extends K,? extends GridClosure<V,V>> map)

Parameters:

map - Map to put.

Returns:

Transform operation future.

removeAllAsync

GridFuture<GridCacheReturn<V>> removeAllAsync(Collection<? extends K> keys,
                                            @Nullable
                                            GridCacheEntryEx<K,V> cached,
                                            boolean implicit,
                                            boolean retval,
                                            GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

keys - Keys to remove.

retval - Flag indicating whether a value should be returned.

cached - Cached entry, if any. Will be provided only if size of keys collection is 1.

implicit - Allows to externally control how transaction handles implicit flags.

filter - Filter.

Returns:

Future for asynchronous remove.

groupLockAsync

GridFuture<?> groupLockAsync(Collection<K> keys)

Performs keys locking for affinity-based group lock transactions.

Parameters:

keys - Keys to lock.

Returns:

Lock future.

partitionLock

boolean partitionLock()

Returns:

True if keys from the same partition are allowed to be enlisted in group-lock transaction.

finish

boolean finish(boolean commit)
               throws GridException

Finishes transaction (either commit or rollback).

Parameters:

commit - True if commit, false if rollback.

Returns:

True if state has been changed.

Throws:

GridException - If finish failed.

loadMissing

GridFuture<Boolean> loadMissing(boolean async,
                              Collection<? extends K> keys,
                              GridBiInClosure<K,V> c)

Parameters:

async - if True, then loading will happen in a separate thread.

keys - Keys.

c - Closure.

Returns:

Future with True value if loading took place.