Package org.springframework.data.cassandra.config

Class AbstractCassandraConfiguration

java.lang.Object

org.springframework.data.cassandra.config.AbstractSessionConfiguration

org.springframework.data.cassandra.config.AbstractCassandraConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware

Direct Known Subclasses:

AbstractReactiveCassandraConfiguration

@Configuration
public abstract class AbstractCassandraConfiguration
extends AbstractSessionConfiguration
implements BeanClassLoaderAware

Base class for Spring Data Cassandra configuration using JavaConfig.

Author:

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

Constructor Summary

Constructors

Constructor	Description
AbstractCassandraConfiguration()

Method Summary

Modifier and Type	Method	Description
CassandraConverter	cassandraConverter()	Creates a CassandraConverter using the configured cassandraMapping().
CassandraManagedTypes	cassandraManagedTypes()	Returns the given CassandraManagedTypes object holding the initial entity set.
CassandraMappingContext	cassandraMapping()	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0, use cassandraMappingContext(CassandraManagedTypes) instead.
CassandraMappingContext	cassandraMappingContext(CassandraManagedTypes cassandraManagedTypes)	Return the MappingContext instance to map Entities to Java Objects.
SessionFactoryFactoryBean	cassandraSessionFactory(com.datastax.oss.driver.api.core.CqlSession cqlSession)	Creates a SessionFactoryFactoryBean that provides a SessionFactory.
CassandraAdminTemplate	cassandraTemplate()	Creates a CassandraAdminTemplate.
CassandraCustomConversions	customConversions()	Register custom Converters in a CustomConversions object if required.
protected Optional<ClassLoader>	getBeanClassLoader()	Returns the configured Java ClassLoader used to resolve Cassandra application entity types.
String[]	getEntityBasePackages()	Base packages to scan for entities annotated with Table annotations.
protected Set<Class<?>>	getInitialEntitySet()	Return the Set of initial entity classes.
protected SessionFactory	getRequiredSessionFactory()	Returns the initialized CqlSession instance.
SchemaAction	getSchemaAction()	The SchemaAction to perform at application startup.
protected @Nullable KeyspacePopulator	keyspaceCleaner()	Creates a KeyspacePopulator to cleanup the keyspace.
protected @Nullable KeyspacePopulator	keyspacePopulator()	Creates a KeyspacePopulator to initialize the keyspace.
protected ByteArrayResource	scriptOf(String content)	Creates a new ByteArrayResource given content.
void	setBeanClassLoader(@Nullable ClassLoader classLoader)	Configures the Java ClassLoader used to resolve Cassandra application entity types.
protected UserTypeResolver	userTypeResolver(com.datastax.oss.driver.api.core.CqlSession cqlSession)	Creates a new UserTypeResolver from the given CqlSession.

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

cassandraSession, cqlTemplate, getBeanFactory, getClusterName, getCompressionType, getContactPoints, getDriverConfigLoaderBuilderConfigurer, getDriverConfigurationResource, getKeyspaceCreations, getKeyspaceDrops, getKeyspaceName, getLocalDataCenter, getPort, getRequiredSession, getSessionBuilderConfigurer, getSessionName, getShutdownScripts, getStartupScripts, requireBeanOfType, setBeanFactory

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCassandraConfiguration

public AbstractCassandraConfiguration()

Method Details

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()

cassandraManagedTypes

@Bean
public CassandraManagedTypes cassandraManagedTypes()
                                            throws ClassNotFoundException

Returns the given CassandraManagedTypes object holding the initial entity set.

Returns:

new instance of CassandraManagedTypes.

Throws:

ClassNotFoundException

Since:

4.0

cassandraMapping

@Deprecated(since="4.0",
            forRemoval=true)
public CassandraMappingContext cassandraMapping()
                                         throws ClassNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use cassandraMappingContext(CassandraManagedTypes) instead.

Return the MappingContext instance to map Entities to Java Objects.

Throws:

ClassNotFoundException

See Also:

• CassandraMappingContext

cassandraMappingContext

@Bean
public CassandraMappingContext cassandraMappingContext(CassandraManagedTypes cassandraManagedTypes)

Return the MappingContext instance to map Entities to Java Objects.

See Also:

• CassandraMappingContext

cassandraSessionFactory

@Bean
public SessionFactoryFactoryBean cassandraSessionFactory(com.datastax.oss.driver.api.core.CqlSession cqlSession)

Creates a SessionFactoryFactoryBean that provides a SessionFactory. The lifecycle of SessionFactoryFactoryBean initializes the schema in the configured keyspace.

Returns:

the SessionFactoryFactoryBean.

See Also:

• cassandraConverter()
• AbstractSessionConfiguration.getKeyspaceName()
• getSchemaAction()
• keyspacePopulator()
• keyspaceCleaner()

cassandraTemplate

@Bean
public CassandraAdminTemplate cassandraTemplate()

Creates a CassandraAdminTemplate.

customConversions

@Bean
public CassandraCustomConversions 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

setBeanClassLoader

public void setBeanClassLoader(@Nullable ClassLoader classLoader)

Configures the Java ClassLoader used to resolve Cassandra application entity types.

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Parameters:

classLoader - Java ClassLoader used to resolve Cassandra application entity types; may be null.

See Also:

• ClassLoader

getBeanClassLoader

protected Optional<ClassLoader> getBeanClassLoader()

Returns the configured Java ClassLoader used to resolve Cassandra application entity types.

Returns:

the Java ClassLoader used to resolve Cassandra application entity types.

See Also:

• ClassLoader
• Optional

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.

getInitialEntitySet

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

Return the Set of initial entity classes. Scans by default the class path using getEntityBasePackages(). Can be overridden 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

getRequiredSessionFactory

protected SessionFactory getRequiredSessionFactory()

Returns the initialized CqlSession instance.

Overrides:

getRequiredSessionFactory in class AbstractSessionConfiguration

Returns:

the CqlSession.

Throws:

IllegalStateException - if the session factory is not initialized.

getSchemaAction

public SchemaAction getSchemaAction()

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

See Also:

• SchemaAction

keyspaceCleaner

protected @Nullable KeyspacePopulator keyspaceCleaner()

Creates a KeyspacePopulator to cleanup the keyspace.

Returns:

the KeyspacePopulator or null if none configured.

See Also:

• ResourceKeyspacePopulator

keyspacePopulator

protected @Nullable KeyspacePopulator keyspacePopulator()

Creates a KeyspacePopulator to initialize the keyspace.

Returns:

the KeyspacePopulator or null if none configured.

See Also:

• ResourceKeyspacePopulator

scriptOf

protected ByteArrayResource scriptOf(String content)

Creates a new ByteArrayResource given content.

Parameters:

content - the script content.

Returns:

a new ByteArrayResource for content.

Since:

3.0

userTypeResolver

protected UserTypeResolver userTypeResolver(com.datastax.oss.driver.api.core.CqlSession cqlSession)

Creates a new UserTypeResolver from the given CqlSession. Uses by default the configured keyspace name.

Parameters:

cqlSession - the Cassandra CqlSession to use.

Returns:

a new SimpleUserTypeResolver.

Since:

3.4.3