CassandraClusterFactoryBean (Spring Data for Apache Cassandra Core 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.cassandra.config.CassandraClusterFactoryBean

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, FactoryBean<com.datastax.driver.core.Cluster>, InitializingBean, PersistenceExceptionTranslator

Direct Known Subclasses:

CassandraCqlClusterFactoryBean
```
public class CassandraClusterFactoryBean
extends Object
implements FactoryBean<com.datastax.driver.core.Cluster>, InitializingBean, DisposableBean, BeanNameAware, PersistenceExceptionTranslator
```
FactoryBean for configuring a Cassandra Cluster.
This factory bean allows configuration and creation of Cluster bean. Most options default to null. Unsupported options are configured via ClusterBuilderConfigurer.
The factory bean initializes keyspaces, if configured, accoording to its lifecycle. Keyspaces can be created after initialization and dropped when this factory is destroyed. Keyspace actions can be configured via XML and programatically. Additional getStartupScripts() and getShutdownScripts() are executed after running keyspace actions.
XML configuration
```
     
                
                
                
                
        
 
```
Author:

Alex Shvid, Matthew T. Adams, David Webb, Kirk Clemens, Jorge Davison, John Blum, Mark Paluch, Stefan Birkner

See Also:

InitializingBean, DisposableBean, FactoryBean, Cluster

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CONTACT_POINTS`
`static boolean`	`DEFAULT_JMX_REPORTING_ENABLED`
`static int`	`DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS`
`static boolean`	`DEFAULT_METRICS_ENABLED`
`static int`	`DEFAULT_PORT`
`static boolean`	`DEFAULT_SSL_ENABLED`
`protected static org.slf4j.Logger`	`log`

Constructor Summary

Constructors
Constructor and Description

CassandraClusterFactoryBean()

Constructors
Constructor and Description
`CassandraClusterFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`destroy()`
`List<KeyspaceActions>`	`getKeyspaceActions()`
`List<CreateKeyspaceSpecification>`	`getKeyspaceCreations()`
`List<DropKeyspaceSpecification>`	`getKeyspaceDrops()`
`Set<KeyspaceActionSpecification>`	`getKeyspaceSpecifications()`
`com.datastax.driver.core.Cluster`	`getObject()`
`Class<? extends com.datastax.driver.core.Cluster>`	`getObjectType()`
`List<String>`	`getShutdownScripts()`
`List<String>`	`getStartupScripts()`
`boolean`	`isSingleton()`
`void`	`setAddressTranslator(com.datastax.driver.core.policies.AddressTranslator addressTranslator)` Configures the address translator used by the new cluster to translate IP addresses received from Cassandra nodes into locally query-able addresses.
`void`	`setAuthProvider(com.datastax.driver.core.AuthProvider authProvider)` Set the `AuthProvider`.
`void`	`setBeanName(String beanName)`
`void`	`setClusterBuilderConfigurer(ClusterBuilderConfigurer clusterBuilderConfigurer)` Sets the `ClusterBuilderConfigurer` used to apply additional configuration logic to the `Cluster.Builder`.
`void`	`setClusterName(String clusterName)` An optional name for the cluster instance.
`void`	`setCompressionType(CompressionType compressionType)` Set the `CompressionType`.
`void`	`setContactPoints(String contactPoints)` Set a comma-delimited string of the contact points (hosts) to connect to.
`void`	`setHostStateListener(com.datastax.driver.core.Host.StateListener hostStateListener)`
`void`	`setJmxReportingEnabled(boolean jmxReportingEnabled)` Set whether to use JMX reporting.
`void`	`setKeyspaceActions(List<KeyspaceActions> keyspaceActions)` Set a `List` of `KeyspaceActions` to be executed on initialization.
`void`	`setKeyspaceCreations(List<CreateKeyspaceSpecification> specifications)` Set a `List` of `create keyspace specifications` that are executed when this factory is `initialized`.
`void`	`setKeyspaceDrops(List<DropKeyspaceSpecification> specifications)` Set a `List` of `drop keyspace specifications` that are executed when this factory is `destroyed`.
`void`	`setKeyspaceSpecifications(Set<KeyspaceActionSpecification> keyspaceSpecifications)`
`void`	`setLatencyTracker(com.datastax.driver.core.LatencyTracker latencyTracker)`
`void`	`setLoadBalancingPolicy(com.datastax.driver.core.policies.LoadBalancingPolicy loadBalancingPolicy)` Set the `LoadBalancingPolicy` that decides which Cassandra hosts to contact for each new query.
`void`	`setMaxSchemaAgreementWaitSeconds(int seconds)` Sets the maximum time to wait for schema agreement before returning from a DDL query.
`void`	`setMetricsEnabled(boolean metricsEnabled)` Set whether metrics are enabled.
`void`	`setNettyOptions(com.datastax.driver.core.NettyOptions nettyOptions)` Set the `NettyOptions` used by a client to customize the driver's underlying Netty layer.
`void`	`setPassword(String password)` Set the username to use with `PlainTextAuthProvider`.
`void`	`setPoolingOptions(com.datastax.driver.core.PoolingOptions poolingOptions)` Set the `PoolingOptions` to configure the connection pooling behavior.
`void`	`setPort(int port)` Set the port for the contact points.
`void`	`setProtocolVersion(com.datastax.driver.core.ProtocolVersion protocolVersion)` Set the `ProtocolVersion`.
`void`	`setQueryOptions(com.datastax.driver.core.QueryOptions queryOptions)` Set the `QueryOptions` to tune to defaults for individual queries.
`void`	`setReconnectionPolicy(com.datastax.driver.core.policies.ReconnectionPolicy reconnectionPolicy)` Set the `ReconnectionPolicy` that decides how often the reconnection to a dead node is attempted.
`void`	`setRetryPolicy(com.datastax.driver.core.policies.RetryPolicy retryPolicy)` Set the `RetryPolicy` that defines a default behavior to adopt when a request fails.
`void`	`setShutdownScripts(List<String> scripts)` Set a `List` of raw `CQL statements` that are executed when this factory is `destroyed`.
`void`	`setSocketOptions(com.datastax.driver.core.SocketOptions socketOptions)` Set the `SocketOptions` containing low-level socket options.
`void`	`setSpeculativeExecutionPolicy(com.datastax.driver.core.policies.SpeculativeExecutionPolicy speculativeExecutionPolicy)` Configures the speculative execution policy to use for the new cluster.
`void`	`setSslEnabled(boolean sslEnabled)` Set whether to use SSL.
`void`	`setSslOptions(com.datastax.driver.core.SSLOptions sslOptions)`
`void`	`setStartupScripts(List<String> scripts)` Set a `List` of raw `CQL statements` that are executed when this factory is `initialized`.
`void`	`setTimestampGenerator(com.datastax.driver.core.TimestampGenerator timestampGenerator)` Configures the generator that will produce the client-side timestamp sent with each query.
`void`	`setUsername(String username)` Set the username to use with `PlainTextAuthProvider`.
`DataAccessException`	`translateExceptionIfPossible(RuntimeException ex)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_JMX_REPORTING_ENABLED
```
public static final boolean DEFAULT_JMX_REPORTING_ENABLED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_METRICS_ENABLED
```
public static final boolean DEFAULT_METRICS_ENABLED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_ENABLED
```
public static final boolean DEFAULT_SSL_ENABLED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS
```
public static final int DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONTACT_POINTS
```
public static final String DEFAULT_CONTACT_POINTS
```
    See Also:
    
    Constant Field Values
  - log
```
protected static final org.slf4j.Logger log
```
- Constructor Detail
  - CassandraClusterFactoryBean
```
public CassandraClusterFactoryBean()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface DisposableBean
  - getObject
```
public com.datastax.driver.core.Cluster getObject()
```
    Specified by:
    
    getObject in interface FactoryBean<com.datastax.driver.core.Cluster>
  - getObjectType
```
public Class<? extends com.datastax.driver.core.Cluster> getObjectType()
```
    Specified by:
    
    getObjectType in interface FactoryBean<com.datastax.driver.core.Cluster>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface FactoryBean<com.datastax.driver.core.Cluster>
  - translateExceptionIfPossible
```
public DataAccessException translateExceptionIfPossible(RuntimeException ex)
```
    Specified by:
    
    translateExceptionIfPossible in interface PersistenceExceptionTranslator
  - setBeanName
```
public void setBeanName(String beanName)
```
    Specified by:
    
    setBeanName in interface BeanNameAware
  - setContactPoints
```
public void setContactPoints(String contactPoints)
```
    Set a comma-delimited string of the contact points (hosts) to connect to. Default is localhost; see DEFAULT_CONTACT_POINTS.
    
    Parameters:
    
    contactPoints - the contact points used by the new cluster.
  - setPort
```
public void setPort(int port)
```
    Set the port for the contact points. Default is 9042, see DEFAULT_PORT.
    
    Parameters:
    
    port - the port used by the new cluster.
  - setCompressionType
```
public void setCompressionType(@Nullable
                               CompressionType compressionType)
```
    Set the CompressionType. Default is uncompressed.
    
    Parameters:
    
    compressionType - the CompressionType used by the new cluster.
  - setPoolingOptions
```
public void setPoolingOptions(@Nullable
                              com.datastax.driver.core.PoolingOptions poolingOptions)
```
    Set the PoolingOptions to configure the connection pooling behavior.
    
    Parameters:
    
    poolingOptions - the PoolingOptions used by the new cluster.
  - setProtocolVersion
```
public void setProtocolVersion(@Nullable
                               com.datastax.driver.core.ProtocolVersion protocolVersion)
```
    Set the ProtocolVersion.
    
    Parameters:
    
    protocolVersion - the ProtocolVersion used by the new cluster.
    
    Since:
    
    1.4
  - setSocketOptions
```
public void setSocketOptions(@Nullable
                             com.datastax.driver.core.SocketOptions socketOptions)
```
    Set the SocketOptions containing low-level socket options.
    
    Parameters:
    
    socketOptions - the SocketOptions used by the new cluster.
  - setQueryOptions
```
public void setQueryOptions(@Nullable
                            com.datastax.driver.core.QueryOptions queryOptions)
```
    Set the QueryOptions to tune to defaults for individual queries.
    
    Parameters:
    
    queryOptions - the QueryOptions used by the new cluster.
  - setAuthProvider
```
public void setAuthProvider(@Nullable
                            com.datastax.driver.core.AuthProvider authProvider)
```
    Set the AuthProvider. Default is unauthenticated.
    
    Parameters:
    
    authProvider - the AuthProvider used by the new cluster.
  - setNettyOptions
```
public void setNettyOptions(com.datastax.driver.core.NettyOptions nettyOptions)
```
    Set the NettyOptions used by a client to customize the driver's underlying Netty layer.
    
    Parameters:
    
    nettyOptions - the NettyOptions used by the new cluster.
    
    Since:
    
    1.5
  - setLoadBalancingPolicy
```
public void setLoadBalancingPolicy(@Nullable
                                   com.datastax.driver.core.policies.LoadBalancingPolicy loadBalancingPolicy)
```
    Set the LoadBalancingPolicy that decides which Cassandra hosts to contact for each new query.
    
    Parameters:
    
    loadBalancingPolicy - the LoadBalancingPolicy used by the new cluster.
  - setReconnectionPolicy
```
public void setReconnectionPolicy(@Nullable
                                  com.datastax.driver.core.policies.ReconnectionPolicy reconnectionPolicy)
```
    Set the ReconnectionPolicy that decides how often the reconnection to a dead node is attempted.
    
    Parameters:
    
    reconnectionPolicy - the ReconnectionPolicy used by the new cluster.
  - setRetryPolicy
```
public void setRetryPolicy(@Nullable
                           com.datastax.driver.core.policies.RetryPolicy retryPolicy)
```
    Set the RetryPolicy that defines a default behavior to adopt when a request fails.
    
    Parameters:
    
    retryPolicy - the RetryPolicy used by the new cluster.
  - setMetricsEnabled
```
public void setMetricsEnabled(boolean metricsEnabled)
```
    Set whether metrics are enabled. Default is true, see DEFAULT_METRICS_ENABLED.
  - getKeyspaceActions
```
public List<KeyspaceActions> getKeyspaceActions()
```
    Returns:
    
    the List of KeyspaceActions.
  - setKeyspaceActions
```
public void setKeyspaceActions(List<KeyspaceActions> keyspaceActions)
```
    Set a List of KeyspaceActions to be executed on initialization. Keyspace actions may contain create and drop specifications.
    
    Parameters:
    
    keyspaceActions - the List of KeyspaceActions.
  - setKeyspaceCreations
```
public void setKeyspaceCreations(List<CreateKeyspaceSpecification> specifications)
```
    Set a List of create keyspace specifications that are executed when this factory is initialized. Create keyspace specifications are executed on a system session with no keyspace set, before executing setStartupScripts(List).
    
    Parameters:
    
    specifications - the List of create keyspace specifications.
  - getKeyspaceCreations
```
public List<CreateKeyspaceSpecification> getKeyspaceCreations()
```
    Returns:
    
    List of create keyspace specifications.
  - setKeyspaceDrops
```
public void setKeyspaceDrops(List<DropKeyspaceSpecification> specifications)
```
    Set a List of drop keyspace specifications that are executed when this factory is destroyed. Drop keyspace specifications are executed on a system session with no keyspace set, before executing setShutdownScripts(List).
    
    Parameters:
    
    specifications - the List of drop keyspace specifications.
  - getKeyspaceDrops
```
public List<DropKeyspaceSpecification> getKeyspaceDrops()
```
    Returns:
    
    the List of drop keyspace specifications.
  - setStartupScripts
```
public void setStartupScripts(List<String> scripts)
```
    Set a List of raw CQL statements that are executed when this factory is initialized. Scripts are executed on a system session with no keyspace set, after executing setKeyspaceCreations(List).
    
    Parameters:
    
    scripts - the scripts to execute on startup
  - getStartupScripts
```
public List<String> getStartupScripts()
```
    Returns:
    
    the startup scripts
  - setShutdownScripts
```
public void setShutdownScripts(List<String> scripts)
```
    Set a List of raw CQL statements that are executed when this factory is destroyed. Drop keyspace specifications are executed on a system session with no keyspace set, after executing setKeyspaceDrops(List).
    
    Parameters:
    
    scripts - the scripts to execute on shutdown
  - getShutdownScripts
```
public List<String> getShutdownScripts()
```
    Returns:
    
    the shutdown scripts
  - setKeyspaceSpecifications
```
public void setKeyspaceSpecifications(Set<KeyspaceActionSpecification> keyspaceSpecifications)
```
    Parameters:
    
    keyspaceSpecifications - The KeyspaceActionSpecification to set.
  - getKeyspaceSpecifications
```
public Set<KeyspaceActionSpecification> getKeyspaceSpecifications()
```
    Returns:
    
    the KeyspaceActionSpecification associated with this factory.
  - setUsername
```
public void setUsername(String username)
```
    Set the username to use with PlainTextAuthProvider.
    
    Parameters:
    
    username - The username to set.
  - setPassword
```
public void setPassword(String password)
```
    Set the username to use with PlainTextAuthProvider.
    
    Parameters:
    
    password - The password to set.
  - setJmxReportingEnabled
```
public void setJmxReportingEnabled(boolean jmxReportingEnabled)
```
    Set whether to use JMX reporting. Default is false, see DEFAULT_JMX_REPORTING_ENABLED.
    
    Parameters:
    
    jmxReportingEnabled - The jmxReportingEnabled to set.
  - setSslEnabled
```
public void setSslEnabled(boolean sslEnabled)
```
    Set whether to use SSL. Default is plain, see DEFAULT_SSL_ENABLED.
    
    Parameters:
    
    sslEnabled - The sslEnabled to set.
  - setSslOptions
```
public void setSslOptions(com.datastax.driver.core.SSLOptions sslOptions)
```
    Parameters:
    
    sslOptions - The sslOptions to set.
  - setHostStateListener
```
public void setHostStateListener(com.datastax.driver.core.Host.StateListener hostStateListener)
```
    Parameters:
    
    hostStateListener - The hostStateListener to set.
  - setLatencyTracker
```
public void setLatencyTracker(com.datastax.driver.core.LatencyTracker latencyTracker)
```
    Parameters:
    
    latencyTracker - The latencyTracker to set.
  - setAddressTranslator
```
public void setAddressTranslator(@Nullable
                                 com.datastax.driver.core.policies.AddressTranslator addressTranslator)
```
    Configures the address translator used by the new cluster to translate IP addresses received from Cassandra nodes into locally query-able addresses.
    
    Parameters:
    
    addressTranslator - AddressTranslator used by the new cluster.
    
    Since:
    
    1.5
    
    See Also:
    
    Cluster.Builder.withAddressTranslator(AddressTranslator), AddressTranslator
  - setClusterBuilderConfigurer
```
public void setClusterBuilderConfigurer(@Nullable
                                        ClusterBuilderConfigurer clusterBuilderConfigurer)
```
    Sets the ClusterBuilderConfigurer used to apply additional configuration logic to the Cluster.Builder. ClusterBuilderConfigurer is invoked after all provided options are configured. The factory will Cluster.Builder.build() the Cluster after applying ClusterBuilderConfigurer.
    
    Parameters:
    
    clusterBuilderConfigurer - ClusterBuilderConfigurer used to configure the Cluster.Builder.
    
    See Also:
    
    org.springframework.data.cql.config.ClusterBuilderConfigurer
  - setClusterName
```
public void setClusterName(@Nullable
                           String clusterName)
```
    An optional name for the cluster instance. This name appears in JMX metrics. Defaults to the bean name.
    
    Parameters:
    
    clusterName - optional name for the cluster.
    
    Since:
    
    1.5
    
    See Also:
    
    Cluster.Builder.withClusterName(String)
  - setMaxSchemaAgreementWaitSeconds
```
public void setMaxSchemaAgreementWaitSeconds(int seconds)
```
    Sets the maximum time to wait for schema agreement before returning from a DDL query. The timeout is used to wait for all currently up hosts in the cluster to agree on the schema.
    
    Parameters:
    
    seconds - max schema agreement wait in seconds.
    
    Since:
    
    1.5
    
    See Also:
    
    Cluster.Builder.withMaxSchemaAgreementWaitSeconds(int)
  - setSpeculativeExecutionPolicy
```
public void setSpeculativeExecutionPolicy(@Nullable
                                          com.datastax.driver.core.policies.SpeculativeExecutionPolicy speculativeExecutionPolicy)
```
    Configures the speculative execution policy to use for the new cluster.
    
    Parameters:
    
    speculativeExecutionPolicy - SpeculativeExecutionPolicy to use with the new cluster.
    
    Since:
    
    1.5
    
    See Also:
    
    Cluster.Builder.withSpeculativeExecutionPolicy(SpeculativeExecutionPolicy), SpeculativeExecutionPolicy
  - setTimestampGenerator
```
public void setTimestampGenerator(@Nullable
                                  com.datastax.driver.core.TimestampGenerator timestampGenerator)
```
    Configures the generator that will produce the client-side timestamp sent with each query.
    
    Parameters:
    
    timestampGenerator - TimestampGenerator used to produce a client-side timestamp sent with each query.
    
    Since:
    
    1.5
    
    See Also:
    
    Cluster.Builder.withTimestampGenerator(TimestampGenerator), TimestampGenerator

Class CassandraClusterFactoryBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_JMX_REPORTING_ENABLED

DEFAULT_METRICS_ENABLED

DEFAULT_SSL_ENABLED

DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS

DEFAULT_PORT

DEFAULT_CONTACT_POINTS

log

Constructor Detail

CassandraClusterFactoryBean

Method Detail

afterPropertiesSet

destroy

getObject

getObjectType

isSingleton

translateExceptionIfPossible

setBeanName

setContactPoints

setPort

setCompressionType

setPoolingOptions

setProtocolVersion

setSocketOptions

setQueryOptions

setAuthProvider

setNettyOptions

setLoadBalancingPolicy

setReconnectionPolicy

setRetryPolicy

setMetricsEnabled

getKeyspaceActions

setKeyspaceActions

setKeyspaceCreations

getKeyspaceCreations

setKeyspaceDrops

getKeyspaceDrops

setStartupScripts

getStartupScripts

setShutdownScripts

getShutdownScripts

setKeyspaceSpecifications

getKeyspaceSpecifications

setUsername

setPassword

setJmxReportingEnabled

setSslEnabled

setSslOptions

setHostStateListener

setLatencyTracker

setAddressTranslator

setClusterBuilderConfigurer

setClusterName

setMaxSchemaAgreementWaitSeconds

setSpeculativeExecutionPolicy

setTimestampGenerator