Class SessionFactoryFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<SessionFactory>

org.springframework.data.cassandra.config.SessionFactoryFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<SessionFactory>, InitializingBean

public class SessionFactoryFactoryBean
extends AbstractFactoryBean<SessionFactory>

Factory to create and configure a Cassandra SessionFactory with support for executing CQL and initializing the database schema (a.k.a. keyspace). This factory bean invokes a SessionFactoryInitializer to prepare a keyspace before applying schema actions such as creating user-defined types and tables.

Since:

3.0

Author:

Mark Paluch, Ammar Khaku

See Also:

• SessionFactoryInitializer

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	DEFAULT_CREATE_IF_NOT_EXISTS
protected static final boolean	DEFAULT_DROP_TABLES
protected static final boolean	DEFAULT_DROP_UNUSED_TABLES

Fields inherited from class AbstractFactoryBean

logger

Fields inherited from interface FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
SessionFactoryFactoryBean()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected SessionFactory	createInstance()
protected void	createTables(boolean drop, boolean dropUnused, boolean ifNotExists)	Perform schema actions.
void	destroy()
@Nullable Class<?>	getObjectType()
protected void	performSchemaAction()	Perform the configured SchemaAction using CassandraMappingContext metadata.
void	setConverter(CassandraConverter converter)	Set the CassandraConverter to use.
void	setKeyspaceCleaner(@Nullable KeyspacePopulator keyspaceCleaner)	Set the KeyspacePopulator to execute during the bean destruction phase, cleaning up the keyspace and leaving it in a known state for others.
void	setKeyspacePopulator(@Nullable KeyspacePopulator keyspacePopulator)	Set the KeyspacePopulator to execute during the bean initialization phase.
void	setSchemaAction(SchemaAction schemaAction)	Set the SchemaAction.
void	setSession(com.datastax.oss.driver.api.core.CqlSession session)	Set the CqlSession to use.
void	setSuspendLifecycleSchemaRefresh(boolean suspendLifecycleSchemaRefresh)	Set whether to suspend schema refresh settings during afterPropertiesSet() and destroy() lifecycle callbacks.
protected boolean	shouldRunSchemaAction()

Methods inherited from class AbstractFactoryBean

destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class Object

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

Field Details

DEFAULT_CREATE_IF_NOT_EXISTS

protected static final boolean DEFAULT_CREATE_IF_NOT_EXISTS

See Also:

• Constant Field Values

DEFAULT_DROP_TABLES

protected static final boolean DEFAULT_DROP_TABLES

See Also:

• Constant Field Values

DEFAULT_DROP_UNUSED_TABLES

protected static final boolean DEFAULT_DROP_UNUSED_TABLES

See Also:

• Constant Field Values

Constructor Details

SessionFactoryFactoryBean

public SessionFactoryFactoryBean()

Method Details

setConverter

public void setConverter(CassandraConverter converter)

Set the CassandraConverter to use. Schema actions will derive table and user type information from the CassandraMappingContext inside converter.

Parameters:

converter - must not be null.

setKeyspaceCleaner

public void setKeyspaceCleaner(@Nullable KeyspacePopulator keyspaceCleaner)

Set the KeyspacePopulator to execute during the bean destruction phase, cleaning up the keyspace and leaving it in a known state for others.

Parameters:

keyspaceCleaner - the KeyspacePopulator to use during cleanup.

See Also:

• setKeyspacePopulator(KeyspacePopulator)

setKeyspacePopulator

public void setKeyspacePopulator(@Nullable KeyspacePopulator keyspacePopulator)

Set the KeyspacePopulator to execute during the bean initialization phase. The KeyspacePopulator is invoked before creating the schema.

Parameters:

keyspacePopulator - the KeyspacePopulator to use during initialization.

See Also:

• setKeyspaceCleaner(KeyspacePopulator)

setSchemaAction

public void setSchemaAction(SchemaAction schemaAction)

Set the SchemaAction.

Parameters:

schemaAction - must not be null.

setSuspendLifecycleSchemaRefresh

public void setSuspendLifecycleSchemaRefresh(boolean suspendLifecycleSchemaRefresh)

Set whether to suspend schema refresh settings during afterPropertiesSet() and destroy() lifecycle callbacks. Disabled by default to use schema metadata settings of the session configuration. When enabled (set to true), then schema refresh during lifecycle methods is suspended until finishing schema actions to avoid periodic schema refreshes for each DDL statement.

Suspending schema refresh can be useful to delay schema agreement until the entire schema is created. Note that disabling schema refresh may interfere with schema actions. SchemaAction.RECREATE_DROP_UNUSED and mapping-based schema creation rely on schema metadata.

Parameters:

suspendLifecycleSchemaRefresh - true to suspend the schema refresh during lifecycle callbacks; false otherwise to retain the session schema refresh configuration.

Since:

2.7

setSession

public void setSession(com.datastax.oss.driver.api.core.CqlSession session)

Set the CqlSession to use.

Parameters:

session - must not be null.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractFactoryBean<SessionFactory>

Throws:

Exception

createInstance

protected SessionFactory createInstance()

Specified by:

createInstance in class AbstractFactoryBean<SessionFactory>

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class AbstractFactoryBean<SessionFactory>

Throws:

Exception

getObjectType

public @Nullable Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<SessionFactory>

Specified by:

getObjectType in class AbstractFactoryBean<SessionFactory>

performSchemaAction

protected void performSchemaAction()

Perform the configured SchemaAction using CassandraMappingContext metadata.

createTables

protected void createTables(boolean drop,
 boolean dropUnused,
 boolean ifNotExists)

Perform schema actions.

Parameters:

drop - true to drop types/tables.

dropUnused - true to drop unused types/tables (i.e. types/tables not know to be used by CassandraMappingContext).

ifNotExists - true to perform creations fail-safe by adding IF NOT EXISTS to each creation statement.

shouldRunSchemaAction

protected boolean shouldRunSchemaAction()

Returns:

true if schema action or KeyspacePopulator defined.

Since:

4.3