org.springframework.data.cassandra.config

Class AbstractCassandraConfiguration

java.lang.Object

org.springframework.data.cassandra.config.AbstractClusterConfiguration

org.springframework.data.cassandra.config.AbstractCassandraConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware

Direct Known Subclasses:

AbstractReactiveCassandraConfiguration

@Configuration
public abstract class AbstractCassandraConfiguration
extends AbstractClusterConfiguration
implements BeanClassLoaderAware

Base class for Spring Data Cassandra configuration using JavaConfig.

Author:

Alex Shvid, Matthew T. Adams, John Blum, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
AbstractCassandraConfiguration()

Method Summary

Modifier and Type	Method and Description
CassandraConverter	cassandraConverter() Creates a CassandraConverter using the configured cassandraMapping().
CassandraMappingContext	cassandraMapping() Return the MappingContext instance to map Entities to properties.
CassandraAdminTemplate	cassandraTemplate() Creates a CassandraAdminTemplate.
CustomConversions	customConversions() Register custom Converters in a CustomConversions object if required.
String[]	getEntityBasePackages() Base packages to scan for entities annotated with Table annotations.
protected Set<Class<?>>	getInitialEntitySet() Return the Set of initial entity classes.
protected abstract String	getKeyspaceName() Return the name of the keyspace to connect to.
protected com.datastax.driver.core.Session	getRequiredSession() Returns the initialized Session instance.
SchemaAction	getSchemaAction() The SchemaAction to perform at startup.
CassandraSessionFactoryBean	session() Creates a CassandraSessionFactoryBean that provides a Cassandra Session.
SessionFactory	sessionFactory() Creates a DefaultSessionFactory using the configured session() to be used with CassandraTemplate.
void	setBeanClassLoader(ClassLoader classLoader)

Methods inherited from class org.springframework.data.cassandra.config.AbstractClusterConfiguration

cluster, getAddressTranslator, getAuthProvider, getClusterBuilderConfigurer, getClusterName, getCompressionType, getContactPoints, getKeyspaceCreations, getKeyspaceDrops, getLoadBalancingPolicy, getMaxSchemaAgreementWaitSeconds, getMetricsEnabled, getNettyOptions, getPoolingOptions, getPort, getProtocolVersion, getQueryOptions, getReconnectionPolicy, getRequiredCluster, getRetryPolicy, getShutdownScripts, getSocketOptions, getSpeculativeExecutionPolicy, getStartupScripts, getTimestampGenerator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCassandraConfiguration

public AbstractCassandraConfiguration()

Method Detail

getRequiredSession

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

Returns the initialized Session instance.

Returns:

the Session.

Throws:

IllegalStateException - if the session factory is not initialized.

session

@Bean
public CassandraSessionFactoryBean session()

Creates a CassandraSessionFactoryBean that provides a Cassandra Session. The lifecycle of CassandraSessionFactoryBean initializes the schema in the configured keyspace.

Returns:

the CassandraSessionFactoryBean.

See Also:

AbstractClusterConfiguration.cluster(), cassandraConverter(), getKeyspaceName(), getSchemaAction(), AbstractClusterConfiguration.getStartupScripts(), AbstractClusterConfiguration.getShutdownScripts()

sessionFactory

@Bean
public SessionFactory sessionFactory()

Creates a DefaultSessionFactory using the configured session() to be used with CassandraTemplate.

Returns:

SessionFactory used to initialize the Template API.

Since:

2.0

cassandraConverter

@Bean
public CassandraConverter cassandraConverter()

Creates a CassandraConverter using the configured cassandraMapping(). Will apply all specified customConversions().

Returns:

CassandraConverter used to convert Java and Cassandra value types during the mapping process.

See Also:

cassandraMapping(), customConversions()

cassandraMapping

@Bean
public CassandraMappingContext cassandraMapping()
                                               throws ClassNotFoundException

Return the MappingContext instance to map Entities to properties.

Throws:

ClassNotFoundException - if the Cassandra Entity class type identified by name cannot be found during the scan.

See Also:

CassandraMappingContext

customConversions

@Bean
public CustomConversions customConversions()

Register custom Converters in a CustomConversions object if required. These CustomConversions will be registered with the cassandraConverter() and cassandraMapping() . Returns an empty CustomConversions instance by default.

Returns:

must not be null.

Since:

1.5

getInitialEntitySet

protected Set<Class<?>> getInitialEntitySet()
                                     throws ClassNotFoundException

Return the Set of initial entity classes. Scans by default the class path using getEntityBasePackages(). Can be overriden by subclasses to skip class path scanning and return a fixed set of entity classes.

Returns:

Set of initial entity classes.

Throws:

ClassNotFoundException - if the entity scan fails.

Since:

2.0

See Also:

getEntityBasePackages(), CassandraEntityClassScanner

cassandraTemplate

@Bean
public CassandraAdminTemplate cassandraTemplate()
                                               throws Exception

Creates a CassandraAdminTemplate.

Throws:

Exception - if the Session could not be obtained.

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getEntityBasePackages

public String[] getEntityBasePackages()

Base packages to scan for entities annotated with Table annotations. By default, returns the package name of this (this.getClass().getPackage().getName(). This method must never return null.

getKeyspaceName

protected abstract String getKeyspaceName()

Return the name of the keyspace to connect to.

Returns:

must not be null.

getSchemaAction

public SchemaAction getSchemaAction()

The SchemaAction to perform at startup. Defaults to SchemaAction.NONE.