Class IgniteSpringBean
- java.lang.Object
- 
- org.apache.ignite.IgniteSpringBean
 
- 
- All Implemented Interfaces:
- Externalizable,- Serializable,- AutoCloseable,- Ignite,- org.springframework.beans.factory.Aware,- org.springframework.beans.factory.DisposableBean,- org.springframework.beans.factory.SmartInitializingSingleton,- org.springframework.context.ApplicationContextAware
 
 public class IgniteSpringBean extends Object implements Ignite, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, Externalizable Ignite Spring bean allows to bypassIgnitionmethods. In other words, this bean class allows to inject new grid instance from Spring configuration file directly without invoking staticIgnitionmethods. This class can be wired directly from Spring and can be referenced from within other Spring beans. By virtue of implementingDisposableBeanandSmartInitializingSingletoninterfaces,IgniteSpringBeanautomatically starts and stops underlying grid instance.A note should be taken that Ignite instance is started after all other Spring beans have been initialized and right before Spring context is refreshed. That implies that it's not valid to reference IgniteSpringBean from any kind of Spring bean init methods like PostConstruct. If it's required to reference IgniteSpringBean for other bean initialization purposes, it should be done from aContextRefreshedEventlistener method declared in that bean.Spring Configuration ExampleHere is a typical example of describing it in Spring file:<bean id="mySpringBean" class="org.apache.ignite.IgniteSpringBean"> <property name="configuration"> <bean id="grid.cfg" class="org.apache.ignite.configuration.IgniteConfiguration"> <property name="igniteInstanceName" value="mySpringGrid"/> </bean> </property> </bean>Or use default configuration:<bean id="mySpringBean" class="org.apache.ignite.IgniteSpringBean"/> Java ExampleHere is how you may access this bean from code:AbstractApplicationContext ctx = new FileSystemXmlApplicationContext("/path/to/spring/file"); // Register Spring hook to destroy bean automatically. ctx.registerShutdownHook(); Ignite ignite = (Ignite)ctx.getBean("mySpringBean");- See Also:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description IgniteSpringBean()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanactive()Checks Ignite grid is active or not active.voidactive(boolean active)Changes Ignite grid state to active or inactive.<K,V>
 voidaddCacheConfiguration(CacheConfiguration<K,V> cacheCfg)Adds cache configuration template.<K> Affinity<K>affinity(String cacheName)Gets affinity service to provide information about data partitioning and distribution.voidafterSingletonsInstantiated()@Nullable IgniteAtomicLongatomicLong(String name, long initVal, boolean create)Will get a atomic long from cache and create one if it has not been created yet andcreateflag istrue.IgniteAtomicLongatomicLong(String name, AtomicConfiguration cfg, long initVal, boolean create)Will get a atomic long from cache and create one if it has not been created yet andcreateflag istrue.<T> IgniteAtomicReference<T>atomicReference(String name, AtomicConfiguration cfg, T initVal, boolean create)Will get a atomic reference from cache and create one if it has not been created yet andcreateflag istrue.<T> @Nullable 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 andcreateflag istrue.@Nullable IgniteAtomicSequenceatomicSequence(String name, long initVal, boolean create)Will get an atomic sequence from cache and create one if it has not been created yet andcreateflag istrue.IgniteAtomicSequenceatomicSequence(String name, AtomicConfiguration cfg, long initVal, boolean create)Will get an atomic sequence from cache and create one if it has not been created yet andcreateflag istrue.<T,S>
 IgniteAtomicStamped<T,S>atomicStamped(String name, AtomicConfiguration cfg, T initVal, S initStamp, boolean create)Will get a atomic stamped from cache and create one if it has not been created yet andcreateflag istrue.<T,S>
 @Nullable 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 andcreateflag istrue.IgniteBinarybinary()Gets an instance ofIgniteBinaryinterface.<K,V>
 IgniteCache<K,V>cache(@Nullable String name)Gets an instance ofIgniteCacheAPI for the given name if one is configured ornullotherwise.Collection<String>cacheNames()Gets the collection of names of currently available caches.protected voidcheckIgnite()Checks if this bean is valid.voidclose()Closesthisinstance of grid.IgniteClustercluster()Gets an instance ofIgniteClusterinterface.IgniteComputecompute()Getscomputefacade over all cluster nodes started in server mode.IgniteComputecompute(ClusterGroup grp)Getscomputefacade over the specified cluster group.IgniteConfigurationconfiguration()Gets the configuration of this Ignite instance.@Nullable IgniteCountDownLatchcountDownLatch(String name, int cnt, boolean autoDel, boolean create)Gets or creates count down latch.<K,V>
 IgniteCache<K,V>createCache(String cacheName)Dynamically starts new cache using template configuration.<K,V>
 IgniteCache<K,V>createCache(CacheConfiguration<K,V> cacheCfg)Dynamically starts new cache with the given cache configuration.<K,V>
 IgniteCache<K,V>createCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg)Dynamically starts new cache with the given cache configuration.Collection<IgniteCache>createCaches(Collection<CacheConfiguration> cacheCfgs)Dynamically starts new caches with the given cache configurations.<K,V>
 IgniteCache<K,V>createNearCache(String cacheName, NearCacheConfiguration<K,V> nearCfg)Starts a near cache on local node if cache was previously started with one of theIgnite.createCache(CacheConfiguration)orIgnite.createCache(CacheConfiguration, NearCacheConfiguration)methods.Collection<DataRegionMetrics>dataRegionMetrics()Returns a collection ofDataRegionMetricsthat reflects page memory usage on this Apache Ignite node instance.@Nullable DataRegionMetricsdataRegionMetrics(String memPlcName)Returns the latestDataRegionMetricssnapshot for the memory region of the given name.<K,V>
 IgniteDataStreamer<K,V>dataStreamer(@Nullable String cacheName)Gets a new instance of data streamer associated with given cache name.voiddestroy()voiddestroyCache(String cacheName)Destroys a cache with the given name and cleans data that was written to the cache.voiddestroyCaches(Collection<String> cacheNames)Destroys caches with the given names and cleans data that was written to the caches.IgniteEncryptionencryption()Gets an instance ofIgniteEncryptioninterface.IgniteEventsevents()Getseventsfacade over all cluster nodes.IgniteEventsevents(ClusterGroup grp)Getseventsfacade over nodes within the cluster group.ExecutorServiceexecutorService()Creates a newExecutorServicewhich will execute all submittedCallableandRunnablejobs on all cluster nodes.ExecutorServiceexecutorService(ClusterGroup grp)Creates a newExecutorServicewhich will execute all submittedCallableandRunnablejobs on nodes in the specified cluster group.org.springframework.context.ApplicationContextgetApplicationContext()Gets the spring application context this Ignite runs in.IgniteConfigurationgetConfiguration()Gets the configuration of this Ignite instance.<K,V>
 IgniteCache<K,V>getOrCreateCache(String cacheName)Gets existing cache with the given name or creates new one using template configuration.<K,V>
 IgniteCache<K,V>getOrCreateCache(CacheConfiguration<K,V> cacheCfg)Gets existing cache with the given name or creates new one with the given configuration.<K,V>
 IgniteCache<K,V>getOrCreateCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg)Gets existing cache with the given cache configuration or creates one if it does not exist.Collection<IgniteCache>getOrCreateCaches(Collection<CacheConfiguration> cacheCfgs)Gets existing caches with the given name or created one with the given configuration.<K,V>
 IgniteCache<K,V>getOrCreateNearCache(@Nullable String cacheName, NearCacheConfiguration<K,V> nearCfg)Gets existing near cache with the given name or creates a new one.IgniteLoggerlog()Gets grid's logger.Collection<MemoryMetrics>memoryMetrics()@Nullable MemoryMetricsmemoryMetrics(String memPlcName)IgniteMessagingmessage()Getsmessagingfacade over all cluster nodes.IgniteMessagingmessage(ClusterGroup prj)Getsmessagingfacade over nodes within the cluster group.IgniteMetricsmetrics()Gets custom metrics facade over current node.Stringname()Gets the name of the Ignite instance.<T extends IgnitePlugin>
 Tplugin(String name)Gets an instance of deployed Ignite plugin.<T> @Nullable 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 andcfgis notnull.voidreadExternal(ObjectInput in)@Nullable IgniteLockreentrantLock(String name, boolean failoverSafe, boolean fair, boolean create)Gets or creates reentrant lock.voidresetLostPartitions(Collection<String> cacheNames)Clears partition's lost state and moves caches to a normal mode.IgniteSchedulerscheduler()Gets an instance of cron-based scheduler.@Nullable IgniteSemaphoresemaphore(String name, int cnt, boolean failoverSafe, boolean create)Gets or creates semaphore.IgniteServicesservices()Getsservicesfacade over all cluster nodes started in server mode.IgniteServicesservices(ClusterGroup grp)Getsservicesfacade over nodes within the cluster group.<T> @Nullable IgniteSet<T>set(String name, CollectionConfiguration cfg)Will get a named set from cache and create one if it has not been created yet andcfgis notnull.voidsetApplicationContext(org.springframework.context.ApplicationContext ctx)voidsetConfiguration(IgniteConfiguration cfg)Sets Ignite configuration.IgniteSnapshotsnapshot()StringtoString()@NotNull TracingConfigurationManagertracingConfiguration()Returns theTracingConfigurationManagerinstance that allows to Configure tracing parameters such as sampling rate for the specific tracing coordinates such as scope and label. Retrieve the most specific tracing parameters for the specified tracing coordinates (scope and label) Restore the tracing parameters for the specified tracing coordinates to the default. List all pairs of tracing configuration coordinates and tracing configuration parameters.IgniteTransactionstransactions()Gets grid transactions facade.IgniteProductVersionversion()Gets Ignite version.voidwriteExternal(ObjectOutput out)
 
- 
- 
- 
Method Detail- 
configurationpublic IgniteConfiguration configuration() Gets the configuration of this Ignite instance.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.- Specified by:
- configurationin interface- Ignite
- Returns:
- Ignite configuration instance.
 
 - 
getConfigurationpublic IgniteConfiguration getConfiguration() Gets the configuration of this Ignite instance.This method is required for proper Spring integration and is the same as configuration(). See https://issues.apache.org/jira/browse/IGNITE-1102 for details.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.- Returns:
- Ignite configuration instance.
- See Also:
- configuration()
 
 - 
setConfigurationpublic void setConfiguration(IgniteConfiguration cfg) Sets Ignite configuration.- Parameters:
- cfg- Ignite configuration.
 
 - 
getApplicationContextpublic org.springframework.context.ApplicationContext getApplicationContext() throws org.springframework.beans.BeansExceptionGets the spring application context this Ignite runs in.- Returns:
- Application context this Ignite runs in.
- Throws:
- org.springframework.beans.BeansException
 
 - 
setApplicationContextpublic void setApplicationContext(org.springframework.context.ApplicationContext ctx) throws org.springframework.beans.BeansException- Specified by:
- setApplicationContextin interface- org.springframework.context.ApplicationContextAware
- Throws:
- org.springframework.beans.BeansException
 
 - 
destroypublic void destroy() throws Exception- Specified by:
- destroyin interface- org.springframework.beans.factory.DisposableBean
- Throws:
- Exception
 
 - 
afterSingletonsInstantiatedpublic void afterSingletonsInstantiated() - Specified by:
- afterSingletonsInstantiatedin interface- org.springframework.beans.factory.SmartInitializingSingleton
 
 - 
logpublic IgniteLogger log() Gets grid's logger.
 - 
versionpublic IgniteProductVersion version() Gets Ignite version.
 - 
computepublic IgniteCompute compute() Getscomputefacade over all cluster nodes started in server mode.
 - 
metricspublic IgniteMetrics metrics() Gets custom metrics facade over current node.- Specified by:
- metricsin interface- Ignite
- Returns:
- IgniteMetricsinstance for current node.
 
 - 
servicespublic IgniteServices services() Getsservicesfacade over all cluster nodes started in server mode.
 - 
messagepublic IgniteMessaging message() Getsmessagingfacade over all cluster nodes.
 - 
eventspublic IgniteEvents events() Getseventsfacade over all cluster nodes.
 - 
executorServicepublic ExecutorService executorService() Creates a newExecutorServicewhich will execute all submittedCallableandRunnablejobs on all cluster nodes. This essentially creates a Distributed Thread Pool that can be used as a replacement for local thread pools.- Specified by:
- executorServicein interface- Ignite
- Returns:
- Grid-enabled ExecutorService.
 
 - 
clusterpublic IgniteCluster cluster() Gets an instance ofIgniteClusterinterface.- Specified by:
- clusterin interface- Ignite
- Returns:
- Instance of IgniteClusterinterface.
 
 - 
computepublic IgniteCompute compute(ClusterGroup grp) Getscomputefacade over the specified cluster group. All operations on the returnedIgniteComputeinstance will only include nodes from this cluster group.
 - 
messagepublic IgniteMessaging message(ClusterGroup prj) Getsmessagingfacade over nodes within the cluster group. All operations on the returnedIgniteMessaginginstance will only include nodes from the specified cluster group.
 - 
eventspublic IgniteEvents events(ClusterGroup grp) Getseventsfacade over nodes within the cluster group. All operations on the returnedIgniteEventsinstance will only include nodes from the specified cluster group.
 - 
servicespublic IgniteServices services(ClusterGroup grp) Getsservicesfacade over nodes within the cluster group. All operations on the returnedIgniteMessaginginstance will only include nodes from the specified cluster group.
 - 
executorServicepublic ExecutorService executorService(ClusterGroup grp) Creates a newExecutorServicewhich will execute all submittedCallableandRunnablejobs on nodes in the specified cluster group. This essentially creates a Distributed Thread Pool that can be used as a replacement for local thread pools.- Specified by:
- executorServicein interface- Ignite
- Parameters:
- grp- Cluster group.
- Returns:
- ExecutorServicewhich will execute jobs on nodes in given cluster group.
 
 - 
schedulerpublic IgniteScheduler scheduler() Gets an instance of cron-based scheduler.
 - 
namepublic String name() Gets the name of the Ignite instance. The name allows having multiple Ignite instances with different names within the same Java VM.If default Ignite instance is used, then nullis returned. Refer toIgnitiondocumentation for information on how to start named ignite Instances.
 - 
resetLostPartitionspublic void resetLostPartitions(Collection<String> cacheNames) Clears partition's lost state and moves caches to a normal mode.To avoid permanent data loss for persistent caches it's recommended to return all previously failed baseline nodes to the topology before calling this method. - Specified by:
- resetLostPartitionsin interface- Ignite
- Parameters:
- cacheNames- Name of the caches for which lost partitions is reset.
 
 - 
dataRegionMetricspublic Collection<DataRegionMetrics> dataRegionMetrics() Returns a collection ofDataRegionMetricsthat reflects page memory usage on this Apache Ignite node instance. Returns the collection that contains the latest snapshots for each memory region configured withconfigurationon this Ignite node instance.- Specified by:
- dataRegionMetricsin interface- Ignite
- Returns:
- Collection of DataRegionMetricssnapshots.
 
 - 
dataRegionMetrics@Nullable public @Nullable DataRegionMetrics dataRegionMetrics(String memPlcName) Returns the latestDataRegionMetricssnapshot for the memory region of the given name. To get the metrics for the default memory region useDataStorageConfiguration.DFLT_DATA_REG_DEFAULT_NAMEas the name or a custom name if the default memory region has been renamed.- Specified by:
- dataRegionMetricsin interface- Ignite
- Parameters:
- memPlcName- Name of memory region configured with- config.
- Returns:
- DataRegionMetricssnapshot or- nullif no memory region is configured under specified name.
 
 - 
encryptionpublic IgniteEncryption encryption() Gets an instance ofIgniteEncryptioninterface.- Specified by:
- encryptionin interface- Ignite
- Returns:
- Instance of IgniteEncryptioninterface.
 
 - 
snapshotpublic IgniteSnapshot snapshot() 
 - 
tracingConfiguration@NotNull public @NotNull TracingConfigurationManager tracingConfiguration() Returns theTracingConfigurationManagerinstance that allows to- Configure tracing parameters such as sampling rate for the specific tracing coordinates such as scope and label.
- Retrieve the most specific tracing parameters for the specified tracing coordinates (scope and label)
- Restore the tracing parameters for the specified tracing coordinates to the default.
- List all pairs of tracing configuration coordinates and tracing configuration parameters.
 - Specified by:
- tracingConfigurationin interface- Ignite
- Returns:
- TracingConfigurationManagerinstance.
 
 - 
memoryMetricspublic Collection<MemoryMetrics> memoryMetrics() - Specified by:
- memoryMetricsin interface- Ignite
- Returns:
- Collection of MemoryMetricssnapshots.
 
 - 
memoryMetrics@Nullable public @Nullable MemoryMetrics memoryMetrics(String memPlcName) - Specified by:
- memoryMetricsin interface- Ignite
- Parameters:
- memPlcName- Name of the data region.
- Returns:
- MemoryMetricssnapshot or- nullif no memory region is configured under specified name.
 
 - 
cachepublic <K,V> IgniteCache<K,V> cache(@Nullable @Nullable String name) Gets an instance ofIgniteCacheAPI for the given name if one is configured ornullotherwise.IgniteCacheis a fully-compatible implementation ofJCache (JSR 107)specification.
 - 
cacheNamespublic Collection<String> cacheNames() Gets the collection of names of currently available caches.- Specified by:
- cacheNamesin interface- Ignite
- Returns:
- Collection of names of currently available caches or an empty collection if no caches are available.
 
 - 
createCachepublic <K,V> IgniteCache<K,V> createCache(CacheConfiguration<K,V> cacheCfg) Dynamically starts new cache with the given cache configuration.If local node is an affinity node, this method will return the instance of started cache. Otherwise, it will create a client cache on local node. If a cache with the same name already exists in the grid, an exception will be thrown regardless whether the given configuration matches the configuration of the existing cache or not. - Specified by:
- createCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheCfg- Cache configuration to use.
- Returns:
- Instance of started cache.
 
 - 
getOrCreateCachepublic <K,V> IgniteCache<K,V> getOrCreateCache(CacheConfiguration<K,V> cacheCfg) Gets existing cache with the given name or creates new one with the given configuration.If a cache with the same name already exist, this method will not check that the given configuration matches the configuration of existing cache and will return an instance of the existing cache. - Specified by:
- getOrCreateCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheCfg- Cache configuration to use.
- Returns:
- Existing or newly created cache.
 
 - 
createCachepublic <K,V> IgniteCache<K,V> createCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg) Dynamically starts new cache with the given cache configuration.If local node is an affinity node, this method will return the instance of started cache. Otherwise, it will create a near cache with the given configuration on local node. If a cache with the same name already exists in the grid, an exception will be thrown regardless whether the given configuration matches the configuration of the existing cache or not. - Specified by:
- createCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheCfg- Cache configuration to use.
- nearCfg- Near cache configuration to use on local node in case it is not an affinity node.
- Returns:
- Instance of started cache.
 
 - 
createCachespublic Collection<IgniteCache> createCaches(Collection<CacheConfiguration> cacheCfgs) Dynamically starts new caches with the given cache configurations.If local node is an affinity node, this method will return the instance of started caches. Otherwise, it will create a client caches on local node. If for one of configurations a cache with the same name already exists in the grid, an exception will be thrown regardless whether the given configuration matches the configuration of the existing cache or not. - Specified by:
- createCachesin interface- Ignite
- Parameters:
- cacheCfgs- Collection of cache configuration to use.
- Returns:
- Collection of instances of started caches.
 
 - 
getOrCreateCachepublic <K,V> IgniteCache<K,V> getOrCreateCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg) Gets existing cache with the given cache configuration or creates one if it does not exist.If a cache with the same name already exist, this method will not check that the given configuration matches the configuration of existing cache and will return an instance of the existing cache. If local node is not an affinity node and a client cache without near cache has been already started on this node, an exception will be thrown. - Specified by:
- getOrCreateCachein interface- Ignite
- Type Parameters:
- K- type.
- V- type.
- Parameters:
- cacheCfg- Cache configuration.
- nearCfg- Near cache configuration for client.
- Returns:
- IgniteCacheinstance.
 
 - 
createNearCachepublic <K,V> IgniteCache<K,V> createNearCache(String cacheName, NearCacheConfiguration<K,V> nearCfg) Starts a near cache on local node if cache was previously started with one of theIgnite.createCache(CacheConfiguration)orIgnite.createCache(CacheConfiguration, NearCacheConfiguration)methods.- Specified by:
- createNearCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheName- Cache name.
- nearCfg- Near cache configuration.
- Returns:
- Cache instance.
 
 - 
getOrCreateNearCachepublic <K,V> IgniteCache<K,V> getOrCreateNearCache(@Nullable @Nullable String cacheName, NearCacheConfiguration<K,V> nearCfg) Gets existing near cache with the given name or creates a new one.- Specified by:
- getOrCreateNearCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheName- Cache name.
- nearCfg- Near configuration.
- Returns:
- IgniteCacheinstance.
 
 - 
getOrCreateCachepublic <K,V> IgniteCache<K,V> getOrCreateCache(String cacheName) Gets existing cache with the given name or creates new one using template configuration.- Specified by:
- getOrCreateCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheName- Cache name.
- Returns:
- Existing or newly created cache.
 
 - 
getOrCreateCachespublic Collection<IgniteCache> getOrCreateCaches(Collection<CacheConfiguration> cacheCfgs) Gets existing caches with the given name or created one with the given configuration.If a cache with the same name already exist, this method will not check that the given configuration matches the configuration of existing cache and will return an instance of the existing cache. - Specified by:
- getOrCreateCachesin interface- Ignite
- Parameters:
- cacheCfgs- Collection of cache configuration to use.
- Returns:
- Collection of existing or newly created caches.
 
 - 
createCachepublic <K,V> IgniteCache<K,V> createCache(String cacheName) Dynamically starts new cache using template configuration.If local node is an affinity node, this method will return the instance of started cache. Otherwise, it will create a client cache on local node. If a cache with the same name already exists in the grid, an exception will be thrown. - Specified by:
- createCachein interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheName- Cache name.
- Returns:
- Instance of started cache.
 
 - 
addCacheConfigurationpublic <K,V> void addCacheConfiguration(CacheConfiguration<K,V> cacheCfg) Adds cache configuration template.- Specified by:
- addCacheConfigurationin interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheCfg- Cache configuration template.
 
 - 
destroyCachepublic void destroyCache(String cacheName) Destroys a cache with the given name and cleans data that was written to the cache. The call will deallocate all resources associated with the given cache on all nodes in the cluster. There is no way to undo the action and recover destroyed data.All existing instances of IgniteCachewill be invalidated, subsequent calls to the API will throw exceptions.If a cache with the specified name does not exist in the grid, the operation has no effect. - Specified by:
- destroyCachein interface- Ignite
- Parameters:
- cacheName- Cache name to destroy.
 
 - 
destroyCachespublic void destroyCaches(Collection<String> cacheNames) Destroys caches with the given names and cleans data that was written to the caches. The call will deallocate all resources associated with the given caches on all nodes in the cluster. There is no way to undo the action and recover destroyed data.All existing instances of IgniteCachewill be invalidated, subsequent calls to the API will throw exceptions.If the specified collection contains nullor an empty value, this method will throwIllegalArgumentExceptionand the caches will not be destroyed.If a cache with the specified name does not exist in the grid, the specified value will be skipped. - Specified by:
- destroyCachesin interface- Ignite
- Parameters:
- cacheNames- Collection of cache names to destroy.
 
 - 
transactionspublic IgniteTransactions transactions() Gets grid transactions facade.- Specified by:
- transactionsin interface- Ignite
- Returns:
- Grid transactions facade.
 
 - 
dataStreamerpublic <K,V> IgniteDataStreamer<K,V> dataStreamer(@Nullable @Nullable String cacheName) Gets a new instance of data streamer associated with given cache name. Data streamer is responsible for loading external data into in-memory data grid. For more information refer toIgniteDataStreamerdocumentation.- Specified by:
- dataStreamerin interface- Ignite
- Type Parameters:
- K- Type of the cache key.
- V- Type of the cache value.
- Parameters:
- cacheName- Cache name.
- Returns:
- Data streamer.
 
 - 
pluginpublic <T extends IgnitePlugin> T plugin(String name) throws PluginNotFoundException Gets an instance of deployed Ignite plugin.- Specified by:
- pluginin interface- Ignite
- Type Parameters:
- T- Plugin type.
- Parameters:
- name- Plugin name.
- Returns:
- Plugin instance.
- Throws:
- PluginNotFoundException- If plugin for the given name was not found.
 
 - 
binarypublic IgniteBinary binary() Gets an instance ofIgniteBinaryinterface.- Specified by:
- binaryin interface- Ignite
- Returns:
- Instance of IgniteBinaryinterface.
 
 - 
closepublic void close() throws IgniteExceptionClosesthisinstance of grid. This method is identical to callingG.stop(igniteInstanceName, true).The method is invoked automatically on objects managed by the try-with-resourcesstatement.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Ignite
- Throws:
- IgniteException- If failed to stop grid.
 
 - 
atomicSequence@Nullable public @Nullable 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 andcreateflag istrue. It will use configuration fromIgniteConfiguration.getAtomicConfiguration().- Specified by:
- atomicSequencein interface- Ignite
- Parameters:
- name- Sequence name.
- initVal- Initial value for sequence. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Sequence for the given name.
 
 - 
atomicSequencepublic IgniteAtomicSequence atomicSequence(String name, AtomicConfiguration cfg, long initVal, boolean create) throws IgniteException Will get an atomic sequence from cache and create one if it has not been created yet andcreateflag istrue.- Specified by:
- atomicSequencein interface- Ignite
- Parameters:
- name- Sequence name.
- cfg- Configuration.
- initVal- Initial value for sequence. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Sequence for the given name.
- Throws:
- IgniteException- If sequence could not be fetched or created.
 
 - 
atomicLong@Nullable public @Nullable 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 andcreateflag istrue.- Specified by:
- atomicLongin interface- Ignite
- Parameters:
- name- Name of atomic long.
- initVal- Initial value for atomic long. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic long.
 
 - 
atomicLongpublic IgniteAtomicLong atomicLong(String name, AtomicConfiguration cfg, long initVal, boolean create) throws IgniteException Will get a atomic long from cache and create one if it has not been created yet andcreateflag istrue.- Specified by:
- atomicLongin interface- Ignite
- Parameters:
- name- Name of atomic long.
- cfg- Configuration.
- initVal- Initial value for atomic long. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic long.
- Throws:
- IgniteException- If atomic long could not be fetched or created.
 
 - 
atomicReference@Nullable public <T> @Nullable IgniteAtomicReference<T> atomicReference(String name, @Nullable T initVal, boolean create) Will get a atomic reference from cache and create one if it has not been created yet andcreateflag istrue. It will use configuration fromIgniteConfiguration.getAtomicConfiguration().- Specified by:
- atomicReferencein interface- Ignite
- Type Parameters:
- T- Type of object referred to by this reference.
- Parameters:
- name- Atomic reference name.
- initVal- Initial value for atomic reference. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic reference for the given name.
 
 - 
atomicReferencepublic <T> IgniteAtomicReference<T> atomicReference(String name, AtomicConfiguration cfg, @Nullable T initVal, boolean create) throws IgniteException Will get a atomic reference from cache and create one if it has not been created yet andcreateflag istrue.- Specified by:
- atomicReferencein interface- Ignite
- Type Parameters:
- T- Type of object referred to by this reference.
- Parameters:
- name- Atomic reference name.
- cfg- Configuration.
- initVal- Initial value for atomic reference. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic reference for the given name.
- Throws:
- IgniteException- If atomic reference could not be fetched or created.
 
 - 
atomicStamped@Nullable public <T,S> @Nullable IgniteAtomicStamped<T,S> atomicStamped(String name, @Nullable T initVal, @Nullable S initStamp, boolean create) Will get a atomic stamped from cache and create one if it has not been created yet andcreateflag istrue.- Specified by:
- atomicStampedin interface- Ignite
- Type Parameters:
- T- Type of object referred to by this atomic.
- S- Type of stamp object.
- Parameters:
- name- Atomic stamped name.
- initVal- Initial value for atomic stamped. Ignored if- createflag is- false.
- initStamp- Initial stamp for atomic stamped. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic stamped for the given name.
 
 - 
atomicStampedpublic <T,S> IgniteAtomicStamped<T,S> atomicStamped(String name, AtomicConfiguration cfg, @Nullable T initVal, @Nullable S initStamp, boolean create) throws IgniteException Will get a atomic stamped from cache and create one if it has not been created yet andcreateflag istrue.- Specified by:
- atomicStampedin interface- Ignite
- Type Parameters:
- T- Type of object referred to by this atomic.
- S- Type of stamp object.
- Parameters:
- name- Atomic stamped name.
- cfg- Configuration.
- initVal- Initial value for atomic stamped. Ignored if- createflag is- false.
- initStamp- Initial stamp for atomic stamped. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Atomic stamped for the given name.
- Throws:
- IgniteException- If atomic stamped could not be fetched or created.
 
 - 
countDownLatch@Nullable public @Nullable IgniteCountDownLatch countDownLatch(String name, int cnt, boolean autoDel, boolean create) Gets or creates count down latch. If count down latch is not found in cache andcreateflag istrue, it is created using provided name and count parameter.- Specified by:
- countDownLatchin interface- Ignite
- Parameters:
- name- Name of the latch.
- cnt- Count for new latch creation. Ignored if- createflag is- false.
- autoDel-- Trueto automatically delete latch from cache when its count reaches zero. Ignored if- createflag is- false.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Count down latch for the given name.
 
 - 
semaphore@Nullable public @Nullable IgniteSemaphore semaphore(String name, int cnt, boolean failoverSafe, boolean create) Gets or creates semaphore. If semaphore is not found in cache andcreateflag istrue, it is created using provided name and count parameter.- Specified by:
- semaphorein interface- Ignite
- Parameters:
- name- Name of the semaphore.
- cnt- Count for new semaphore creation. Ignored if- createflag is- false.
- failoverSafe-- Trueto create failover safe semaphore which means that if any node leaves topology permits already acquired by that node are silently released and become available for alive nodes to acquire. If flag is- falsethen all threads waiting for available permits get interrupted.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- Semaphore for the given name.
 
 - 
reentrantLock@Nullable public @Nullable IgniteLock reentrantLock(String name, boolean failoverSafe, boolean fair, boolean create) Gets or creates reentrant lock. If reentrant lock is not found in cache andcreateflag istrue, it is created using provided name.- Specified by:
- reentrantLockin interface- Ignite
- Parameters:
- name- Name of the lock.
- failoverSafe-- Trueto create failover safe lock which means that if any node leaves topology, all locks already acquired by that node are silently released and become available for other nodes to acquire. If flag is- falsethen all threads on other nodes waiting to acquire lock are interrupted.
- fair- If- True, fair lock will be created.
- create- Boolean flag indicating whether data structure should be created if does not exist.
- Returns:
- ReentrantLock for the given name.
 
 - 
queue@Nullable public <T> @Nullable 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 andcfgis notnull. If queue is present already, queue properties will not be changed. Use collocation forCacheMode.PARTITIONEDcaches 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.
 - 
set@Nullable public <T> @Nullable IgniteSet<T> set(String name, CollectionConfiguration cfg) Will get a named set from cache and create one if it has not been created yet andcfgis notnull.
 - 
affinitypublic <K> Affinity<K> affinity(String cacheName) Gets affinity service to provide information about data partitioning and distribution.
 - 
activepublic boolean active() Checks Ignite grid is active or not active.
 - 
activepublic void active(boolean active) Changes Ignite grid state to active or inactive.NOTE: Deactivation clears in-memory caches (without persistence) including the system caches. 
 - 
writeExternalpublic void writeExternal(ObjectOutput out) throws IOException - Specified by:
- writeExternalin interface- Externalizable
- Throws:
- IOException
 
 - 
readExternalpublic void readExternal(ObjectInput in) throws IOException, ClassNotFoundException - Specified by:
- readExternalin interface- Externalizable
- Throws:
- IOException
- ClassNotFoundException
 
 - 
checkIgniteprotected void checkIgnite() throws IllegalStateExceptionChecks if this bean is valid.- Throws:
- IllegalStateException- If bean is not valid, i.e. Ignite has already been stopped or has not yet been started.
 
 
- 
 
-