GridCacheUtils (gridgain-core 6.1.9 API)

java.lang.Object
- org.gridgain.grid.kernal.processors.cache.GridCacheUtils

Direct Known Subclasses:

CU
```
public class GridCacheUtils
extends Object
```
Cache utility methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DHT_ENABLED` Flag to turn off DHT cache for debugging purposes.
`static String`	`DR_SYS_CACHE_PREFIX` DR system cache name prefix.
`static String`	`SECURITY_SYS_CACHE_NAME` Security system cache name.

Constructor Summary

Constructors
Modifier Constructor and Description

protected GridCacheUtils()
Ensure singleton.

Constructors
Modifier	Constructor and Description
`protected`	`GridCacheUtils()` Ensure singleton.

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`affinityNode(GridCacheContext ctx, GridNode s)` Checks if given node has specified cache started and the local DHT storage is enabled.
`static Collection<GridNode>`	`affinityNodes(GridCacheContext ctx)` Gets all nodes on which cache with the same name is started and the local DHT storage is enabled.
`static Collection<GridNode>`	`affinityNodes(GridCacheContext ctx, long topOrder)` Gets DHT affinity nodes.
`static Collection<GridNode>`	`aliveNodes(GridCacheContext ctx, long topOrder)` Gets alive nodes.
`static Collection<GridNode>`	`aliveRemoteNodes(GridCacheContext ctx, long topOrder)` Gets alive nodes.
`static Collection<GridNode>`	`allNodes(GridCacheContext ctx)` Gets all nodes on which cache with the same name is started.
`static Collection<GridNode>`	`allNodes(GridCacheContext ctx, long topOrder)` Gets all nodes on which cache with the same name is started.
`static boolean`	`allowForStartup(Object msg)`
`static <K,V> GridPredicate<GridCacheEntry<K,V>>[]`	`alwaysFalse()`
`static Collection<GridNode>`	`backups(Collection<GridNode> nodes)`
`static GridReducer<Boolean,Boolean>`	`boolReducer()`
`static <K,V> GridClosure<K,GridCacheEntry<K,V>>`	`cacheKey2Entry(GridCacheContext<K,V> ctx)` Gets closure which returns `GridCacheEntry` given cache key.
`static String`	`cacheNameForDrSystemCache(String cacheName)`
`static String`	`cacheNameForSwapSpaceName(String swapSpaceName)`
`static boolean`	`cacheNode(GridCacheContext ctx, GridNode node)` Checks if given node contains configured cache with the name as described by given cache context.
`static boolean`	`cacheNode(GridCacheContext ctx, GridNodeShadow s)` Checks if given node has specified cache started.
`static boolean`	`cacheNode(String cacheName, GridCacheAttributes[] caches)` Checks if given attributes relate the the node which has (or had) specified cache started.
`static boolean`	`cacheNode(String cacheName, GridNode node)` Checks if given node has specified cache started.
`static void`	`checkAttributeMismatch(GridLogger log, GridCacheConfiguration locCfg, GridCacheConfiguration rmtCfg, GridNode rmt, T2<String,String> attr, boolean fail)` Checks that local and remove configurations have the same value of given attribute.
`static void`	`checkAttributeMismatch(GridLogger log, String cfgName, GridNode rmt, String attrName, String attrMsg, Object locVal, Object rmtVal, boolean fail)` Checks that cache configuration attribute has the same value in local and remote cache configurations.
`static void`	`checkStore(GridCacheContext<?,?> ctx)` Checks that cache store is present.
`static <T> GridReducer<Collection<T>,Collection<T>>`	`collectionsReducer()` Gets reducer that aggregates collections.
`static GridCacheDistributionMode`	`distributionMode(GridCacheConfiguration cfg)` Gets default partitioned cache mode.
`static <K,V> GridPredicate<GridCacheEntry<K,V>>[]`	`empty()`
`static <K,V> GridClosure<GridCacheEntryEx<K,V>,K>`	`entry2Key()`
`static GridInClosure<GridFuture<?>>`	`errorLogger(GridLogger log, Class<? extends Exception>... excl)`
`static <K,V> GridClosure<Integer,GridPredicate<GridCacheEntry<K,V>>[]>`	`factory()` Entry predicate factory mostly used for deserialization.
`static <T> T`	`failed(boolean err)`
`static <T> T`	`failed(boolean err, T val)`
`static <K,V> Collection<V>`	`getOrSet(ConcurrentMap<K,Collection<V>> mappings, K k)`
`static <K,V> Collection<V>`	`getOrSet(Map<K,List<V>> mappings, K k)`
`static <K,V> GridClosure<GridCacheEntryInfo<K,V>,K>`	`info2Key()`
`static <K,V> void`	`inTx(GridCacheProjection<K,V> cache, GridCacheTxConcurrency concurrency, GridCacheTxIsolation isolation, GridInClosureX<GridCacheProjection<K,V>> clo)` Execute closure inside cache transaction.
`static <K,V> boolean`	`invalidate(GridCacheProjection<K,V> cache, K key)` Invalidate entry in cache.
`static boolean`	`isAffinityNode(GridCacheConfiguration cfg)` Checks if node is affinity node for given cache configuration.
`static boolean`	`isDrSystemCache(String cacheName)`
`static boolean`	`isGgfsCache(GridConfiguration cfg, String cacheName)`
`static boolean`	`isLockTimeout(Throwable t)`
`static boolean`	`isLockTimeoutOrCancelled(Throwable t)`
`static boolean`	`isNearEnabled(GridCacheConfiguration cfg)` Checks if near cache is enabled for cache configuration.
`static boolean`	`isNearEnabled(GridCacheContext ctx)` Checks if near cache is enabled for cache context.
`static boolean`	`isSecuritySystemCache(String cacheName)`
`static <K,V> GridPredicate<K>`	`keyHasMeta(GridCacheContext<K,V> ctx, String meta)`
`static GridNode`	`localOrPrimary(Iterable<GridNode> nodes, UUID locId)`
`static <K> Map<GridNode,Collection<K>>`	`mapKeysToNodes(GridCacheContext<K,?> ctx, Collection<? extends K> keys)`
`static <K,V> GridReducer<Map<K,V>,Map<K,V>>`	`mapsReducer(int size)` Gets reducer that aggregates maps into one.
`static byte[]`	`marshal(GridCacheContext ctx, Object obj)`
`static String`	`mask(String cacheName)` Mask cache name in case it is null.
`static Comparator<GridNode>`	`nodeComparator(boolean asc)`
`static <K,V> GridPredicate<GridDhtLocalPartition<K,V>>`	`notEvicted()`
`static <T> GridReducer<T,Collection<T>>`	`objectsReducer()` Gets reducer that aggregates items into collection.
`static GridNode`	`oldest(GridCacheContext cctx)` Gets oldest alive node for specified topology version.
`static GridNode`	`oldest(GridCacheContext cctx, long topOrder)` Gets oldest alive node for specified topology version.
`static <T> T`	`outTx(Callable<T> cmd, GridCacheContext ctx)` Method executes any Callable out of scope of transaction.
`static <K,V> GridClosure<GridDhtLocalPartition<K,V>,GridDhtPartitionState>`	`part2state()`
`static GridCachePeekMode[]`	`peekFlags()`
`static GridNode`	`primary(Iterable<? extends GridNode> nodes)`
`static GridNode`	`primaryNode(GridCacheContext ctx, Object key)` Gets primary node on which given key is cached.
`static <K,V> GridPredicate<GridCacheTxEntry<K,V>>`	`reads()`
`static GridCacheVersion`	`readVersion(ObjectInput in)` Reads `GridCacheVersion` from input stream.
`static Collection<GridNode>`	`remoteNodes(GridCacheContext ctx)` Gets remote nodes on which cache with the same name is started.
`static Collection<GridNode>`	`remoteNodes(GridCacheContext ctx, long topOrder)` Gets remote nodes on which cache with the same name is started.
`static String`	`replicationTopicReceive(String cacheName)` Get topic to which replication responses are sent.
`static String`	`replicationTopicSend()` Get topic to which replication requests are sent.
`static void`	`resetTxContext(GridCacheContext ctx)`
`static <K,V> UUID`	`subjectId(GridCacheTxEx<K,V> tx, GridCacheContext<K,V> ctx)` Gets subject ID by transaction.
`static String`	`swapSpaceName(GridCacheContext<?,?> ctx)`
`static long`	`toExpireTime(long ttl)` Convert TTL to expire time.
`static <K,V> GridPredicate<GridCacheTxEntry<K,V>>`	`transferRequired()`
`static <K,V> GridClosure<GridCacheTxEntry<K,V>,GridCacheEntryEx<K,V>>`	`tx2entry()`
`static <K,V> GridClosure<GridCacheTxEntry<K,V>,K>`	`tx2key()`
`static <K,V> GridClosure<GridCacheTxEntry<K,V>,byte[]>`	`tx2keyBytes()`
`static GridClosure<GridCacheTx,GridUuid>`	`tx2xid()`
`static <K,V> GridClosure<GridCacheTxEx<K,V>,GridCacheVersion>`	`tx2xidVersion()`
`static <K,V> GridClosure<Collection<GridCacheTxEntry<K,V>>,Collection<K>>`	`txCol2Key()`
`static GridCacheTx`	`txStartInternal(GridCacheContext ctx, GridCacheProjection prj, GridCacheTxConcurrency concurrency, GridCacheTxIsolation isolation)`
`static String`	`txString(GridCacheTx tx)`
`static <K,V> GridBiPredicate<K,V>`	`typeFilter(Class<?> keyType, Class<?> valType)` Gets type filter for projections.
`static String`	`unmask(String cacheName)` Unmask cache name.
`static void`	`unwindEvicts(GridCacheContext ctx)`
`static String`	`uuid()` Gets per-thread-unique ID for this thread.
`static void`	`validateCacheKey(GridLogger log, Object key)` Validates that cache key object has overridden equals and hashCode methods and implements `Externalizable`.
`static void`	`validateCacheValue(GridLogger log, Object val)` Validates that cache value object implements `Externalizable`.
`static GridClosure<Integer,GridCacheVersion[]>`	`versionArrayFactory()`
`static byte[]`	`versionToBytes(GridCacheVersion ver)` Converts cache version to byte array.
`static void`	`writeMetrics(DataOutput out, GridCacheMetrics metrics)` Writes `GridCacheMetrics` to output stream.
`static <K,V> GridPredicate<GridCacheTxEntry<K,V>>`	`writes()`
`static void`	`writeVersion(ObjectOutput out, GridCacheVersion ver)` Writes `GridCacheVersion` to output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DR_SYS_CACHE_PREFIX
```
public static final String DR_SYS_CACHE_PREFIX
```
    DR system cache name prefix.
    
    See Also:
    Constant Field Values
  - SECURITY_SYS_CACHE_NAME
```
public static final String SECURITY_SYS_CACHE_NAME
```
    Security system cache name.
    
    See Also:
    Constant Field Values
  - DHT_ENABLED
```
public static final boolean DHT_ENABLED
```
    Flag to turn off DHT cache for debugging purposes.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - GridCacheUtils
```
protected GridCacheUtils()
```
    Ensure singleton.
- Method Detail
  - uuid
```
public static String uuid()
```
    Gets per-thread-unique ID for this thread.
    
    Returns:
    ID for this thread.
  - allowForStartup
```
public static boolean allowForStartup(Object msg)
```
    Parameters:
    msg - Message to check.
    
    Returns:
    True if preloader message.
  - writeVersion
```
public static void writeVersion(ObjectOutput out,
                GridCacheVersion ver)
                         throws IOException
```
    Writes GridCacheVersion to output stream. This method is meant to be used by implementations of Externalizable interface.
    
    Parameters:
    out - Output stream.
    ver - Version to write.
    
    Throws:
    
    IOException - If write failed.
  - readVersion
```
@Nullable
public static GridCacheVersion readVersion(ObjectInput in)
                                    throws IOException
```
    Reads GridCacheVersion from input stream. This method is meant to be used by implementations of Externalizable interface.
    
    Parameters:
    in - Input stream.
    
    Returns:
    Read version.
    
    Throws:
    
    IOException - If read failed.
  - writeMetrics
```
public static void writeMetrics(DataOutput out,
                GridCacheMetrics metrics)
                         throws IOException
```
    Writes GridCacheMetrics to output stream. This method is meant to be used by implementations of Externalizable interface.
    
    Parameters:
    out - Output stream.
    metrics - Metrics to write.
    
    Throws:
    
    IOException - If write failed.
  - keyHasMeta
```
public static <K,V> GridPredicate<K> keyHasMeta(GridCacheContext<K,V> ctx,
                                String meta)
```
    Type Parameters:
    K - Key type.
    V - Value type.
    Parameters:
    ctx - Cache context.
    meta - Meta name.
    
    Returns:
    Filter for entries with meta.
  - failed
```
@Nullable
public static <T> T failed(boolean err)
                throws GridCacheFilterFailedException
```
    Type Parameters:
    T - Return type.
    Parameters:
    err - If true, then throw GridCacheFilterFailedException, otherwise return val passed in.
    
    Returns:
    Always return null.
    
    Throws:
    
    GridCacheFilterFailedException - If err flag is true.
  - failed
```
@Nullable
public static <T> T failed(boolean err,
                    T val)
                throws GridCacheFilterFailedException
```
    Type Parameters:
    T - Return type.
    Parameters:
    err - If true, then throw GridCacheFilterFailedException, otherwise return val passed in.
    val - Value for which evaluation happened.
    
    Returns:
    Always return val passed in or throw exception.
    
    Throws:
    
    GridCacheFilterFailedException - If err flag is true.
  - factory
```
public static <K,V> GridClosure<Integer,GridPredicate<GridCacheEntry<K,V>>[]> factory()
```
    Entry predicate factory mostly used for deserialization.
    
    Type Parameters:
    K - Key type.
    V - Value type.
    
    Returns:
    Factory instance.
  - checkStore
```
public static void checkStore(GridCacheContext<?,?> ctx)
                       throws GridException
```
    Checks that cache store is present.
    
    Parameters:
    ctx - Registry.
    
    Throws:
    
    GridException - If cache store is not present.
  - swapSpaceName
```
public static String swapSpaceName(GridCacheContext<?,?> ctx)
```
    Parameters:
    ctx - Cache registry.
    
    Returns:
    Space name.
  - cacheNameForSwapSpaceName
```
public static String cacheNameForSwapSpaceName(String swapSpaceName)
```
    Parameters:
    swapSpaceName - Swap space name.
    
    Returns:
    Cache name.
  - cacheKey2Entry
```
public static <K,V> GridClosure<K,GridCacheEntry<K,V>> cacheKey2Entry(GridCacheContext<K,V> ctx)
```
    Gets closure which returns GridCacheEntry given cache key. If current cache is DHT and key doesn't belong to current partition, null is returned.
    
    Type Parameters:
    K - Cache key type.
    V - Cache value type.
    Parameters:
    ctx - Cache context.
    
    Returns:
    Closure which returns GridCacheEntry given cache key or null if partition is invalid.
  - part2state
```
public static <K,V> GridClosure<GridDhtLocalPartition<K,V>,GridDhtPartitionState> part2state()
```
    Returns:
    Partition to state transformer.
  - notEvicted
```
public static <K,V> GridPredicate<GridDhtLocalPartition<K,V>> notEvicted()
```
    Returns:
    Not evicted partitions.
  - allNodes
```
public static Collection<GridNode> allNodes(GridCacheContext ctx)
```
    Gets all nodes on which cache with the same name is started.
    
    Parameters:
    ctx - Cache context.
    
    Returns:
    All nodes on which cache with the same name is started (including nodes that may have already left).
  - allNodes
```
public static Collection<GridNode> allNodes(GridCacheContext ctx,
                            long topOrder)
```
    Gets all nodes on which cache with the same name is started.
    
    Parameters:
    ctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    All nodes on which cache with the same name is started (including nodes that may have already left).
  - aliveNodes
```
public static Collection<GridNode> aliveNodes(GridCacheContext ctx,
                              long topOrder)
```
    Gets alive nodes.
    
    Parameters:
    ctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    Affinity nodes.
  - remoteNodes
```
public static Collection<GridNode> remoteNodes(GridCacheContext ctx)
```
    Gets remote nodes on which cache with the same name is started.
    
    Parameters:
    ctx - Cache context.
    
    Returns:
    Remote nodes on which cache with the same name is started.
  - remoteNodes
```
public static Collection<GridNode> remoteNodes(GridCacheContext ctx,
                               long topOrder)
```
    Gets remote nodes on which cache with the same name is started.
    
    Parameters:
    ctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    Remote nodes on which cache with the same name is started.
  - aliveRemoteNodes
```
public static Collection<GridNode> aliveRemoteNodes(GridCacheContext ctx,
                                    long topOrder)
```
    Gets alive nodes.
    
    Parameters:
    ctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    Affinity nodes.
  - affinityNodes
```
public static Collection<GridNode> affinityNodes(GridCacheContext ctx)
```
    Gets all nodes on which cache with the same name is started and the local DHT storage is enabled.
    
    Parameters:
    ctx - Cache context.
    
    Returns:
    All nodes on which cache with the same name is started.
  - isAffinityNode
```
public static boolean isAffinityNode(GridCacheConfiguration cfg)
```
    Checks if node is affinity node for given cache configuration.
    
    Parameters:
    cfg - Configuration to check.
    
    Returns:
    True if local node is affinity node (i.e. will store partitions).
  - affinityNodes
```
public static Collection<GridNode> affinityNodes(GridCacheContext ctx,
                                 long topOrder)
```
    Gets DHT affinity nodes.
    
    Parameters:
    ctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    Affinity nodes.
  - affinityNode
```
public static boolean affinityNode(GridCacheContext ctx,
                   GridNode s)
```
    Checks if given node has specified cache started and the local DHT storage is enabled.
    
    Parameters:
    ctx - Cache context.
    s - Node shadow to check.
    
    Returns:
    True if given node has specified cache started.
  - cacheNode
```
public static boolean cacheNode(GridCacheContext ctx,
                GridNode node)
```
    Checks if given node contains configured cache with the name as described by given cache context.
    
    Parameters:
    ctx - Cache context.
    node - Node to check.
    
    Returns:
    true if node contains required cache.
  - isNearEnabled
```
public static boolean isNearEnabled(GridCacheContext ctx)
```
    Checks if near cache is enabled for cache context.
    
    Parameters:
    ctx - Cache context to check.
    
    Returns:
    True if near cache is enabled, false otherwise.
  - isNearEnabled
```
public static boolean isNearEnabled(GridCacheConfiguration cfg)
```
    Checks if near cache is enabled for cache configuration.
    
    Parameters:
    cfg - Cache configuration to check.
    
    Returns:
    True if near cache is enabled, false otherwise.
  - distributionMode
```
public static GridCacheDistributionMode distributionMode(GridCacheConfiguration cfg)
```
    Gets default partitioned cache mode.
    
    Parameters:
    cfg - Configuration.
    
    Returns:
    Partitioned cache mode.
  - cacheNode
```
public static boolean cacheNode(GridCacheContext ctx,
                GridNodeShadow s)
```
    Checks if given node has specified cache started.
    
    Parameters:
    ctx - Cache context.
    s - Node shadow to check.
    
    Returns:
    True if given node has specified cache started.
  - cacheNode
```
public static boolean cacheNode(String cacheName,
                GridNode node)
```
    Checks if given node has specified cache started.
    
    Parameters:
    cacheName - Cache name.
    node - Node to check.
    
    Returns:
    True if given node has specified cache started.
  - cacheNode
```
public static boolean cacheNode(String cacheName,
                GridCacheAttributes[] caches)
```
    Checks if given attributes relate the the node which has (or had) specified cache started.
    
    Parameters:
    cacheName - Cache name.
    caches - Node cache attributes.
    
    Returns:
    True if given node has specified cache started.
  - oldest
```
public static GridNode oldest(GridCacheContext cctx)
```
    Gets oldest alive node for specified topology version.
    
    Parameters:
    cctx - Cache context.
    
    Returns:
    Oldest node for the given topology version.
  - oldest
```
public static GridNode oldest(GridCacheContext cctx,
              long topOrder)
```
    Gets oldest alive node for specified topology version.
    
    Parameters:
    cctx - Cache context.
    topOrder - Maximum allowed node order.
    
    Returns:
    Oldest node for the given topology version.
  - empty
```
public static <K,V> GridPredicate<GridCacheEntry<K,V>>[] empty()
```
    Returns:
    Empty filter.
  - alwaysFalse
```
public static <K,V> GridPredicate<GridCacheEntry<K,V>>[] alwaysFalse()
```
    Returns:
    Always false filter.
  - tx2key
```
public static <K,V> GridClosure<GridCacheTxEntry<K,V>,K> tx2key()
```
    Returns:
    Closure that converts tx entry to key.
  - txCol2Key
```
public static <K,V> GridClosure<Collection<GridCacheTxEntry<K,V>>,Collection<K>> txCol2Key()
```
    Returns:
    Closure that converts tx entry collection to key collection.
  - tx2keyBytes
```
public static <K,V> GridClosure<GridCacheTxEntry<K,V>,byte[]> tx2keyBytes()
```
    Returns:
    Closure that converts tx entry to key.
  - tx2entry
```
public static <K,V> GridClosure<GridCacheTxEntry<K,V>,GridCacheEntryEx<K,V>> tx2entry()
```
    Returns:
    Converts transaction entry to cache entry.
  - tx2xidVersion
```
public static <K,V> GridClosure<GridCacheTxEx<K,V>,GridCacheVersion> tx2xidVersion()
```
    Returns:
    Closure which converts transaction entry xid to XID version.
  - tx2xid
```
public static GridClosure<GridCacheTx,GridUuid> tx2xid()
```
    Returns:
    Closure which converts transaction to xid.
  - entry2Key
```
public static <K,V> GridClosure<GridCacheEntryEx<K,V>,K> entry2Key()
```
    Returns:
    Closure that converts entry to key.
  - info2Key
```
public static <K,V> GridClosure<GridCacheEntryInfo<K,V>,K> info2Key()
```
    Returns:
    Closure that converts entry info to key.
  - reads
```
public static <K,V> GridPredicate<GridCacheTxEntry<K,V>> reads()
```
    Returns:
    Filter for transaction reads.
  - writes
```
public static <K,V> GridPredicate<GridCacheTxEntry<K,V>> writes()
```
    Returns:
    Filter for transaction writes.
  - transferRequired
```
public static <K,V> GridPredicate<GridCacheTxEntry<K,V>> transferRequired()
```
    Returns:
    Transfer required predicate.
  - typeFilter
```
public static <K,V> GridBiPredicate<K,V> typeFilter(Class<?> keyType,
                                    Class<?> valType)
```
    Gets type filter for projections.
    
    Type Parameters:
    K - Key type.
    V - Value type.
    Parameters:
    keyType - Key type.
    valType - Value type.
    
    Returns:
    Type filter.
  - boolReducer
```
public static GridReducer<Boolean,Boolean> boolReducer()
```
    Returns:
    Boolean reducer.
  - mapsReducer
```
public static <K,V> GridReducer<Map<K,V>,Map<K,V>> mapsReducer(int size)
```
    Gets reducer that aggregates maps into one.
    
    Type Parameters:
    K - Key type.
    V - Value type.
    Parameters:
    size - Predicted size of the resulting map to avoid resizings.
    
    Returns:
    Reducer.
  - collectionsReducer
```
public static <T> GridReducer<Collection<T>,Collection<T>> collectionsReducer()
```
    Gets reducer that aggregates collections.
    
    Type Parameters:
    T - Collection element type.
    
    Returns:
    Reducer.
  - objectsReducer
```
public static <T> GridReducer<T,Collection<T>> objectsReducer()
```
    Gets reducer that aggregates items into collection.
    
    Type Parameters:
    T - Items type.
    
    Returns:
    Reducer.
  - primary
```
public static GridNode primary(Iterable<? extends GridNode> nodes)
```
    Parameters:
    nodes - Set of nodes.
    
    Returns:
    Primary node.
  - localOrPrimary
```
public static GridNode localOrPrimary(Iterable<GridNode> nodes,
                      UUID locId)
```
    Parameters:
    nodes - Nodes.
    locId - Local node ID.
    
    Returns:
    Local node if it is in the list of nodes, or primary node.
  - backups
```
public static Collection<GridNode> backups(Collection<GridNode> nodes)
```
    Parameters:
    nodes - Nodes.
    
    Returns:
    Backup nodes.
  - getOrSet
```
public static <K,V> Collection<V> getOrSet(Map<K,List<V>> mappings,
                           K k)
```
    Parameters:
    mappings - Mappings.
    k - map key.
    
    Returns:
    Either current list value or newly created one.
  - getOrSet
```
public static <K,V> Collection<V> getOrSet(ConcurrentMap<K,Collection<V>> mappings,
                           K k)
```
    Parameters:
    mappings - Mappings.
    k - map key.
    
    Returns:
    Either current list value or newly created one.
  - peekFlags
```
public static GridCachePeekMode[] peekFlags()
```
    Returns:
    Peek flags.
  - errorLogger
```
public static GridInClosure<GridFuture<?>> errorLogger(GridLogger log,
                                       Class<? extends Exception>... excl)
```
    Parameters:
    log - Logger.
    excl - Excludes.
    
    Returns:
    Future listener that logs errors.
  - mapKeysToNodes
```
public static <K> Map<GridNode,Collection<K>> mapKeysToNodes(GridCacheContext<K,?> ctx,
                                             Collection<? extends K> keys)
```
    Parameters:
    ctx - Context.
    keys - Keys.
    
    Returns:
    Mapped keys.
  - isLockTimeout
```
public static boolean isLockTimeout(Throwable t)
```
    Parameters:
    t - Exception to check.
    
    Returns:
    true if caused by lock timeout.
  - isLockTimeoutOrCancelled
```
public static boolean isLockTimeoutOrCancelled(Throwable t)
```
    Parameters:
    t - Exception to check.
    
    Returns:
    true if caused by lock timeout or cancellation.
  - marshal
```
public static byte[] marshal(GridCacheContext ctx,
             Object obj)
                      throws GridException
```
    Parameters:
    ctx - Cache context.
    obj - Object to marshal.
    
    Returns:
    Buffer that contains obtained byte array.
    
    Throws:
    
    GridException - If marshalling failed.
  - outTx
```
public static <T> T outTx(Callable<T> cmd,
          GridCacheContext ctx)
               throws GridException
```
    Method executes any Callable out of scope of transaction. If transaction started by this thread cmd will be executed in another thread.
    
    Parameters:
    cmd - Callable.
    ctx - Cache context.
    
    Returns:
    T Callable result.
    
    Throws:
    
    GridException - If execution failed.
  - txStartInternal
```
public static GridCacheTx txStartInternal(GridCacheContext ctx,
                          GridCacheProjection prj,
                          GridCacheTxConcurrency concurrency,
                          GridCacheTxIsolation isolation)
```
    Parameters:
    ctx - Context.
    prj - Projection.
    concurrency - Concurrency.
    isolation - Isolation.
    
    Returns:
    New transaction.
  - txString
```
public static String txString(@Nullable
              GridCacheTx tx)
```
    Parameters:
    tx - Transaction.
    
    Returns:
    String view of all safe-to-print transaction properties.
  - resetTxContext
```
public static void resetTxContext(GridCacheContext ctx)
```
    Parameters:
    ctx - Cache context.
  - unwindEvicts
```
public static void unwindEvicts(GridCacheContext ctx)
```
    Parameters:
    ctx - Cache context.
  - primaryNode
```
public static GridNode primaryNode(GridCacheContext ctx,
                   Object key)
```
    Gets primary node on which given key is cached.
    
    Parameters:
    ctx - Cache.
    key - Key to find primary node for.
    
    Returns:
    Primary node for the key.
  - nodeComparator
```
public static Comparator<GridNode> nodeComparator(boolean asc)
```
    Parameters:
    asc - True for ascending.
    
    Returns:
    Descending order comparator.
  - versionArrayFactory
```
public static GridClosure<Integer,GridCacheVersion[]> versionArrayFactory()
```
    Returns:
    Version array factory.
  - versionToBytes
```
public static byte[] versionToBytes(GridCacheVersion ver)
```
    Converts cache version to byte array.
    
    Parameters:
    ver - Version.
    
    Returns:
    Byte array.
  - mask
```
public static String mask(String cacheName)
```
    Mask cache name in case it is null.
    
    Parameters:
    cacheName - Cache name.
    
    Returns:
    The same cache name or <default> in case the name is null.
  - unmask
```
@Nullable
public static String unmask(String cacheName)
```
    Unmask cache name.
    
    Parameters:
    cacheName - Cache name.
    
    Returns:
    Unmasked cache name, i.e. in case provided parameter was <default> then null will be returned.
  - replicationTopicSend
```
public static String replicationTopicSend()
```
    Get topic to which replication requests are sent.
    
    Returns:
    Topic to which replication requests are sent.
  - replicationTopicReceive
```
public static String replicationTopicReceive(String cacheName)
```
    Get topic to which replication responses are sent.
    
    Parameters:
    cacheName - Cache name.
    
    Returns:
    Topic to which replication responses are sent.
  - checkAttributeMismatch
```
public static void checkAttributeMismatch(GridLogger log,
                          GridCacheConfiguration locCfg,
                          GridCacheConfiguration rmtCfg,
                          GridNode rmt,
                          T2<String,String> attr,
                          boolean fail)
                                   throws GridException
```
    Checks that local and remove configurations have the same value of given attribute.
    
    Parameters:
    log - Logger used to log warning message (used only if fail flag is not set).
    locCfg - Local configuration.
    rmtCfg - Remote configuration.
    rmt - Remote node.
    attr - Attribute name.
    fail - If true throws GridException in case of attribute values mismatch, otherwise logs warning.
    
    Throws:
    
    GridException - If attribute values are different and fail flag is true.
  - checkAttributeMismatch
```
public static void checkAttributeMismatch(GridLogger log,
                          String cfgName,
                          GridNode rmt,
                          String attrName,
                          String attrMsg,
                          @Nullable
                          Object locVal,
                          @Nullable
                          Object rmtVal,
                          boolean fail)
                                   throws GridException
```
    Checks that cache configuration attribute has the same value in local and remote cache configurations.
    
    Parameters:
    log - Logger used to log warning message (used only if fail flag is not set).
    cfgName - Remote cache name.
    rmt - Remote node.
    attrName - Short attribute name for error message.
    attrMsg - Full attribute name for error message.
    locVal - Local value.
    rmtVal - Remote value.
    fail - If true throws GridException in case of attribute values mismatch, otherwise logs warning.
    
    Throws:
    
    GridException - If attribute values are different and fail flag is true.
  - validateCacheValue
```
public static void validateCacheValue(GridLogger log,
                      @Nullable
                      Object val)
```
    Validates that cache value object implements Externalizable.
    
    Parameters:
    log - Logger used to log warning message.
    val - Value.
  - validateCacheKey
```
public static void validateCacheKey(GridLogger log,
                    @Nullable
                    Object key)
```
    Validates that cache key object has overridden equals and hashCode methods and implements Externalizable.
    
    Parameters:
    log - Logger used to log warning message.
    key - Key.
    
    Throws:
    
    IllegalArgumentException - If equals or hashCode is not implemented.
  - cacheNameForDrSystemCache
```
public static String cacheNameForDrSystemCache(String cacheName)
```
    Parameters:
    cacheName - Cache name.
    
    Returns:
    Name of internal replicated cache used by data center replication component.
  - isDrSystemCache
```
public static boolean isDrSystemCache(String cacheName)
```
    Parameters:
    cacheName - Cache name.
    
    Returns:
    True if this is DR system cache.
  - isSecuritySystemCache
```
public static boolean isSecuritySystemCache(String cacheName)
```
    Parameters:
    cacheName - Cache name.
    
    Returns:
    True if this is security system cache.
  - isGgfsCache
```
public static boolean isGgfsCache(GridConfiguration cfg,
                  @Nullable
                  String cacheName)
```
    Parameters:
    cfg - Grid configuration.
    cacheName - Cache name.
    
    Returns:
    True in this is GGFS data or meta cache.
  - toExpireTime
```
public static long toExpireTime(long ttl)
```
    Convert TTL to expire time.
    
    Parameters:
    ttl - TTL.
    
    Returns:
    Expire time.
  - inTx
```
public static <K,V> void inTx(GridCacheProjection<K,V> cache,
              GridCacheTxConcurrency concurrency,
              GridCacheTxIsolation isolation,
              GridInClosureX<GridCacheProjection<K,V>> clo)
                 throws GridException
```
    Execute closure inside cache transaction.
    
    Parameters:
    cache - Cache.
    concurrency - Concurrency.
    isolation - Isolation.
    clo - Closure.
    
    Throws:
    
    GridException - If failed.
  - subjectId
```
public static <K,V> UUID subjectId(GridCacheTxEx<K,V> tx,
                   GridCacheContext<K,V> ctx)
```
    Gets subject ID by transaction.
    
    Parameters:
    tx - Transaction.
    
    Returns:
    Subject ID.
  - invalidate
```
public static <K,V> boolean invalidate(GridCacheProjection<K,V> cache,
                       K key)
```
    Invalidate entry in cache.
    
    Parameters:
    cache - Cache.
    key - Key.
    
    Returns:
    True if entry was invalidated.

Class GridCacheUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DR_SYS_CACHE_PREFIX

SECURITY_SYS_CACHE_NAME

DHT_ENABLED

Constructor Detail

GridCacheUtils

Method Detail

uuid

allowForStartup

writeVersion

readVersion

writeMetrics

keyHasMeta

failed

failed

factory

checkStore

swapSpaceName

cacheNameForSwapSpaceName

cacheKey2Entry

part2state

notEvicted

allNodes

allNodes

aliveNodes

remoteNodes

remoteNodes

aliveRemoteNodes

affinityNodes

isAffinityNode

affinityNodes

affinityNode

cacheNode

isNearEnabled

isNearEnabled

distributionMode

cacheNode

cacheNode

cacheNode

oldest

oldest

empty

alwaysFalse

tx2key

txCol2Key

tx2keyBytes

tx2entry

tx2xidVersion

tx2xid

entry2Key

info2Key

reads

writes

transferRequired

typeFilter

boolReducer

mapsReducer

collectionsReducer

objectsReducer

primary

localOrPrimary

backups

getOrSet

getOrSet

peekFlags

errorLogger

mapKeysToNodes

isLockTimeout

isLockTimeoutOrCancelled

marshal

outTx

txStartInternal

txString

resetTxContext

unwindEvicts