org.gridgain.grid.kernal.processors.cache.distributed.near

Class GridNearCacheAdapter<K,V>

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.kernal.processors.cache.GridCacheAdapter<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheAdapter<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.near.GridNearCacheAdapter<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Iterable<GridCacheEntry<K,V>>, GridCache<K,V>, GridCacheProjection<K,V>, GridMetadataAware, GridCacheProjectionEx<K,V>

Direct Known Subclasses:

GridNearAtomicCache, GridNearTransactionalCache

public abstract class GridNearCacheAdapter<K,V>
extends GridDistributedCacheAdapter<K,V>

Common logic for near caches.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

GridCacheAdapter.AsyncOp<T>, GridCacheAdapter.FutureHolder

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

afterPessimisticUnlock, beforePessimisticLock, cacheCfg, CLEAR_ALL_SPLIT_THRESHOLD, ctx, gridCfg, lastFut, locNodeId, log, map, metrics

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridNearCacheAdapter() Empty constructor required for Externalizable.
protected	GridNearCacheAdapter(GridCacheContext<K,V> ctx)

Method Summary

Methods

Modifier and Type	Method and Description
GridInClosure3<K,Boolean,GridCacheOperation>	afterPessimisticUnlock()
void	afterPessimisticUnlock(GridInClosure3<K,Boolean,GridCacheOperation> afterPessimisticUnlock) Sets callback that will be invoked after keys are unlocked.
GridBiClosure<Collection<K>,Boolean,GridFuture<Object>>	beforePessimisticLock()
void	beforePessimisticLock(GridBiClosure<Collection<K>,Boolean,GridFuture<Object>> beforePessimisticLock) Sets callback that will be invoked before keys are locked.
boolean	clear0(K key, GridPredicate<GridCacheEntry<K,V>>[] filter)
void	clearAll0(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	compact(K key, GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	containsKey(K key, GridPredicate<GridCacheEntry<K,V>> filter)
abstract GridDhtCacheAdapter<K,V>	dht()
protected int	drBackupQueueSize()
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.
GridCacheEntry<K,V>	entry(K key) Gets entry from cache with the specified key.
GridCacheEntryEx<K,V>	entryEx(K key, boolean touch)
GridCacheEntryEx<K,V>	entryEx(K key, long topVer)
GridNearCacheEntry<K,V>	entryExx(K key, long topVer)
Set<GridCacheEntry<K,V>>	entrySet(GridPredicate<GridCacheEntry<K,V>>... filter)
Set<GridCacheEntry<K,V>>	entrySet(int part) Gets set containing cache entries that belong to provided partition or null if partition not found locally.
boolean	evict(K key, GridPredicate<GridCacheEntry<K,V>>[] filter)
void	evictAll(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>[] filter)
boolean	evictNearOnly(K key, GridPredicate<GridCacheEntry<K,V>>[] filter)
long	ggfsDataSpaceMax() Get maximum space available for GGFS.
long	ggfsDataSpaceUsed() Get current amount of used GGFS space in bytes.
protected void	init() Post constructor initialization for subclasses.
boolean	isAllLockedNearOnly(Iterable<? extends K> keys)
boolean	isGgfsDataCache() Checks whether this cache is GGFS data cache.
boolean	isLocked(K key) Checks if any node owns a lock for this key.
boolean	isLockedNearOnly(K key)
boolean	isMongoDataCache() Checks whether this cache is Mongo data cache.
boolean	isMongoMetaCache() Checks whether this cache is Mongo meta cache.
boolean	isNear()
Set<K>	keySet(GridPredicate<GridCacheEntry<K,V>>[] filter)
GridFuture<Map<K,V>>	loadAsync(GridCacheTxEx tx, Collection<? extends K> keys, boolean reload, boolean forcePrimary, GridPredicate<GridCacheEntry<K,V>>[] filter, UUID subjId)
void	loadCache(GridBiPredicate<K,V> p, long ttl, Object[] args) Delegates to GridCacheStore.loadCache(GridBiInClosure,Object...) method to load state from the underlying persistent storage.
GridFuture<?>	loadCacheAsync(GridBiPredicate<K,V> p, long ttl, Object[] args) Asynchronously delegates to GridCacheStore.loadCache(GridBiInClosure, Object...) method to reload state from the underlying persistent storage.
Set<GridCacheEntry<K,V>>	nearEntries()
Set<K>	nearKeySet(GridPredicate<GridCacheEntry<K,V>> filter)
int	nearSize() Gets size of near cache key set.
long	offHeapAllocatedSize() Gets memory size allocated in off-heap.
long	offHeapEntriesCount() Gets number of cache entries stored in off-heap memory.
Iterator<Map.Entry<K,V>>	offHeapIterator() Gets iterator over keys and values belonging to this cache off-heap memory on local node.
void	onGgfsDataSizeChanged(long delta) Callback invoked when data is added to GGFS cache.
V	peek(K key, Collection<GridCachePeekMode> modes) Peeks at cached value using optional set of peek modes.
V	peek(K key, GridPredicate<GridCacheEntry<K,V>> filter)
Map<K,V>	peekAll(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>... filter)
GridNearCacheEntry<K,V>	peekExx(K key)
V	peekNearOnly(K key) Peeks only near cache without looking into DHT cache.
GridCachePreloader<K,V>	preloader()
Set<GridCacheEntry<K,V>>	primaryEntrySet(GridPredicate<GridCacheEntry<K,V>>... filter)
Set<K>	primaryKeySet(GridPredicate<GridCacheEntry<K,V>>... filter)
int	primarySize() Gets size of all primary keys for this cache.
Collection<V>	primaryValues(GridPredicate<GridCacheEntry<K,V>>... filter)
protected void	processGetResponse(UUID nodeId, GridNearGetResponse<K,V> res)
V	promote(K key) This method promotes cache entry from offheap by given key, if any, from offheap or swap storage into memory.
void	promoteAll(Collection<? extends K> keys) This method unswaps cache entries by given keys, if any, from swap storage into memory.
GridFuture<Object>	readThroughAllAsync(Collection<? extends K> keys, boolean reload, GridCacheTxEx<K,V> tx, GridPredicate<GridCacheEntry<K,V>>[] filter, UUID subjId, GridBiInClosure<K,V> vis)
V	reload(K key, GridPredicate<GridCacheEntry<K,V>>... filter)
void	reloadAll() Reloads all currently cached keys form persistent storage.
void	reloadAll(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>... filter)
GridFuture<?>	reloadAllAsync() Asynchronously reloads all specified entries from underlying persistent storage.
GridFuture<?>	reloadAllAsync(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>... filter)
GridFuture<?>	reloadAllAsync(GridPredicate<GridCacheEntry<K,V>> filter)
void	resetMetrics() Resets metrics for current cache.
int	size() Gets size of cache key set.
List<GridCacheClearAllRunnable<K,V>>	splitClearAll() Split clear all task into multiple runnables.
Iterator<Map.Entry<K,V>>	swapIterator() Gets iterator over keys and values belonging to this cache swap space on local node.
long	swapKeys() Gets number of swap entries (keys).
long	swapSize() Gets size in bytes for swap space.
String	toString()
Collection<V>	values(GridPredicate<GridCacheEntry<K,V>>... filter)

Methods inherited from class org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheAdapter

lockAllAsync, lockAllAsync, removeVersionedEntry, txLockAsync

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

affinity, allEntries, asyncOp, asyncOpAcquire, asyncOpRelease, cache, checkJta, clear, clearAll, clearAll, compact, compactAll, compactAll, configuration, containsAllKeys, containsAllValues, containsAnyKeys, containsAnyValues, containsKey, containsValue, containsValue, context, dataStructures, dgc, dgc, entries, entryEx, entryExSafe, entrySet, entrySet, entrySetx, evict, evictAll, evictAll, flags, flagsOff, flagsOn, forAll, forceRepartition, forEach, forSubjectId, get, get, get, getAll, getAll, getAllAsync, getAllAsync, getAllAsync, getAllAsync, getAllOutTx, getAllOutTxAsync, getAsync, getAsync, getForcePrimary, getForcePrimaryAsync, globalClearAll, gridProjection, isColocated, isDht, isDhtAtomic, isDrSystemCache, isEmpty, isLocal, isLockedByThread, iterator, keySet, lock, lockAll, lockAsync, log, map, metrics, metrics0, name, newTx, onDeferredDelete, onKernalStart, onKernalStop, onUndeploy, overflowSize, peek, peek0, peek0, peek0, peekAll0, peekAll0, peekEx, predicate, primaryEntrySet, primaryKeySet, primaryValues, printMemoryStats, processCheckCommittedTxRequest, processCheckCommittedTxResponse, processCheckPreparedTxRequest, processCheckPreparedTxResponse, projection, projection, projection, put, put, putAll, putAllAsync, putAllDr, putAllDrAsync, putAsync, putAsync, putIfAbsent, putIfAbsentAsync, putx, putx, putxAsync, putxAsync, putxIfAbsent, putxIfAbsentAsync, queries, randomEntry, readExternal, readResolve, reload, reloadAll, reloadAll, reloadAll, reloadAllAsync, reloadAllAsync, reloadAsync, reloadAsync, remove, remove, remove, removeAll, removeAll, removeAllAsync, removeAllAsync, removeAllDr, removeAllDrAsync, removeAsync, removeAsync, removeAsync, removeEntry, removeIfObsolete, removex, removex, removex, removexAsync, removexAsync, removexAsync, replace, replace, replaceAsync, replaceAsync, replacex, replacex, replacexAsync, replacexAsync, saveFuture, start, startInfo, stop, stopInfo, toMap, transform, transformAll, transformAll, transformAllAsync, transformAllAsync, transformAndCompute, transformAsync, transformAsync, tx, txStart, txStart, txStart, txStartAffinity, txStartPartition, txSynchronizations, txSynchronize, txUnsynchronize, unlock, values, wrappers, writeExternal

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

unlockAll

Methods inherited from interface org.gridgain.grid.GridMetadataAware

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

Constructor Detail

GridNearCacheAdapter

protected GridNearCacheAdapter()

Empty constructor required for Externalizable.

GridNearCacheAdapter

protected GridNearCacheAdapter(GridCacheContext<K,V> ctx)

Parameters:

ctx - Context.

Method Detail

init

protected void init()

Post constructor initialization for subclasses.

Overrides:

init in class GridCacheAdapter<K,V>

dht

public abstract GridDhtCacheAdapter<K,V> dht()

Returns:

DHT cache.

isNear

public boolean isNear()

Overrides:

isNear in class GridCacheAdapter<K,V>

Returns:

True if this is near cache.

beforePessimisticLock

public void beforePessimisticLock(GridBiClosure<Collection<K>,Boolean,GridFuture<Object>> beforePessimisticLock)

Sets callback that will be invoked before keys are locked. This callback may return future, in this case further locking process will be completed after this future completes.

Overrides:

beforePessimisticLock in class GridCacheAdapter<K,V>

Parameters:

beforePessimisticLock - Before lock callback.

beforePessimisticLock

public GridBiClosure<Collection<K>,Boolean,GridFuture<Object>> beforePessimisticLock()

Overrides:

beforePessimisticLock in class GridCacheAdapter<K,V>

Returns:

Before pessimistic lock callback.

afterPessimisticUnlock

public void afterPessimisticUnlock(GridInClosure3<K,Boolean,GridCacheOperation> afterPessimisticUnlock)

Sets callback that will be invoked after keys are unlocked.

Overrides:

afterPessimisticUnlock in class GridCacheAdapter<K,V>

Parameters:

afterPessimisticUnlock - After unlock callback.

afterPessimisticUnlock

public GridInClosure3<K,Boolean,GridCacheOperation> afterPessimisticUnlock()

Overrides:

afterPessimisticUnlock in class GridCacheAdapter<K,V>

Returns:

After pessimistic unlock request.

preloader

public GridCachePreloader<K,V> preloader()

Specified by:

preloader in class GridCacheAdapter<K,V>

Returns:

Preloader.

entryEx

public GridCacheEntryEx<K,V> entryEx(K key,
                            boolean touch)

Overrides:

entryEx in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

touch - Whether created entry should be touched.

Returns:

Entry (never null).

entryEx

public GridCacheEntryEx<K,V> entryEx(K key,
                            long topVer)

Overrides:

entryEx in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

topVer - Topology version.

Returns:

Entry (never null).

entryExx

public GridNearCacheEntry<K,V> entryExx(K key,
                               long topVer)

Parameters:

key - Key.

topVer - Topology version.

Returns:

Entry.

peekExx

@Nullable
public GridNearCacheEntry<K,V> peekExx(K key)

Parameters:

key - Key.

Returns:

Entry.

isLocked

public boolean isLocked(K key)

Checks if any node owns a lock for this key.

This is a local in-VM operation and does not involve any network trips or access to persistent storage in any way.

Specified by:

isLocked in interface GridCacheProjection<K,V>

Overrides:

isLocked in class GridCacheAdapter<K,V>

Parameters:

key - Key to check.

Returns:

True if lock is owned by some node.

isLockedNearOnly

public boolean isLockedNearOnly(K key)

Parameters:

key - Key.

Returns:

If near entry is locked.

isAllLockedNearOnly

public boolean isAllLockedNearOnly(Iterable<? extends K> keys)

Parameters:

keys - Keys.

Returns:

If near entries for given keys are locked.

readThroughAllAsync

public GridFuture<Object> readThroughAllAsync(Collection<? extends K> keys,
                                     boolean reload,
                                     GridCacheTxEx<K,V> tx,
                                     GridPredicate<GridCacheEntry<K,V>>[] filter,
                                     @Nullable
                                     UUID subjId,
                                     GridBiInClosure<K,V> vis)

Overrides:

readThroughAllAsync in class GridCacheAdapter<K,V>

Parameters:

keys - Keys.

reload - Reload flag.

tx - Transaction.

filter - Filter.

vis - Visitor.

Returns:

Future.

reloadAll

public void reloadAll(@Nullable
             Collection<? extends K> keys,
             @Nullable
             GridPredicate<GridCacheEntry<K,V>>... filter)
               throws GridException

Overrides:

reloadAll in class GridCacheAdapter<K,V>

Parameters:

keys - Keys.

filter - Filter to evaluate.

Throws:

GridException - If failed.

reloadAllAsync

public GridFuture<?> reloadAllAsync(@Nullable
                           Collection<? extends K> keys,
                           @Nullable
                           GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

reloadAllAsync in class GridCacheAdapter<K,V>

Parameters:

keys - Keys.

filter - Filter to evaluate.

Returns:

Reload future.

reload

public V reload(K key,
       @Nullable
       GridPredicate<GridCacheEntry<K,V>>... filter)
         throws GridException

Overrides:

reload in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filter to evaluate.

Returns:

Reloaded value.

Throws:

GridException - If failed.

reloadAll

public void reloadAll()
               throws GridException

Reloads all currently cached keys form persistent storage.

Transactions

This method does not participate in transactions, however it does not violate cache integrity and can be used safely with or without transactions.

Specified by:

reloadAll in interface GridCacheProjection<K,V>

Overrides:

reloadAll in class GridCacheAdapter<K,V>

Throws:

GridException - If reloading failed.

reloadAllAsync

public GridFuture<?> reloadAllAsync()

Asynchronously reloads all specified entries from underlying persistent storage.

Transactions

This method does not participate in transactions, however it does not violate cache integrity and can be used safely with or without transactions.

Specified by:

reloadAllAsync in interface GridCacheProjection<K,V>

Overrides:

reloadAllAsync in class GridCacheAdapter<K,V>

Returns:

Future which will complete whenever reload completes.

reloadAllAsync

public GridFuture<?> reloadAllAsync(@Nullable
                           GridPredicate<GridCacheEntry<K,V>> filter)

Overrides:

reloadAllAsync in class GridCacheAdapter<K,V>

Parameters:

filter - Filter to evaluate.

Returns:

Reload future.

loadAsync

public GridFuture<Map<K,V>> loadAsync(@Nullable
                             GridCacheTxEx tx,
                             @Nullable
                             Collection<? extends K> keys,
                             boolean reload,
                             boolean forcePrimary,
                             @Nullable
                             GridPredicate<GridCacheEntry<K,V>>[] filter,
                             @Nullable
                             UUID subjId)

Parameters:

tx - Transaction.

keys - Keys to load.

reload - Reload flag.

forcePrimary - Force primary flag.

filter - Filter.

Returns:

Loaded values.

loadCache

public void loadCache(GridBiPredicate<K,V> p,
             long ttl,
             Object[] args)
               throws GridException

Delegates to GridCacheStore.loadCache(GridBiInClosure,Object...) method to load state from the underlying persistent storage. The loaded values will then be given to the optionally passed in predicate, and, if the predicate returns true, will be stored in cache. If predicate is null, then all loaded values will be stored in cache.

Note that this method does not receive keys as a parameter, so it is up to GridCacheStore implementation to provide all the data to be loaded.

This method is not transactional and may end up loading a stale value into cache if another thread has updated the value immediately after it has been loaded. It is mostly useful when pre-loading the cache from underlying data store before start, or for read-only caches.

Specified by:

loadCache in interface GridCache<K,V>

Overrides:

loadCache in class GridCacheAdapter<K,V>

Parameters:

p - Optional predicate (may be null). If provided, will be used to filter values to be put into cache.

ttl - Time to live for loaded entries (0 for infinity).

args - Optional user arguments to be passed into GridCacheStore.loadCache(GridBiInClosure, Object...) method.

Throws:

GridException - If loading failed.

loadCacheAsync

public GridFuture<?> loadCacheAsync(GridBiPredicate<K,V> p,
                           long ttl,
                           Object[] args)

Asynchronously delegates to GridCacheStore.loadCache(GridBiInClosure, Object...) method to reload state from the underlying persistent storage. The reloaded values will then be given to the optionally passed in predicate, and if the predicate returns true, will be stored in cache. If predicate is null, then all reloaded values will be stored in cache.

Note that this method does not receive keys as a parameter, so it is up to GridCacheStore implementation to provide all the data to be loaded.

This method is not transactional and may end up loading a stale value into cache if another thread has updated the value immediately after it has been loaded. It is mostly useful when pre-loading the cache from underlying data store before start, or for read-only caches.

Specified by:

loadCacheAsync in interface GridCache<K,V>

Overrides:

loadCacheAsync in class GridCacheAdapter<K,V>

Parameters:

p - Optional predicate (may be null). If provided, will be used to filter values to be put into cache.

ttl - Time to live for loaded entries (0 for infinity).

args - Optional user arguments to be passed into GridCacheStore.loadCache(GridBiInClosure,Object...) method.

Returns:

Future to be completed whenever loading completes.

resetMetrics

public void resetMetrics()

Resets metrics for current cache.

Specified by:

resetMetrics in interface GridCache<K,V>

Overrides:

resetMetrics in class GridCacheAdapter<K,V>

drBackupQueueSize

protected int drBackupQueueSize()

Overrides:

drBackupQueueSize in class GridCacheAdapter<K,V>

Returns:

DR backup queue size.

processGetResponse

protected void processGetResponse(UUID nodeId,
                      GridNearGetResponse<K,V> res)

Parameters:

nodeId - Sender ID.

res - Response.

size

public int size()

Gets size of cache key set. This method will return the count of all cache entries and has O(1) complexity on base GridCache projection. It is essentially the size of cache key set and is semantically identical to {GridCache.keySet().size().

Specified by:

size in interface GridCacheProjection<K,V>

Overrides:

size in class GridCacheAdapter<K,V>

Returns:

Size of cache key set.

primarySize

public int primarySize()

Gets size of all primary keys for this cache. For GridCacheMode.LOCAL mode, this method is identical to GridCacheProjection.size().

For GridCacheMode.PARTITIONED and GridCacheMode.REPLICATED modes, this method will return number of primary entries in the cache (excluding any backups). The complexity of this method is O(P), where P is the total number of partitions.

Specified by:

primarySize in interface GridCacheProjection<K,V>

Overrides:

primarySize in class GridCacheAdapter<K,V>

Returns:

Number of primary entries in cache.

nearSize

public int nearSize()

Gets size of near cache key set. This method will return count of all entries in near cache including null values and has O(1) complexity on base cache projection.

Note that for LOCAL caches this method will always return 0

Specified by:

nearSize in interface GridCacheProjection<K,V>

Overrides:

nearSize in class GridCacheAdapter<K,V>

Returns:

Size of near cache key set or 0 if cache is not GridCacheMode.PARTITIONED.

nearEntries

public Set<GridCacheEntry<K,V>> nearEntries()

Returns:

Near entries.

entrySet

public Set<GridCacheEntry<K,V>> entrySet(@Nullable
                                GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

entrySet in class GridCacheAdapter<K,V>

Parameters:

filter - Filters to evaluate.

Returns:

Entry set.

entrySet

public Set<GridCacheEntry<K,V>> entrySet(int part)

Gets set containing cache entries that belong to provided partition or null if partition not found locally.

Specified by:

entrySet in interface GridCacheProjection<K,V>

Overrides:

entrySet in class GridCacheAdapter<K,V>

Parameters:

part - Partition.

Returns:

Set containing partition's entries or null if partition not found locally.

primaryEntrySet

public Set<GridCacheEntry<K,V>> primaryEntrySet(@Nullable
                                       GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

primaryEntrySet in class GridCacheAdapter<K,V>

Parameters:

filter - Filters to evaluate.

Returns:

Primary entry set.

keySet

public Set<K> keySet(@Nullable
            GridPredicate<GridCacheEntry<K,V>>[] filter)

Overrides:

keySet in class GridCacheAdapter<K,V>

Parameters:

filter - Filters to evaluate.

Returns:

Key set.

nearKeySet

public Set<K> nearKeySet(@Nullable
                GridPredicate<GridCacheEntry<K,V>> filter)

Parameters:

filter - Entry filter.

Returns:

Keys for near cache only.

primaryKeySet

public Set<K> primaryKeySet(@Nullable
                   GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

primaryKeySet in class GridCacheAdapter<K,V>

Parameters:

filter - Primary key set.

Returns:

Primary key set.

values

public Collection<V> values(GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

values in class GridCacheAdapter<K,V>

primaryValues

public Collection<V> primaryValues(@Nullable
                          GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

primaryValues in class GridCacheAdapter<K,V>

Parameters:

filter - Filters to evaluate.

Returns:

Primary values.

containsKey

public boolean containsKey(K key,
                  GridPredicate<GridCacheEntry<K,V>> filter)

Overrides:

containsKey in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filters to evaluate.

Returns:

True if contains key.

evict

public boolean evict(K key,
            @Nullable
            GridPredicate<GridCacheEntry<K,V>>[] filter)

Overrides:

evict in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filters to evaluate.

Returns:

True if evicted.

evictNearOnly

public boolean evictNearOnly(K key,
                    @Nullable
                    GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

key - Key to evict.

filter - Optional filter.

Returns:

True if evicted.

evictAll

public void evictAll(Collection<? extends K> keys,
            @Nullable
            GridPredicate<GridCacheEntry<K,V>>[] filter)

Overrides:

evictAll in class GridCacheAdapter<K,V>

Parameters:

keys - Keys.

filter - Filters to evaluate.

compact

public boolean compact(K key,
              @Nullable
              GridPredicate<GridCacheEntry<K,V>>[] filter)
                throws GridException

Overrides:

compact in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filters to evaluate.

Returns:

True if compacted.

Throws:

GridException - If failed.

entry

public GridCacheEntry<K,V> entry(K key)

Gets entry from cache with the specified key. The returned entry can be used even after entry key has been removed from cache. In that case, every operation on returned entry will result in creation of a new entry.

Note that this method can return null if projection is configured as pre-filtered and entry key and value don't pass key-value filter of the projection.

Specified by:

entry in interface GridCacheProjection<K,V>

Overrides:

entry in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

Returns:

Cache entry or null if projection pre-filtering was not passed.

peekNearOnly

@Nullable
public V peekNearOnly(K key)

Peeks only near cache without looking into DHT cache.

Parameters:

key - Key.

Returns:

Peeked value.

peek

public V peek(K key,
     @Nullable
     GridPredicate<GridCacheEntry<K,V>> filter)

Overrides:

peek in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filter to evaluate.

Returns:

Peeked value.

peek

public V peek(K key,
     @Nullable
     Collection<GridCachePeekMode> modes)
       throws GridException

Peeks at cached value using optional set of peek modes. This method will sequentially iterate over given peek modes in the order passed in, and try to peek at value using each peek mode. Once a non-null value is found, it will be immediately returned.

Note that if modes are not provided this method works exactly the same way as GridCacheProjection.peek(Object), implicitly using GridCachePeekMode.SMART mode.

Transactions

This method does not participate in any transactions, however, it may peek at transactional value depending on the peek modes used.

Specified by:

peek in interface GridCacheProjection<K,V>

Overrides:

peek in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

modes - Optional set of peek modes.

Returns:

Peeked value.

Throws:

GridException - If peek operation failed.

peekAll

public Map<K,V> peekAll(@Nullable
               Collection<? extends K> keys,
               @Nullable
               GridPredicate<GridCacheEntry<K,V>>... filter)

Overrides:

peekAll in class GridCacheAdapter<K,V>

clear0

public boolean clear0(K key,
             @Nullable
             GridPredicate<GridCacheEntry<K,V>>[] filter)

Overrides:

clear0 in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filters to evaluate.

Returns:

True if cleared.

clearAll0

public void clearAll0(Collection<? extends K> keys,
             @Nullable
             GridPredicate<GridCacheEntry<K,V>>[] filter)

Overrides:

clearAll0 in class GridCacheAdapter<K,V>

Parameters:

keys - Keys.

filter - Filters to evaluate.

promote

public V promote(K key)
          throws GridException

This method promotes cache entry from offheap by given key, if any, from offheap or swap storage into memory.

Transactions

This method is not transactional.

Cache Flags

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

Specified by:

promote in interface GridCacheProjection<K,V>

Overrides:

promote in class GridCacheAdapter<K,V>

Parameters:

key - Key to promote entry for.

Returns:

Unswapped entry value or null for non-existing key.

Throws:

GridException - If promote failed.

promoteAll

public void promoteAll(@Nullable
              Collection<? extends K> keys)
                throws GridException

This method unswaps cache entries by given keys, if any, from swap storage into memory.

Transactions

This method is not transactional.

Cache Flags

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

Specified by:

promoteAll in interface GridCacheProjection<K,V>

Overrides:

promoteAll in class GridCacheAdapter<K,V>

Parameters:

keys - Keys to promote entries for.

Throws:

GridException - If promote failed.

swapIterator

public Iterator<Map.Entry<K,V>> swapIterator()
                                      throws GridException

Gets iterator over keys and values belonging to this cache swap space on local node. This iterator is thread-safe, which means that cache (and therefore its swap space) may be modified concurrently with iteration over swap.

Returned iterator supports remove operation which delegates to GridCacheProjection.removex(Object, GridPredicate[]) method.

Cache Flags

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

Specified by:

swapIterator in interface GridCache<K,V>

Overrides:

swapIterator in class GridCacheAdapter<K,V>

Returns:

Iterator over keys.

Throws:

GridException - If failed.

See Also:

GridCacheProjection.promote(Object)

offHeapIterator

public Iterator<Map.Entry<K,V>> offHeapIterator()
                                         throws GridException

Gets iterator over keys and values belonging to this cache off-heap memory on local node. This iterator is thread-safe, which means that cache (and therefore its off-heap memory) may be modified concurrently with iteration over off-heap. To achieve better performance the keys and values deserialized on demand, whenever accessed.

Returned iterator supports remove operation which delegates to GridCacheProjection.removex(Object, GridPredicate[]) method.

Specified by:

offHeapIterator in interface GridCache<K,V>

Overrides:

offHeapIterator in class GridCacheAdapter<K,V>

Returns:

Iterator over keys.

Throws:

GridException - If failed.

offHeapEntriesCount

public long offHeapEntriesCount()

Gets number of cache entries stored in off-heap memory.

Specified by:

offHeapEntriesCount in interface GridCache<K,V>

Overrides:

offHeapEntriesCount in class GridCacheAdapter<K,V>

Returns:

Number of cache entries stored in off-heap memory.

offHeapAllocatedSize

public long offHeapAllocatedSize()

Gets memory size allocated in off-heap.

Specified by:

offHeapAllocatedSize in interface GridCache<K,V>

Overrides:

offHeapAllocatedSize in class GridCacheAdapter<K,V>

Returns:

Allocated memory size.

swapSize

public long swapSize()
              throws GridException

Gets size in bytes for swap space.

Specified by:

swapSize in interface GridCache<K,V>

Overrides:

swapSize in class GridCacheAdapter<K,V>

Returns:

Size in bytes.

Throws:

GridException - If failed.

swapKeys

public long swapKeys()
              throws GridException

Gets number of swap entries (keys).

Specified by:

swapKeys in interface GridCache<K,V>

Overrides:

swapKeys in class GridCacheAdapter<K,V>

Returns:

Number of entries stored in swap.

Throws:

GridException - If failed.

isGgfsDataCache

public boolean isGgfsDataCache()

Checks whether this cache is GGFS data cache.

Specified by:

isGgfsDataCache in interface GridCacheProjectionEx<K,V>

Overrides:

isGgfsDataCache in class GridCacheAdapter<K,V>

Returns:

True in case this cache is GGFS data cache.

ggfsDataSpaceUsed

public long ggfsDataSpaceUsed()

Get current amount of used GGFS space in bytes.

Specified by:

ggfsDataSpaceUsed in interface GridCacheProjectionEx<K,V>

Overrides:

ggfsDataSpaceUsed in class GridCacheAdapter<K,V>

Returns:

Amount of used GGFS space in bytes.

ggfsDataSpaceMax

public long ggfsDataSpaceMax()

Get maximum space available for GGFS.

Specified by:

ggfsDataSpaceMax in interface GridCacheProjectionEx<K,V>

Overrides:

ggfsDataSpaceMax in class GridCacheAdapter<K,V>

Returns:

Amount of space available for GGFS in bytes.

onGgfsDataSizeChanged

public void onGgfsDataSizeChanged(long delta)

Callback invoked when data is added to GGFS cache.

Overrides:

onGgfsDataSizeChanged in class GridCacheAdapter<K,V>

Parameters:

delta - Size delta.

isMongoDataCache

public boolean isMongoDataCache()

Checks whether this cache is Mongo data cache.

Specified by:

isMongoDataCache in interface GridCacheProjectionEx<K,V>

Overrides:

isMongoDataCache in class GridCacheAdapter<K,V>

Returns:

True if this cache is mongo data cache.

isMongoMetaCache

public boolean isMongoMetaCache()

Checks whether this cache is Mongo meta cache.

Specified by:

isMongoMetaCache in interface GridCacheProjectionEx<K,V>

Overrides:

isMongoMetaCache in class GridCacheAdapter<K,V>

Returns:

True if this cache is mongo meta cache.

splitClearAll

public List<GridCacheClearAllRunnable<K,V>> splitClearAll()

Split clear all task into multiple runnables.

Overrides:

splitClearAll in class GridCacheAdapter<K,V>

Returns:

Split runnables.

drStateTransfer

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

Starts full state transfer.

Specified by:

drStateTransfer in interface GridCacheProjectionEx<K,V>

Overrides:

drStateTransfer in class GridCacheAdapter<K,V>

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

public Collection<GridDrStateTransferDescriptor> drListStateTransfers()

List currently active state transfers.

Specified by:

drListStateTransfers in interface GridCacheProjectionEx<K,V>

Overrides:

drListStateTransfers in class GridCacheAdapter<K,V>

Returns:

Collection of currently active state transfers.

drPause

public void drPause()

Pauses data center replication for this cache.

Specified by:

drPause in interface GridCacheProjectionEx<K,V>

Overrides:

drPause in class GridCacheAdapter<K,V>

drResume

public void drResume()

Resumes data center replication for this cache.

Specified by:

drResume in interface GridCacheProjectionEx<K,V>

Overrides:

drResume in class GridCacheAdapter<K,V>

drPauseState

@Nullable
public GridDrStatus drPauseState()

Get DR pause state.

Specified by:

drPauseState in interface GridCacheProjectionEx<K,V>

Overrides:

drPauseState in class GridCacheAdapter<K,V>

Returns:

DR pause state.

toString

public String toString()

Overrides:

toString in class GridDistributedCacheAdapter<K,V>