org.apache.ignite

Class IgniteClientSpringBean

java.lang.Object

org.apache.ignite.IgniteClientSpringBean

All Implemented Interfaces:

AutoCloseable, IgniteClient, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class IgniteClientSpringBean
extends Object
implements IgniteClient, org.springframework.context.SmartLifecycle

Represents Ignite client Spring bean that provides the ability to automatically start Ignite client during Spring Context initialization. It requires ClientConfiguration to be set before bean use (see setClientConfiguration(ClientConfiguration)}). A note should be taken that Ignite client 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 IgniteClientSpringBean from any kind of Spring bean init methods like PostConstruct. If it's required to reference IgniteClientSpringBean for other bean initialization purposes, it should be done from a ContextRefreshedEvent listener method declared in that bean.

Spring XML Configuration Example

 <bean id="igniteClient" class="org.apache.ignite.IgniteClientSpringBean">
     <property name="clientConfiguration">
         <bean class="org.apache.ignite.configuration.ClientConfiguration">
             <property name="addresses">
                 <list>
                     <value>127.0.0.1:10800</value>
                 </list>
             </property>
         </bean>
     </property>
 </bean>
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_IGNITE_CLI_LIFECYCLE_PHASE Default Ignite client SmartLifecycle phase.

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
IgniteClientSpringBean()

Method Summary

Modifier and Type	Method and Description
ClientAtomicLong	atomicLong(String name, ClientAtomicConfiguration cfg, long initVal, boolean create)
ClientAtomicLong	atomicLong(String name, long initVal, boolean create)
IgniteBinary	binary()
<K,V> ClientCache<K,V>	cache(String name)
Collection<String>	cacheNames()
IgniteClientFuture<Collection<String>>	cacheNamesAsync()
void	close()
ClientCluster	cluster()
ClientCompute	compute()
ClientCompute	compute(ClientClusterGroup grp)
<K,V> ClientCache<K,V>	createCache(ClientCacheConfiguration cfg)
<K,V> ClientCache<K,V>	createCache(String name)
<K,V> IgniteClientFuture<ClientCache<K,V>>	createCacheAsync(ClientCacheConfiguration cfg)
<K,V> IgniteClientFuture<ClientCache<K,V>>	createCacheAsync(String name)
void	destroyCache(String name)
IgniteClientFuture<Void>	destroyCacheAsync(String name)
ClientConfiguration	getClientConfiguration()
<K,V> ClientCache<K,V>	getOrCreateCache(ClientCacheConfiguration cfg)
<K,V> ClientCache<K,V>	getOrCreateCache(String name)
<K,V> IgniteClientFuture<ClientCache<K,V>>	getOrCreateCacheAsync(ClientCacheConfiguration cfg)
<K,V> IgniteClientFuture<ClientCache<K,V>>	getOrCreateCacheAsync(String name)
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
FieldsQueryCursor<List<?>>	query(SqlFieldsQuery qry)
ClientServices	services()
ClientServices	services(ClientClusterGroup grp)
<T> ClientIgniteSet<T>	set(String name, @Nullable ClientCollectionConfiguration cfg)
IgniteClientSpringBean	setClientConfiguration(ClientConfiguration cfg) Sets Ignite client configuration.
IgniteClientSpringBean	setPhase(int phase) Sets SmartLifecycle phase during which the current bean will be initialized.
void	start()
void	stop()
void	stop(Runnable callback)
ClientTransactions	transactions()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_IGNITE_CLI_LIFECYCLE_PHASE

public static final int DFLT_IGNITE_CLI_LIFECYCLE_PHASE

Default Ignite client SmartLifecycle phase.

See Also:

Constant Field Values

Constructor Detail

IgniteClientSpringBean

public IgniteClientSpringBean()

Method Detail

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

getOrCreateCache

public <K,V> ClientCache<K,V> getOrCreateCache(String name)
                                        throws ClientException

Specified by:

getOrCreateCache in interface IgniteClient

Throws:

ClientException

getOrCreateCacheAsync

public <K,V> IgniteClientFuture<ClientCache<K,V>> getOrCreateCacheAsync(String name)
                                                                 throws ClientException

Specified by:

getOrCreateCacheAsync in interface IgniteClient

Throws:

ClientException

getOrCreateCache

public <K,V> ClientCache<K,V> getOrCreateCache(ClientCacheConfiguration cfg)
                                        throws ClientException

Specified by:

getOrCreateCache in interface IgniteClient

Throws:

ClientException

getOrCreateCacheAsync

public <K,V> IgniteClientFuture<ClientCache<K,V>> getOrCreateCacheAsync(ClientCacheConfiguration cfg)
                                                                 throws ClientException

Specified by:

getOrCreateCacheAsync in interface IgniteClient

Throws:

ClientException

cache

public <K,V> ClientCache<K,V> cache(String name)

Specified by:

cache in interface IgniteClient

cacheNames

public Collection<String> cacheNames()
                              throws ClientException

Specified by:

cacheNames in interface IgniteClient

Throws:

ClientException

cacheNamesAsync

public IgniteClientFuture<Collection<String>> cacheNamesAsync()
                                                       throws ClientException

Specified by:

cacheNamesAsync in interface IgniteClient

Throws:

ClientException

destroyCache

public void destroyCache(String name)
                  throws ClientException

Specified by:

destroyCache in interface IgniteClient

Throws:

ClientException

destroyCacheAsync

public IgniteClientFuture<Void> destroyCacheAsync(String name)
                                           throws ClientException

Specified by:

destroyCacheAsync in interface IgniteClient

Throws:

ClientException

createCache

public <K,V> ClientCache<K,V> createCache(String name)
                                   throws ClientException

Specified by:

createCache in interface IgniteClient

Throws:

ClientException

createCacheAsync

public <K,V> IgniteClientFuture<ClientCache<K,V>> createCacheAsync(String name)
                                                            throws ClientException

Specified by:

createCacheAsync in interface IgniteClient

Throws:

ClientException

createCache

public <K,V> ClientCache<K,V> createCache(ClientCacheConfiguration cfg)
                                   throws ClientException

Specified by:

createCache in interface IgniteClient

Throws:

ClientException

createCacheAsync

public <K,V> IgniteClientFuture<ClientCache<K,V>> createCacheAsync(ClientCacheConfiguration cfg)
                                                            throws ClientException

Specified by:

createCacheAsync in interface IgniteClient

Throws:

ClientException

binary

public IgniteBinary binary()

Specified by:

binary in interface IgniteClient

query

public FieldsQueryCursor<List<?>> query(SqlFieldsQuery qry)

Specified by:

query in interface IgniteClient

transactions

public ClientTransactions transactions()

Specified by:

transactions in interface IgniteClient

compute

public ClientCompute compute()

Specified by:

compute in interface IgniteClient

compute

public ClientCompute compute(ClientClusterGroup grp)

Specified by:

compute in interface IgniteClient

cluster

public ClientCluster cluster()

Specified by:

cluster in interface IgniteClient

services

public ClientServices services()

Specified by:

services in interface IgniteClient

services

public ClientServices services(ClientClusterGroup grp)

Specified by:

services in interface IgniteClient

atomicLong

public ClientAtomicLong atomicLong(String name,
                                   long initVal,
                                   boolean create)

Specified by:

atomicLong in interface IgniteClient

atomicLong

public ClientAtomicLong atomicLong(String name,
                                   ClientAtomicConfiguration cfg,
                                   long initVal,
                                   boolean create)

Specified by:

atomicLong in interface IgniteClient

set

public <T> ClientIgniteSet<T> set(String name,
                                  @Nullable
                                  @Nullable ClientCollectionConfiguration cfg)

Specified by:

set in interface IgniteClient

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IgniteClient

setClientConfiguration

public IgniteClientSpringBean setClientConfiguration(ClientConfiguration cfg)

Sets Ignite client configuration.

Parameters:

cfg - Ignite thin client configuration.

Returns:

this for chaining.

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Returns:

Ignite client configuration.

setPhase

public IgniteClientSpringBean setPhase(int phase)

Sets SmartLifecycle phase during which the current bean will be initialized. Note, underlying Ignite client will be closed during handling of DisposableBean since IgniteClient implements AutoCloseable interface.

Parameters:

phase - SmartLifecycle phase.

Returns:

this for chaining.