org.gridgain.grid.kernal.processors.cache

Interface GridCacheProjectionEx<K,V>

All Superinterfaces:

GridCacheProjection<K,V>, GridMetadataAware, Iterable<GridCacheEntry<K,V>>, Serializable

All Known Subinterfaces:

GridCacheProxy<K,V>

All Known Implementing Classes:

GridCacheAdapter, GridCacheProjectionImpl, GridCacheProxyImpl, GridDhtAtomicCache, GridDhtCache, GridDhtCacheAdapter, GridDhtColocatedCache, GridDhtTransactionalCacheAdapter, GridDistributedCacheAdapter, GridLocalAtomicCache, GridLocalCache, GridNearAtomicCache, GridNearCacheAdapter, GridNearTransactionalCache

public interface GridCacheProjectionEx<K,V>
extends GridCacheProjection<K,V>

Internal projection interface.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<GridDrStateTransferDescriptor>	drListStateTransfers() List currently active state transfers.
void	drPause() Pauses data center replication for this cache.
GridDrStatus	drPauseState() Get DR pause state.
void	drResume() Resumes data center replication for this cache.
GridFuture<?>	drStateTransfer(Collection<Byte> dataCenterIds) Starts full state transfer.
Set<GridCacheEntry<K,V>>	entrySetx(GridPredicate<GridCacheEntry<K,V>>... filter) Gets entry set containing internal entries.
GridCacheProjectionEx<K,V>	forSubjectId(UUID subjId) Creates projection for specified subject ID.
V	get(K key, GridCacheEntryEx<K,V> entry, GridPredicate<GridCacheEntry<K,V>>... filter)
Map<K,V>	getAllOutTx(List<K> keys) Gets values from cache.
GridFuture<Map<K,V>>	getAllOutTxAsync(List<K> keys) Asynchronously gets values from cache.
V	getForcePrimary(K key) Gets value from cache.
GridFuture<V>	getForcePrimaryAsync(K key) Asynchronously gets value from cache.
long	ggfsDataSpaceMax() Get maximum space available for GGFS.
long	ggfsDataSpaceUsed() Get current amount of used GGFS space in bytes.
boolean	isDrSystemCache() Checks whether this cache is DR system cache.
boolean	isGgfsDataCache() Checks whether this cache is GGFS data cache.
boolean	isMongoDataCache() Checks whether this cache is Mongo data cache.
boolean	isMongoMetaCache() Checks whether this cache is Mongo meta cache.
GridPredicate<GridCacheEntry<K,V>>	predicate() Gets predicate on which this projection is based on or null if predicate is not defined.
V	put(K key, V val, GridCacheEntryEx<K,V> entry, long ttl, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
void	putAllDr(Map<? extends K,GridCacheDrInfo<V>> drMap) Store DR data.
GridFuture<?>	putAllDrAsync(Map<? extends K,GridCacheDrInfo<V>> drMap) Store DR data asynchronously.
GridFuture<V>	putAsync(K key, V val, GridCacheEntryEx<K,V> entry, long ttl, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
boolean	putx(K key, V val, GridCacheEntryEx<K,V> entry, long ttl, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
GridFuture<Boolean>	putxAsync(K key, V val, GridCacheEntryEx<K,V> entry, long ttl, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
V	remove(K key, GridCacheEntryEx<K,V> entry, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
void	removeAllDr(Map<? extends K,GridCacheVersion> drMap) Removes DR data.
GridFuture<?>	removeAllDrAsync(Map<? extends K,GridCacheVersion> drMap) Removes DR data asynchronously.
GridFuture<V>	removeAsync(K key, GridCacheEntryEx<K,V> entry, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
boolean	removex(K key, GridCacheEntryEx<K,V> entry, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
GridCacheReturn<V>	removex(K key, V val) Removes given key mapping from cache if one exists and value is equal to the passed in value.
GridFuture<Boolean>	removexAsync(K key, GridCacheEntryEx<K,V> entry, GridPredicate<GridCacheEntry<K,V>>... filter) Internal method that is called from GridCacheEntryImpl.
GridFuture<GridCacheReturn<V>>	removexAsync(K key, V val) Asynchronously removes given key mapping from cache if one exists and value is equal to the passed in value.
GridCacheReturn<V>	replacex(K key, V oldVal, V newVal) Stores given key-value pair in cache only if only if the previous value is equal to the 'oldVal' passed in.
GridFuture<GridCacheReturn<V>>	replacexAsync(K key, V oldVal, V newVal) Asynchronously stores given key-value pair in cache only if only if the previous value is equal to the 'oldVal' passed in.
GridFuture<?>	transformAsync(K key, GridClosure<V,V> transformer, GridCacheEntryEx<K,V> entry, long ttl) Internal method that is called from GridCacheEntryImpl.

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

cache, clear, clearAll, compact, compactAll, containsKey, containsValue, entry, entrySet, entrySet, evict, evictAll, evictAll, flags, flagsOff, flagsOn, forAll, forEach, get, getAll, getAllAsync, getAsync, globalClearAll, gridProjection, isEmpty, isLocked, isLockedByThread, keySet, lock, lockAll, lockAllAsync, lockAsync, name, nearSize, peek, peek, primaryEntrySet, primaryKeySet, primarySize, primaryValues, projection, projection, projection, promote, promoteAll, put, putAll, putAllAsync, putAsync, putIfAbsent, putIfAbsentAsync, putx, putxAsync, putxIfAbsent, putxIfAbsentAsync, queries, reload, reloadAll, reloadAll, reloadAllAsync, reloadAllAsync, reloadAsync, remove, remove, removeAll, removeAll, removeAllAsync, removeAllAsync, removeAsync, removeAsync, removex, removexAsync, replace, replace, replaceAsync, replaceAsync, replacex, replacexAsync, size, toMap, transform, transformAll, transformAll, transformAllAsync, transformAllAsync, transformAndCompute, transformAsync, tx, txStart, txStart, txStart, txStartAffinity, txStartPartition, unlock, unlockAll, values

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.gridgain.grid.GridMetadataAware

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

Method Detail

forSubjectId

GridCacheProjectionEx<K,V> forSubjectId(UUID subjId)

Creates projection for specified subject ID.

Parameters:

subjId - Client ID.

Returns:

Internal projection.

predicate

@Nullable
GridPredicate<GridCacheEntry<K,V>> predicate()

Gets predicate on which this projection is based on or null if predicate is not defined.

Returns:

Filter on which this projection is based on.

put

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

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key.

val - Value.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

ttl - Optional time-to-live. If negative, leaves ttl value unchanged.

filter - Optional filter.

Returns:

Previous value.

Throws:

GridException - If failed.

putAsync

GridFuture<V> putAsync(K key,
                     V val,
                     @Nullable
                     GridCacheEntryEx<K,V> entry,
                     long ttl,
                     @Nullable
                     GridPredicate<GridCacheEntry<K,V>>... filter)

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key.

val - Value.

entry - Optional cached entry.

ttl - Optional time-to-live value. If negative, leaves ttl value unchanged.

filter - Optional filter.

Returns:

Put operation future.

putx

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

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key.

val - Value.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

ttl - Optional time-to-live. If negative, leaves ttl value unchanged.

filter - Optional filter.

Returns:

Previous value.

Throws:

GridException - If failed.

putxAsync

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

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key.

val - Value.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

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

filter - Optional filter.

Returns:

Putx operation future.

putAllDr

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

Store DR data.

Parameters:

drMap - DR map.

Throws:

GridException - If put operation failed.

GridCacheFlagException - If projection flags validation failed.

putAllDrAsync

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

Store DR data asynchronously.

Parameters:

drMap - DR map.

Returns:

Future.

Throws:

GridException - If put operation failed.

GridCacheFlagException - If projection flags validation failed.

transformAsync

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

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key.

transformer - Transformer closure.

entry - Cached entry.

ttl - Optional time-to-lve.

Returns:

Transform operation future.

remove

@Nullable
V remove(K key,
                @Nullable
                GridCacheEntryEx<K,V> entry,
                @Nullable
                GridPredicate<GridCacheEntry<K,V>>... filter)
         throws GridException

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key to remove.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

filter - Optional filter.

Returns:

Previous value.

Throws:

GridException - If failed.

removeAsync

GridFuture<V> removeAsync(K key,
                        @Nullable
                        GridCacheEntryEx<K,V> entry,
                        @Nullable
                        GridPredicate<GridCacheEntry<K,V>>... filter)

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key to remove.

entry - Optional cached entry.

filter - Optional filter.

Returns:

Put operation future.

removeAllDr

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

Removes DR data.

Parameters:

drMap - DR map.

Throws:

GridException - If remove failed.

GridCacheFlagException - If projection flags validation failed.

removeAllDrAsync

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

Removes DR data asynchronously.

Parameters:

drMap - DR map.

Returns:

Future.

Throws:

GridException - If remove failed.

GridCacheFlagException - If projection flags validation failed.

removex

boolean removex(K key,
              @Nullable
              GridCacheEntryEx<K,V> entry,
              @Nullable
              GridPredicate<GridCacheEntry<K,V>>... filter)
                throws GridException

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key to remove.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

filter - Optional filter.

Returns:

Previous value.

Throws:

GridException - If failed.

removexAsync

GridFuture<Boolean> removexAsync(K key,
                               @Nullable
                               GridCacheEntryEx<K,V> entry,
                               @Nullable
                               GridPredicate<GridCacheEntry<K,V>>... filter)

Internal method that is called from GridCacheEntryImpl.

Parameters:

key - Key to remove.

entry - Cached entry. If not provided, equivalent to {GridCacheProjection#put}.

filter - Optional filter.

Returns:

Putx operation future.

replacexAsync

GridFuture<GridCacheReturn<V>> replacexAsync(K key,
                                           V oldVal,
                                           V newVal)

Asynchronously stores given key-value pair in cache only if only if the previous value is equal to the 'oldVal' passed in.

This method will return true if value is stored in cache and false otherwise.

If write-through is enabled, the stored value will be persisted to GridCacheStore via GridCacheStore.put(GridCacheTx, Object, Object) method.

Transactions

This method is transactional and will enlist the entry into ongoing transaction if there is one.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Parameters:

key - Key to store in cache.

oldVal - Old value to match.

newVal - Value to be associated with the given key.

Returns:

Future for the replace operation. The future will return object containing actual old value and success flag.

Throws:

NullPointerException - If either key or value are null.

GridCacheFlagException - If projection flags validation failed.

replacex

GridCacheReturn<V> replacex(K key,
                          V oldVal,
                          V newVal)
                            throws GridException

Stores given key-value pair in cache only if only if the previous value is equal to the 'oldVal' passed in.

This method will return true if value is stored in cache and false otherwise.

If write-through is enabled, the stored value will be persisted to GridCacheStore via GridCacheStore.put(GridCacheTx, Object, Object) method.

Transactions

This method is transactional and will enlist the entry into ongoing transaction if there is one.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Parameters:

key - Key to store in cache.

oldVal - Old value to match.

newVal - Value to be associated with the given key.

Returns:

Object containing actual old value and success flag.

Throws:

NullPointerException - If either key or value are null.

GridException - If replace operation failed.

GridCacheFlagException - If projection flags validation failed.

removex

GridCacheReturn<V> removex(K key,
                         V val)
                           throws GridException

Removes given key mapping from cache if one exists and value is equal to the passed in value.

If write-through is enabled, the value will be removed from GridCacheStore via GridCacheStore.remove(GridCacheTx, Object) method.

Transactions

This method is transactional and will enlist the entry into ongoing transaction if there is one.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Parameters:

key - Key whose mapping is to be removed from cache.

val - Value to match against currently cached value.

Returns:

Object containing actual old value and success flag.

Throws:

NullPointerException - if the key or value is null.

GridException - If remove failed.

GridCacheFlagException - If projection flags validation failed.

removexAsync

GridFuture<GridCacheReturn<V>> removexAsync(K key,
                                          V val)

Asynchronously removes given key mapping from cache if one exists and value is equal to the passed in value.

This method will return true if remove did occur, which means that all optionally provided filters have passed and there was something to remove, false otherwise.

If write-through is enabled, the value will be removed from GridCacheStore via GridCacheStore.remove(GridCacheTx, Object) method.

Transactions

This method is transactional and will enlist the entry into ongoing transaction if there is one.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Parameters:

key - Key whose mapping is to be removed from cache.

val - Value to match against currently cached value.

Returns:

Future for the remove operation. The future will return object containing actual old value and success flag.

Throws:

NullPointerException - if the key or value is null.

GridCacheFlagException - If projection flags validation failed.

get

@Nullable
V get(K key,
             @Nullable
             GridCacheEntryEx<K,V> entry,
             @Nullable
             GridPredicate<GridCacheEntry<K,V>>... filter)
      throws GridException

Parameters:

key - Key to retrieve the value for.

entry - Cached entry when called from entry wrapper.

filter - Filter to check prior to getting the value. Note that filter check together with getting the value is an atomic operation.

Returns:

Value.

Throws:

GridException - If failed.

getForcePrimary

@Nullable
V getForcePrimary(K key)
                  throws GridException

Gets value from cache. Will go to primary node even if this is a backup.

Parameters:

key - Key to get value for.

Returns:

Value.

Throws:

GridException - If failed.

getForcePrimaryAsync

GridFuture<V> getForcePrimaryAsync(K key)

Asynchronously gets value from cache. Will go to primary node even if this is a backup.

Parameters:

key - Key to get value for.

Returns:

Future with result.

getAllOutTx

@Nullable
Map<K,V> getAllOutTx(List<K> keys)
                     throws GridException

Gets values from cache. Will bypass started transaction, if any, i.e. will not enlist entries and will not lock any keys if pessimistic transaction is started by thread.

Parameters:

keys - Keys to get values for.

Returns:

Value.

Throws:

GridException - If failed.

getAllOutTxAsync

GridFuture<Map<K,V>> getAllOutTxAsync(List<K> keys)

Asynchronously gets values from cache. Will bypass started transaction, if any, i.e. will not enlist entries and will not lock any keys if pessimistic transaction is started by thread.

Parameters:

keys - Keys to get values for.

Returns:

Future with result.

isGgfsDataCache

boolean isGgfsDataCache()

Checks whether this cache is GGFS data cache.

Returns:

True in case this cache is GGFS data cache.

ggfsDataSpaceUsed

long ggfsDataSpaceUsed()

Get current amount of used GGFS space in bytes.

Returns:

Amount of used GGFS space in bytes.

ggfsDataSpaceMax

long ggfsDataSpaceMax()

Get maximum space available for GGFS.

Returns:

Amount of space available for GGFS in bytes.

isMongoDataCache

boolean isMongoDataCache()

Checks whether this cache is Mongo data cache.

Returns:

True if this cache is mongo data cache.

isMongoMetaCache

boolean isMongoMetaCache()

Checks whether this cache is Mongo meta cache.

Returns:

True if this cache is mongo meta cache.

isDrSystemCache

boolean isDrSystemCache()

Checks whether this cache is DR system cache.

Returns:

True if this cache is DR system cache.

drStateTransfer

GridFuture<?> drStateTransfer(Collection<Byte> dataCenterIds)

Starts full state transfer.

Parameters:

dataCenterIds - Data center IDs for which full state transfer was requested.

Returns:

Future that will be completed when all replication batches are sent.

drListStateTransfers

Collection<GridDrStateTransferDescriptor> drListStateTransfers()

List currently active state transfers.

Returns:

Collection of currently active state transfers.

drPause

void drPause()

Pauses data center replication for this cache.

drResume

void drResume()

Resumes data center replication for this cache.

drPauseState

@Nullable
GridDrStatus drPauseState()

Get DR pause state.

Returns:

DR pause state.

entrySetx

Set<GridCacheEntry<K,V>> entrySetx(GridPredicate<GridCacheEntry<K,V>>... filter)

Gets entry set containing internal entries.

Parameters:

filter - Filter.

Returns:

Entry set.