org.springframework.cassandra.config

Class CassandraCqlSessionFactoryBean

java.lang.Object

org.springframework.cassandra.config.CassandraCqlSessionFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean<com.datastax.driver.core.Session>, InitializingBean, PersistenceExceptionTranslator

public class CassandraCqlSessionFactoryBean
extends Object
implements FactoryBean<com.datastax.driver.core.Session>, InitializingBean, DisposableBean, PersistenceExceptionTranslator

Factory for configuring a Cassandra Session, which is a thread-safe singleton. As such, it is sufficient to have one Session per application and keyspace.

Author:

Alex Shvid, Matthew T. Adams

Field Summary

Fields

Modifier and Type	Field and Description
protected com.datastax.driver.core.Cluster	cluster
protected PersistenceExceptionTranslator	exceptionTranslator
protected String	keyspaceName
protected com.datastax.driver.core.Session	session
protected List<String>	shutdownScripts
protected List<String>	startupScripts

Constructor Summary

Constructors

Constructor and Description
CassandraCqlSessionFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
protected void	executeScripts(List<String> scripts) Executes given scripts.
com.datastax.driver.core.Session	getObject()
Class<? extends com.datastax.driver.core.Session>	getObjectType()
List<String>	getShutdownScripts() Returns an unmodifiable list of shutdown scripts.
List<String>	getStartupScripts() Returns an unmodifiable list of startup scripts.
boolean	isSingleton()
void	setCluster(com.datastax.driver.core.Cluster cluster) Sets the cluster to use.
void	setKeyspaceName(String keyspaceName) Sets the keyspace name to connect to.
void	setShutdownScripts(List<String> scripts) Sets CQL scripts to be executed immediately before the session is shutdown.
void	setStartupScripts(List<String> scripts) Sets CQL scripts to be executed immediately after the session is connected.
DataAccessException	translateExceptionIfPossible(RuntimeException ex)

Methods inherited from class java.lang.Object

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

Field Detail

cluster

protected com.datastax.driver.core.Cluster cluster

session

protected com.datastax.driver.core.Session session

keyspaceName

protected String keyspaceName

startupScripts

protected List<String> startupScripts

shutdownScripts

protected List<String> shutdownScripts

exceptionTranslator

protected final PersistenceExceptionTranslator exceptionTranslator

Constructor Detail

CassandraCqlSessionFactoryBean

public CassandraCqlSessionFactoryBean()

Method Detail

getObject

public com.datastax.driver.core.Session getObject()

Specified by:

getObject in interface FactoryBean<com.datastax.driver.core.Session>

getObjectType

public Class<? extends com.datastax.driver.core.Session> getObjectType()

Specified by:

getObjectType in interface FactoryBean<com.datastax.driver.core.Session>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<com.datastax.driver.core.Session>

translateExceptionIfPossible

public DataAccessException translateExceptionIfPossible(RuntimeException ex)

Specified by:

translateExceptionIfPossible in interface PersistenceExceptionTranslator

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

executeScripts

protected void executeScripts(List<String> scripts)

Executes given scripts. Session must be connected when this method is called.

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Throws:

Exception

setKeyspaceName

public void setKeyspaceName(String keyspaceName)

Sets the keyspace name to connect to. Using null, empty string, or only whitespace will cause the system keyspace to be used.

setCluster

public void setCluster(com.datastax.driver.core.Cluster cluster)

Sets the cluster to use. Must not be null.

setStartupScripts

public void setStartupScripts(List<String> scripts)

Sets CQL scripts to be executed immediately after the session is connected.

getStartupScripts

public List<String> getStartupScripts()

Returns an unmodifiable list of startup scripts.

setShutdownScripts

public void setShutdownScripts(List<String> scripts)

Sets CQL scripts to be executed immediately before the session is shutdown.

getShutdownScripts

public List<String> getShutdownScripts()

Returns an unmodifiable list of shutdown scripts.