org.apache.ignite

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.InitializingBean, org.springframework.context.ApplicationContextAware

public class IgniteSpringBean
extends Object
implements Ignite, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, Externalizable

Grid Spring bean allows to bypass Ignition methods. In other words, this bean class allows to inject new grid instance from Spring configuration file directly without invoking static Ignition methods. This class can be wired directly from Spring and can be referenced from within other Spring beans. By virtue of implementing DisposableBean and InitializingBean interfaces, GridSpringBean automatically starts and stops underlying grid instance.

Spring Configuration Example

Here is a typical example of describing it in Spring file:

 <bean id="mySpringBean" class="org.apache.ignite.GridSpringBean">
     <property name="configuration">
         <bean id="grid.cfg" class="org.apache.ignite.configuration.IgniteConfiguration">
             <property name="gridName" value="mySpringGrid"/>
         </bean>
     </property>
 </bean>
 

Or use default configuration:

 <bean id="mySpringBean" class="org.apache.ignite.GridSpringBean"/>
 

Java Example

Here 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();

 Grid grid = (Grid)ctx.getBean("mySpringBean");
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IgniteSpringBean()

Method Summary

Methods

Modifier and Type	Method and Description
<K,V> void	addCacheConfiguration(CacheConfiguration<K,V> cacheCfg)
<K> Affinity<K>	affinity(String cacheName)
void	afterPropertiesSet()
IgniteAtomicLong	atomicLong(String name, long initVal, boolean create)
<T> IgniteAtomicReference<T>	atomicReference(String name, T initVal, boolean create)
IgniteAtomicSequence	atomicSequence(String name, long initVal, boolean create)
<T,S> IgniteAtomicStamped<T,S>	atomicStamped(String name, T initVal, S initStamp, boolean create)
IgniteBinary	binary()
<K,V> IgniteCache<K,V>	cache(String name)
Collection<String>	cacheNames()
protected void	checkIgnite() Checks if this bean is valid.
void	close()
IgniteCluster	cluster()
IgniteCompute	compute()
IgniteCompute	compute(ClusterGroup grp)
IgniteConfiguration	configuration()
IgniteCountDownLatch	countDownLatch(String name, int cnt, boolean autoDel, boolean create)
<K,V> IgniteCache<K,V>	createCache(CacheConfiguration<K,V> cacheCfg)
<K,V> IgniteCache<K,V>	createCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg)
<K,V> IgniteCache<K,V>	createCache(String cacheName)
Collection<IgniteCache>	createCaches(Collection<CacheConfiguration> cacheCfgs)
<K,V> IgniteCache<K,V>	createNearCache(String cacheName, NearCacheConfiguration<K,V> nearCfg)
<K,V> IgniteDataStreamer<K,V>	dataStreamer(String cacheName)
void	destroy()
void	destroyCache(String cacheName)
void	destroyCaches(Collection<String> cacheNames)
IgniteEvents	events()
IgniteEvents	events(ClusterGroup grp)
ExecutorService	executorService()
ExecutorService	executorService(ClusterGroup grp)
IgniteFileSystem	fileSystem(String name)
Collection<IgniteFileSystem>	fileSystems()
org.springframework.context.ApplicationContext	getApplicationContext() Gets the spring application context this Ignite runs in.
IgniteConfiguration	getConfiguration() Gets the configuration of this Ignite instance.
<K,V> IgniteCache<K,V>	getOrCreateCache(CacheConfiguration<K,V> cacheCfg)
<K,V> IgniteCache<K,V>	getOrCreateCache(CacheConfiguration<K,V> cacheCfg, NearCacheConfiguration<K,V> nearCfg)
<K,V> IgniteCache<K,V>	getOrCreateCache(String cacheName)
Collection<IgniteCache>	getOrCreateCaches(Collection<CacheConfiguration> cacheCfgs)
<K,V> IgniteCache<K,V>	getOrCreateNearCache(String cacheName, NearCacheConfiguration<K,V> nearCfg)
IgniteLogger	log()
IgniteMessaging	message()
IgniteMessaging	message(ClusterGroup prj)
String	name()
<T extends IgnitePlugin> T	plugin(String name)
<T> IgniteQueue<T>	queue(String name, int cap, CollectionConfiguration cfg)
void	readExternal(ObjectInput in)
IgniteLock	reentrantLock(String name, boolean failoverSafe, boolean fair, boolean create)
IgniteScheduler	scheduler()
IgniteSemaphore	semaphore(String name, int cnt, boolean failoverSafe, boolean create)
IgniteServices	services()
IgniteServices	services(ClusterGroup grp)
<T> IgniteSet<T>	set(String name, CollectionConfiguration cfg)
void	setApplicationContext(org.springframework.context.ApplicationContext ctx)
void	setConfiguration(IgniteConfiguration cfg) Sets Ignite configuration.
String	toString()
IgniteTransactions	transactions()
IgniteProductVersion	version()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

IgniteSpringBean

public IgniteSpringBean()

Method Detail

configuration

public IgniteConfiguration configuration()

Specified by:

configuration in interface Ignite

getConfiguration

public 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()

setConfiguration

public void setConfiguration(IgniteConfiguration cfg)

Sets Ignite configuration.

Parameters:

cfg - Ignite configuration.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()
                                                                     throws org.springframework.beans.BeansException

Gets the spring application context this Ignite runs in.

Returns:

Application context this Ignite runs in.

Throws:

org.springframework.beans.BeansException

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext ctx)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

log

public IgniteLogger log()

Specified by:

log in interface Ignite

version

public IgniteProductVersion version()

Specified by:

version in interface Ignite

compute

public IgniteCompute compute()

Specified by:

compute in interface Ignite

services

public IgniteServices services()

Specified by:

services in interface Ignite

message

public IgniteMessaging message()

Specified by:

message in interface Ignite

events

public IgniteEvents events()

Specified by:

events in interface Ignite

executorService

public ExecutorService executorService()

Specified by:

executorService in interface Ignite

cluster

public IgniteCluster cluster()

Specified by:

cluster in interface Ignite

compute

public IgniteCompute compute(ClusterGroup grp)

Specified by:

compute in interface Ignite

message

public IgniteMessaging message(ClusterGroup prj)

Specified by:

message in interface Ignite

events

public IgniteEvents events(ClusterGroup grp)

Specified by:

events in interface Ignite

services

public IgniteServices services(ClusterGroup grp)

Specified by:

services in interface Ignite

executorService

public ExecutorService executorService(ClusterGroup grp)

Specified by:

executorService in interface Ignite

scheduler

public IgniteScheduler scheduler()

Specified by:

scheduler in interface Ignite

name

public String name()

Specified by:

name in interface Ignite

cache

public <K,V> IgniteCache<K,V> cache(@Nullable
                           String name)

Specified by:

cache in interface Ignite

cacheNames

public Collection<String> cacheNames()

Specified by:

cacheNames in interface Ignite

createCache

public <K,V> IgniteCache<K,V> createCache(CacheConfiguration<K,V> cacheCfg)

Specified by:

createCache in interface Ignite

getOrCreateCache

public <K,V> IgniteCache<K,V> getOrCreateCache(CacheConfiguration<K,V> cacheCfg)

Specified by:

getOrCreateCache in interface Ignite

createCache

public <K,V> IgniteCache<K,V> createCache(CacheConfiguration<K,V> cacheCfg,
                                 NearCacheConfiguration<K,V> nearCfg)

Specified by:

createCache in interface Ignite

createCaches

public Collection<IgniteCache> createCaches(Collection<CacheConfiguration> cacheCfgs)

Specified by:

createCaches in interface Ignite

getOrCreateCache

public <K,V> IgniteCache<K,V> getOrCreateCache(CacheConfiguration<K,V> cacheCfg,
                                      NearCacheConfiguration<K,V> nearCfg)

Specified by:

getOrCreateCache in interface Ignite

createNearCache

public <K,V> IgniteCache<K,V> createNearCache(String cacheName,
                                     NearCacheConfiguration<K,V> nearCfg)

Specified by:

createNearCache in interface Ignite

getOrCreateNearCache

public <K,V> IgniteCache<K,V> getOrCreateNearCache(@Nullable
                                          String cacheName,
                                          NearCacheConfiguration<K,V> nearCfg)

Specified by:

getOrCreateNearCache in interface Ignite

getOrCreateCache

public <K,V> IgniteCache<K,V> getOrCreateCache(String cacheName)

Specified by:

getOrCreateCache in interface Ignite

getOrCreateCaches

public Collection<IgniteCache> getOrCreateCaches(Collection<CacheConfiguration> cacheCfgs)

Specified by:

getOrCreateCaches in interface Ignite

createCache

public <K,V> IgniteCache<K,V> createCache(String cacheName)

Specified by:

createCache in interface Ignite

addCacheConfiguration

public <K,V> void addCacheConfiguration(CacheConfiguration<K,V> cacheCfg)

Specified by:

addCacheConfiguration in interface Ignite

destroyCache

public void destroyCache(String cacheName)

Specified by:

destroyCache in interface Ignite

destroyCaches

public void destroyCaches(Collection<String> cacheNames)

Specified by:

destroyCaches in interface Ignite

transactions

public IgniteTransactions transactions()

Specified by:

transactions in interface Ignite

dataStreamer

public <K,V> IgniteDataStreamer<K,V> dataStreamer(@Nullable
                                         String cacheName)

Specified by:

dataStreamer in interface Ignite

fileSystem

public IgniteFileSystem fileSystem(String name)

Specified by:

fileSystem in interface Ignite

fileSystems

public Collection<IgniteFileSystem> fileSystems()

Specified by:

fileSystems in interface Ignite

plugin

public <T extends IgnitePlugin> T plugin(String name)
                              throws PluginNotFoundException

Specified by:

plugin in interface Ignite

Throws:

PluginNotFoundException

binary

public IgniteBinary binary()

Specified by:

binary in interface Ignite

close

public void close()
           throws IgniteException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Ignite

Throws:

IgniteException

atomicSequence

@Nullable
public IgniteAtomicSequence atomicSequence(String name,
                                           long initVal,
                                           boolean create)

Specified by:

atomicSequence in interface Ignite

atomicLong

@Nullable
public IgniteAtomicLong atomicLong(String name,
                                   long initVal,
                                   boolean create)

Specified by:

atomicLong in interface Ignite

atomicReference

@Nullable
public <T> IgniteAtomicReference<T> atomicReference(String name,
                                                    @Nullable
                                                    T initVal,
                                                    boolean create)

Specified by:

atomicReference in interface Ignite

atomicStamped

@Nullable
public <T,S> IgniteAtomicStamped<T,S> atomicStamped(String name,
                                                    @Nullable
                                                    T initVal,
                                                    @Nullable
                                                    S initStamp,
                                                    boolean create)

Specified by:

atomicStamped in interface Ignite

countDownLatch

@Nullable
public IgniteCountDownLatch countDownLatch(String name,
                                           int cnt,
                                           boolean autoDel,
                                           boolean create)

Specified by:

countDownLatch in interface Ignite

semaphore

@Nullable
public IgniteSemaphore semaphore(String name,
                                 int cnt,
                                 boolean failoverSafe,
                                 boolean create)

Specified by:

semaphore in interface Ignite

reentrantLock

@Nullable
public IgniteLock reentrantLock(String name,
                                boolean failoverSafe,
                                boolean fair,
                                boolean create)

Specified by:

reentrantLock in interface Ignite

queue

@Nullable
public <T> IgniteQueue<T> queue(String name,
                                int cap,
                                CollectionConfiguration cfg)

Specified by:

queue in interface Ignite

set

@Nullable
public <T> IgniteSet<T> set(String name,
                            CollectionConfiguration cfg)

Specified by:

set in interface Ignite

affinity

public <K> Affinity<K> affinity(String cacheName)

Specified by:

affinity in interface Ignite

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

checkIgnite

protected void checkIgnite()
                    throws IllegalStateException

Checks 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.

toString

public String toString()

Overrides:

toString in class Object