org.springframework.data.cassandra.config

Class CassandraCqlSessionFactoryBean

java.lang.Object

org.springframework.data.cassandra.config.CassandraCqlSessionFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<com.datastax.driver.core.Session>, org.springframework.beans.factory.InitializingBean, org.springframework.dao.support.PersistenceExceptionTranslator

Direct Known Subclasses:

CassandraSessionFactoryBean

public class CassandraCqlSessionFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<com.datastax.driver.core.Session>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.dao.support.PersistenceExceptionTranslator

Factory for creating and 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, John Blum, Mark Paluch

See Also:

DisposableBean, FactoryBean, InitializingBean, PersistenceExceptionTranslator, CqlTemplate, CassandraExceptionTranslator, Cluster, Session

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

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 the given Cassandra CQL scripts.
protected com.datastax.driver.core.Cluster	getCluster() Returns a reference to the configured Cassandra Cluster used by this application.
protected String	getKeyspaceName() Gets the name of the Cassandra Keyspace to connect to.
com.datastax.driver.core.Session	getObject()
Class<? extends com.datastax.driver.core.Session>	getObjectType()
protected com.datastax.driver.core.Session	getSession() Returns a reference to the connected Cassandra Session.
List<String>	getShutdownScripts() Returns an unmodifiable list of shutdown scripts.
List<String>	getStartupScripts() Returns an unmodifiable list of startup scripts.
boolean	isConnected() Null-safe operation to determine whether the Cassandra Session is connected or not.
boolean	isSingleton()
void	setCluster(com.datastax.driver.core.Cluster cluster) Sets a reference to the Cassandra Cluster to use.
void	setKeyspaceName(String keyspaceName) Sets the name of the Cassandra Keyspace 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.
org.springframework.dao.DataAccessException	translateExceptionIfPossible(RuntimeException e)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

CassandraCqlSessionFactoryBean

public CassandraCqlSessionFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

getObject

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

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<com.datastax.driver.core.Session>

getObjectType

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

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<com.datastax.driver.core.Session>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<com.datastax.driver.core.Session>

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception

executeScripts

protected void executeScripts(List<String> scripts)

Executes the given Cassandra CQL scripts. The Session must be connected when this method is called.

translateExceptionIfPossible

public org.springframework.dao.DataAccessException translateExceptionIfPossible(RuntimeException e)

Specified by:

translateExceptionIfPossible in interface org.springframework.dao.support.PersistenceExceptionTranslator

isConnected

public boolean isConnected()

Null-safe operation to determine whether the Cassandra Session is connected or not.

Returns:

a boolean value indicating whether the Cassandra Session is connected.

See Also:

Session.isClosed(), getObject()

setCluster

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

Sets a reference to the Cassandra Cluster to use.

Parameters:

cluster - a reference to the Cassandra Cluster used by this application.

Throws:

IllegalArgumentException - if the Cluster reference is null.

See Also:

Cluster, getCluster()

getCluster

protected com.datastax.driver.core.Cluster getCluster()

Returns a reference to the configured Cassandra Cluster used by this application.

Returns:

a reference to the configured Cassandra Cluster.

Throws:

IllegalStateException - if the reference to the Cluster was not properly initialized.

See Also:

Cluster, setCluster(Cluster)

setKeyspaceName

public void setKeyspaceName(@Nullable
                            String keyspaceName)

Sets the name of the Cassandra Keyspace to connect to. Passing null, an empty String, or whitespace will cause the Cassandra System Keyspace to be used.

Parameters:

keyspaceName - a String indicating the name of the Keyspace in which to connect.

See Also:

getKeyspaceName()

getKeyspaceName

@Nullable
protected String getKeyspaceName()

Gets the name of the Cassandra Keyspace to connect to.

Returns:

the name of the Cassandra Keyspace to connect to as a String.

See Also:

setKeyspaceName(String)

getSession

protected com.datastax.driver.core.Session getSession()

Returns a reference to the connected Cassandra Session.

Returns:

a reference to the connected Cassandra Session.

Throws:

IllegalStateException - if the Cassandra Session was not properly initialized.

See Also:

Session

setStartupScripts

public void setStartupScripts(@Nullable
                              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(@Nullable
                               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.