org.apache.ignite.internal

Interface IgniteEx

All Superinterfaces:

AutoCloseable, ClusterGroup, ClusterGroupEx, Ignite, IgniteAsyncSupport, IgniteCluster

All Known Implementing Classes:

IgniteKernal

public interface IgniteEx
extends Ignite, ClusterGroupEx, IgniteCluster

Extended Grid interface which provides some additional methods required for kernal and Visor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allEventsUserRecordable(int[] types) Checks whether all provided events are user-recordable.
Collection<GridCache<?,?>>	cachesx(IgnitePredicate<? super GridCache<?,?>>... p) Gets configured cache instance that satisfy all provided predicates including non-public caches.
<K,V> GridCache<K,V>	cachex() Gets default cache instance if one is configured or null otherwise returning even non-public caches.
<K,V> GridCache<K,V>	cachex(String name) Gets the cache instance for the given name if one is configured or null otherwise returning even non-public caches.
Collection<String>	compatibleVersions() Gets list of compatible versions.
boolean	eventUserRecordable(int type) Checks if the event type is user-recordable.
GridHadoop	hadoop() Get Hadoop facade.
IgniteFs	igfsx(String name) Get IGFS instance returning null if it doesn't exist.
boolean	isJmxRemoteEnabled() Whether or not remote JMX management is enabled for this node.
boolean	isRestartEnabled() Whether or not node restart is enabled.
String	latestVersion() Get latest version in string form.
<K extends GridCacheUtilityKey,V> GridCacheProjectionEx<K,V>	utilityCache(Class<K> keyCls, Class<V> valCls) Gets utility cache.

Methods inherited from interface org.apache.ignite.Ignite

affinity, atomicLong, atomicReference, atomicSequence, atomicStamped, close, cluster, compute, compute, configuration, countDownLatch, dataLoader, events, events, executorService, executorService, fileSystem, fileSystems, jcache, log, message, message, name, plugin, queue, scheduler, services, services, set, streamer, streamers, transactions, version

Methods inherited from interface org.apache.ignite.internal.ClusterGroupEx

forCacheNodes, forSubjectId

Methods inherited from interface org.apache.ignite.IgniteCluster

forLocal, localNode, mapKeysToNodes, mapKeyToNode, nodeLocalMap, pingNode, resetMetrics, restartNodes, restartNodes, startNodes, startNodes, stopNodes, stopNodes, topology, topologyVersion, withAsync

Methods inherited from interface org.apache.ignite.cluster.ClusterGroup

forAttribute, forCacheNodes, forClientNodes, forDaemons, forDataNodes, forHost, forNode, forNodeId, forNodeIds, forNodes, forOldest, forOthers, forOthers, forPredicate, forRandom, forRemotes, forStreamer, forYoungest, ignite, metrics, node, node, nodes, predicate

Methods inherited from interface org.apache.ignite.lang.IgniteAsyncSupport

future, isAsync

Method Detail

utilityCache

<K extends GridCacheUtilityKey,V> GridCacheProjectionEx<K,V> utilityCache(Class<K> keyCls,
                                                                        Class<V> valCls)

Gets utility cache.

Parameters:

keyCls - Key class.

valCls - Value class.

Returns:

Utility cache.

cachex

@Nullable
<K,V> GridCache<K,V> cachex(@Nullable
                                   String name)

Gets the cache instance for the given name if one is configured or null otherwise returning even non-public caches.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

name - Cache name.

Returns:

Cache instance for given name or null if one does not exist.

cachex

@Nullable
<K,V> GridCache<K,V> cachex()

Gets default cache instance if one is configured or null otherwise returning even non-public caches. The CacheProjection.name() method on default instance returns null.

Type Parameters:

K - Key type.

V - Value type.

Returns:

Default cache instance.

cachesx

Collection<GridCache<?,?>> cachesx(@Nullable
                                 IgnitePredicate<? super GridCache<?,?>>... p)

Gets configured cache instance that satisfy all provided predicates including non-public caches. If no predicates provided - all configured caches will be returned.

Parameters:

p - Predicates. If none provided - all configured caches will be returned.

Returns:

Configured cache instances that satisfy all provided predicates.

eventUserRecordable

boolean eventUserRecordable(int type)

Checks if the event type is user-recordable.

Parameters:

type - Event type to check.

Returns:

true if passed event should be recorded, false - otherwise.

allEventsUserRecordable

boolean allEventsUserRecordable(int[] types)

Checks whether all provided events are user-recordable.

Note that this method supports only predefined Ignite events.

Parameters:

types - Event types.

Returns:

Whether all events are recordable.

Throws:

IllegalArgumentException - If types contains user event type.

compatibleVersions

Collection<String> compatibleVersions()

Gets list of compatible versions.

Returns:

Compatible versions.

isJmxRemoteEnabled

boolean isJmxRemoteEnabled()

Whether or not remote JMX management is enabled for this node.

Returns:

True if remote JMX management is enabled - false otherwise.

isRestartEnabled

boolean isRestartEnabled()

Whether or not node restart is enabled.

Returns:

True if restart mode is enabled, false otherwise.

igfsx

@Nullable
IgniteFs igfsx(@Nullable
                      String name)

Get IGFS instance returning null if it doesn't exist.

Parameters:

name - IGFS name.

Returns:

IGFS.

hadoop

GridHadoop hadoop()

Get Hadoop facade.

Returns:

Hadoop.

latestVersion

@Nullable
String latestVersion()

Get latest version in string form.

Returns:

Latest version.