public interface Ignite extends AutoCloseable
Grid
through Ignition.ignite()
,
or for named grids you can use Ignition.ignite(String)
. Note that you
can have multiple instances of Grid
running in the same VM by giving
each instance a different name.
Note that Grid
extends ClusterGroup
which means that it provides grid projection
functionality over the whole grid (instead of a subgroup of nodes).
In addition to ClusterGroup
functionality, from here you can get the following:
GridCache
- functionality for in-memory distributed cache.IgniteDataStreamer
- functionality for loading data large amounts of data into cache.IgniteFileSystem
- functionality for distributed Hadoop-compliant in-memory file system and map-reduce.IgniteStreamer
- functionality for streaming events workflow with queries and indexes into rolling windows.IgniteScheduler
- functionality for scheduling jobs using UNIX Cron syntax.IgniteCompute
- functionality for executing tasks and closures on all grid nodes (inherited form ClusterGroup
).IgniteMessaging
- functionality for topic-based message exchange on all grid nodes (inherited form ClusterGroup
).IgniteEvents
- functionality for querying and listening to events on all grid nodes (inherited form ClusterGroup
).Modifier and Type | Method and Description |
---|---|
<K> CacheAffinity<K> |
affinity(String cacheName)
Gets affinity service to provide information about data partitioning
and distribution.
|
IgniteAtomicLong |
atomicLong(String name,
long initVal,
boolean create)
Will get a atomic long from cache and create one if it has not been created yet and
create flag
is true . |
<T> IgniteAtomicReference<T> |
atomicReference(String name,
T initVal,
boolean create)
Will get a atomic reference from cache and create one if it has not been created yet and
create flag
is true . |
IgniteAtomicSequence |
atomicSequence(String name,
long initVal,
boolean create)
Will get an atomic sequence from cache and create one if it has not been created yet and
create flag
is true . |
<T,S> IgniteAtomicStamped<T,S> |
atomicStamped(String name,
T initVal,
S initStamp,
boolean create)
Will get a atomic stamped from cache and create one if it has not been created yet and
create flag
is true . |
void |
close()
Closes
this instance of grid. |
IgniteCluster |
cluster()
Gets an instance of
IgniteCluster interface. |
IgniteCompute |
compute()
Gets
compute functionality over this grid projection. |
IgniteCompute |
compute(ClusterGroup grp) |
IgniteConfiguration |
configuration()
Gets the configuration of this grid instance.
|
IgniteCountDownLatch |
countDownLatch(String name,
int cnt,
boolean autoDel,
boolean create)
Gets or creates count down latch.
|
<K,V> IgniteDataStreamer<K,V> |
dataStreamer(String cacheName)
Gets a new instance of data streamer associated with given cache name.
|
IgniteEvents |
events()
Gets
events functionality over this grid projection. |
IgniteEvents |
events(ClusterGroup grp) |
ExecutorService |
executorService()
Creates new
ExecutorService which will execute all submitted
Callable and Runnable jobs on nodes in this grid projection. |
ExecutorService |
executorService(ClusterGroup grp) |
IgniteFileSystem |
fileSystem(String name)
Gets an instance of IGFS (Ignite In-Memory File System).
|
Collection<IgniteFileSystem> |
fileSystems()
Gets all instances of IGFS (Ignite In-Memory File System).
|
<K,V> IgniteCache<K,V> |
jcache(String name)
Gets an instance of
IgniteCache API. |
IgniteLogger |
log()
Gets grid's logger.
|
IgniteMessaging |
message()
Gets
messaging functionality over this grid projection. |
IgniteMessaging |
message(ClusterGroup grp) |
String |
name()
Gets the name of the grid this grid instance (and correspondingly its local node) belongs to.
|
<T extends IgnitePlugin> |
plugin(String name)
Gets an instance of deployed Ignite plugin.
|
<T> IgniteQueue<T> |
queue(String name,
int cap,
CollectionConfiguration cfg)
Will get a named queue from cache and create one if it has not been created yet and
cfg is not
null . |
IgniteScheduler |
scheduler()
Gets an instance of cron-based scheduler.
|
IgniteServices |
services()
Gets
services functionality over this grid projection. |
IgniteServices |
services(ClusterGroup grp) |
<T> IgniteSet<T> |
set(String name,
CollectionConfiguration cfg)
Will get a named set from cache and create one if it has not been created yet and
cfg is not
null . |
IgniteStreamer |
streamer(String name)
Gets an instance of streamer by name, if one does not exist then
IllegalArgumentException will be thrown. |
Collection<IgniteStreamer> |
streamers()
Gets all instances of streamers.
|
IgniteTransactions |
transactions()
Gets grid transactions facade.
|
IgniteProductVersion |
version()
Gets Ignite version.
|
String name()
If default grid instance is used, then
null
is returned. Refer to Ignition
documentation
for information on how to start named grids.
null
for default grid.IgniteLogger log()
IgniteConfiguration configuration()
NOTE:
SPIs obtains through this method should never be used directly. SPIs provide
internal view on the subsystem and is used internally by Ignite kernal. In rare use cases when
access to a specific implementation of this SPI is required - an instance of this SPI can be obtained
via this method to check its configuration properties or call other non-SPI
methods.
IgniteCluster cluster()
IgniteCluster
interface.IgniteCluster
interface.IgniteCompute compute()
compute
functionality over this grid projection. All operations
on the returned IgniteCompute
instance will only include nodes from
this projection.IgniteCompute compute(ClusterGroup grp)
grp
- Cluster group..IgniteMessaging message()
messaging
functionality over this grid projection. All operations
on the returned IgniteMessaging
instance will only include nodes from
this projection.IgniteMessaging message(ClusterGroup grp)
grp
- Cluster group.IgniteEvents events()
events
functionality over this grid projection. All operations
on the returned IgniteEvents
instance will only include nodes from
this projection.IgniteEvents events(ClusterGroup grp)
grp
- Cluster group.IgniteServices services()
services
functionality over this grid projection. All operations
on the returned IgniteMessaging
instance will only include nodes from
this projection.IgniteServices services(ClusterGroup grp)
grp
- Cluster group.Services
functionality over given cluster group.ExecutorService executorService()
ExecutorService
which will execute all submitted
Callable
and Runnable
jobs on nodes in this grid projection.
This essentially
creates a Distributed Thread Pool that can be used as a
replacement for local thread pools.ExecutorService
.ExecutorService executorService(ClusterGroup grp)
grp
- Cluster group.ExecutorService
which will execute jobs on nodes in given cluster group.IgniteProductVersion version()
IgniteScheduler scheduler()
<K,V> IgniteCache<K,V> jcache(@Nullable String name)
IgniteCache
API. IgniteCache
is a fully-compatible
implementation of JCache (JSR 107)
specification.name
- Cache name.IgniteTransactions transactions()
<K,V> IgniteDataStreamer<K,V> dataStreamer(@Nullable String cacheName)
IgniteDataStreamer
documentation.cacheName
- Cache name (null
for default cache).IgniteFileSystem fileSystem(String name)
IllegalArgumentException
will be thrown.
IGFS is fully compliant with Hadoop FileSystem
APIs and can
be plugged into Hadoop installations. For more information refer to
documentation on Hadoop integration shipped with Ignite.
name
- IGFS name.IllegalArgumentException
- If IGFS with such name is not configured.Collection<IgniteFileSystem> fileSystems()
IgniteStreamer streamer(@Nullable String name)
IllegalArgumentException
will be thrown.name
- Streamer name.Collection<IgniteStreamer> streamers()
IgniteAtomicSequence atomicSequence(String name, long initVal, boolean create) throws IgniteException
create
flag
is true
.name
- Sequence name.initVal
- Initial value for sequence. Ignored if create
flag is false
.create
- Boolean flag indicating whether data structure should be created if does not exist.IgniteException
- If sequence could not be fetched or created.IgniteAtomicLong atomicLong(String name, long initVal, boolean create) throws IgniteException
create
flag
is true
.name
- Name of atomic long.initVal
- Initial value for atomic long. Ignored if create
flag is false
.create
- Boolean flag indicating whether data structure should be created if does not exist.IgniteException
- If atomic long could not be fetched or created.<T> IgniteAtomicReference<T> atomicReference(String name, @Nullable T initVal, boolean create) throws IgniteException
create
flag
is true
.name
- Atomic reference name.initVal
- Initial value for atomic reference. Ignored if create
flag is false
.create
- Boolean flag indicating whether data structure should be created if does not exist.IgniteException
- If atomic reference could not be fetched or created.<T,S> IgniteAtomicStamped<T,S> atomicStamped(String name, @Nullable T initVal, @Nullable S initStamp, boolean create) throws IgniteException
create
flag
is true
.name
- Atomic stamped name.initVal
- Initial value for atomic stamped. Ignored if create
flag is false
.initStamp
- Initial stamp for atomic stamped. Ignored if create
flag is false
.create
- Boolean flag indicating whether data structure should be created if does not exist.IgniteException
- If atomic stamped could not be fetched or created.IgniteCountDownLatch countDownLatch(String name, int cnt, boolean autoDel, boolean create) throws IgniteException
create
flag
is true
, it is created using provided name and count parameter.name
- Name of the latch.cnt
- Count for new latch creation. Ignored if create
flag is false
.autoDel
- True
to automatically delete latch from cache when its count reaches zero.
Ignored if create
flag is false
.create
- Boolean flag indicating whether data structure should be created if does not exist.IgniteException
- If latch could not be fetched or created.<T> IgniteQueue<T> queue(String name, int cap, @Nullable CollectionConfiguration cfg) throws IgniteException
cfg
is not
null
.
If queue is present already, queue properties will not be changed. Use
collocation for CacheMode.PARTITIONED
caches if you have lots of relatively
small queues as it will make fetching, querying, and iteration a lot faster. If you have
few very large queues, then you should consider turning off collocation as they simply
may not fit in a single node's memory.name
- Name of queue.cap
- Capacity of queue, 0
for unbounded queue. Ignored if cfg
is null
.cfg
- Queue configuration if new queue should be created.IgniteException
- If queue could not be fetched or created.<T> IgniteSet<T> set(String name, @Nullable CollectionConfiguration cfg) throws IgniteException
cfg
is not
null
.name
- Set name.cfg
- Set configuration if new set should be created.IgniteException
- If set could not be fetched or created.<T extends IgnitePlugin> T plugin(String name) throws PluginNotFoundException
T
- Plugin type.name
- Plugin name.PluginNotFoundException
- If plugin for the given name was not found.void close() throws IgniteException
this
instance of grid. This method is identical to calling
G.stop(gridName, true)
.
The method is invoked automatically on objects managed by the
try-with-resources
statement.
close
in interface AutoCloseable
IgniteException
- If failed to stop grid.<K> CacheAffinity<K> affinity(String cacheName)
K
- Cache key type.cacheName
- Cache name.
Follow @ApacheIgnite
Apache Ignite Fabric : ver. 1.0.0-RC3 Release Date : March 24 2015