info.archinnov.achilles.embedded

Class CassandraEmbeddedServerBuilder

java.lang.Object

info.archinnov.achilles.embedded.CassandraEmbeddedServerBuilder

public class CassandraEmbeddedServerBuilder
extends Object

Builder for embedded Cassandra server

 CassandraEmbeddedServerBuilder
   .withEntityPackages("test")
   .withClusterName("Test Cluster")
   .withDataFolder("/home/user/cassandra/data")
   .withCommitLogFolder("/home/user/cassandra/commitlog")
   .withSavedCachesFolder("/home/user/cassandra/saved_caches")
   .cleanDataFilesAtStartup(true)
   .withClusterName("Test Cluster")
   .withKeyspaceName("achilles_test")
   .withCQLPort(9042)
   .withThriftPort(9160)
   .withStoragePort(7990)
   .withStorageSSLPort(7999)
   .withDurableWrite(true)
   .withScript("init_script.cql")
   .withProtocolVersion(ProtocolVersion.V3)
   .buildPersistenceManager();

 

Method Summary

Modifier and Type	Method and Description
com.datastax.driver.core.Cluster	buildNativeClusterOnly() Start an embedded Cassandra server but DO NOT bootstrap Achilles
com.datastax.driver.core.Session	buildNativeSessionOnly() Start an embedded Cassandra server but DO NOT bootstrap Achilles
PersistenceManager	buildPersistenceManager() Build CQL Persistence Manager
PersistenceManagerFactory	buildPersistenceManagerFactory() Build CQL Persistence Manager Factory
CassandraEmbeddedServerBuilder	cleanDataFilesAtStartup(boolean cleanDataFilesAtStartup) Whether to clean all data files in data folder, commit log folder and saved caches folder at startup or not.
static CassandraEmbeddedServerBuilder	noEntityPackages() Bootstrap Achilles without entity packages.
CassandraEmbeddedServerBuilder	withAchillesConfigParams(Map<ConfigurationParameters,Object> configParams) Add Achilles configuration parameters
CassandraEmbeddedServerBuilder	withClusterName(String clusterName) Specify the cluster name for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withCommitLogFolder(String commitLogFolder) Specify commit log folder for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withConcurrentReads(int concurrentReads) Specify the number threads for concurrent reads for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withConcurrentWrites(int concurrentWrites) Specify the number threads for concurrent writes for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withCQLPort(int clqPort) Specify the native transport port (CQL port) for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withDataFolder(String dataFolder) Specify data folder for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withDurableWrite(boolean durableWrite) Specify the 'durable write' property for the embedded Cassandra server.
static CassandraEmbeddedServerBuilder	withEntities(Class<?>... entities) Bootstrap Achilles with entities
static CassandraEmbeddedServerBuilder	withEntities(List<Class<?>> entities) Bootstrap Achilles with entities list
static CassandraEmbeddedServerBuilder	withEntityPackages(String entityPackages) Bootstrap Achilles with entity packages
CassandraEmbeddedServerBuilder	withKeyspaceName(String keyspaceName) Specify the keyspace name for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withProtocolVersion(com.datastax.driver.core.ProtocolVersion protocolVersion)
CassandraEmbeddedServerBuilder	withSavedCachesFolder(String savedCachesFolder) Specify saved caches folder for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withScript(String scriptLocation) Load an CQL script in the class path and execute it upon initialization of the embedded Cassandra server Call this method as many times as there are CQL scripts to be executed.
CassandraEmbeddedServerBuilder	withStoragePort(int storagePort) Specify the storage port for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withStorageSSLPort(int storageSSLPort) Specify the storage SSL port for the embedded Cassandra server.
CassandraEmbeddedServerBuilder	withThriftPort(int thriftPort) Specify the rpc port (Thrift port) for the embedded Cassandra server.

Methods inherited from class java.lang.Object

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

Method Detail

withEntityPackages

public static CassandraEmbeddedServerBuilder withEntityPackages(String entityPackages)

Bootstrap Achilles with entity packages

Parameters:

entityPackages - entity packages to scan for @Entity annotation

Returns:

CassandraEmbeddedServerBuilder

withEntities

public static CassandraEmbeddedServerBuilder withEntities(List<Class<?>> entities)

Bootstrap Achilles with entities list

Parameters:

entities - entities list

Returns:

CassandraEmbeddedServerBuilder

withEntities

public static CassandraEmbeddedServerBuilder withEntities(Class<?>... entities)

Bootstrap Achilles with entities

Parameters:

entities - entities

Returns:

CassandraEmbeddedServerBuilder

noEntityPackages

public static CassandraEmbeddedServerBuilder noEntityPackages()

Bootstrap Achilles without entity packages. Only nativeQuery(), nativeSession() and nativeCluster() are useful in this mode

Returns:

CassandraEmbeddedServerBuilder

withDataFolder

public CassandraEmbeddedServerBuilder withDataFolder(String dataFolder)

Specify data folder for the embedded Cassandra server. Default value is 'target/cassandra_embedded/data'

Parameters:

dataFolder - data folder for the embedded Cassandra server

Returns:

CassandraEmbeddedServerBuilder

withCommitLogFolder

public CassandraEmbeddedServerBuilder withCommitLogFolder(String commitLogFolder)

Specify commit log folder for the embedded Cassandra server. Default value is 'target/cassandra_embedded/commitlog'

Parameters:

commitLogFolder - commit log folder for the embedded Cassandra server

Returns:

CassandraEmbeddedServerBuilder

withSavedCachesFolder

public CassandraEmbeddedServerBuilder withSavedCachesFolder(String savedCachesFolder)

Specify saved caches folder for the embedded Cassandra server. Default value is 'target/cassandra_embedded/saved_caches'

Parameters:

savedCachesFolder - saved caches folder for the embedded Cassandra server

Returns:

CassandraEmbeddedServerBuilder

cleanDataFilesAtStartup

public CassandraEmbeddedServerBuilder cleanDataFilesAtStartup(boolean cleanDataFilesAtStartup)

Whether to clean all data files in data folder, commit log folder and saved caches folder at startup or not. Default value = 'true'

Parameters:

cleanDataFilesAtStartup - whether to clean all data files at startup or not

Returns:

CassandraEmbeddedServerBuilder

withClusterName

public CassandraEmbeddedServerBuilder withClusterName(String clusterName)

Specify the cluster name for the embedded Cassandra server. Default value is 'Achilles Embedded Cassandra Cluster'

Parameters:

clusterName - cluster name

Returns:

CassandraEmbeddedServerBuilder

withKeyspaceName

public CassandraEmbeddedServerBuilder withKeyspaceName(String keyspaceName)

Specify the keyspace name for the embedded Cassandra server. Default value is 'achilles_embedded'
If the keyspace does not exist, it will be created by Achilles

Parameters:

keyspaceName - keyspace name

Returns:

CassandraEmbeddedServerBuilder

withCQLPort

public CassandraEmbeddedServerBuilder withCQLPort(int clqPort)

Specify the native transport port (CQL port) for the embedded Cassandra server. If not set, the port will be randomized at runtime

Parameters:

clqPort - native transport port

Returns:

CassandraEmbeddedServerBuilder

withThriftPort

public CassandraEmbeddedServerBuilder withThriftPort(int thriftPort)

Specify the rpc port (Thrift port) for the embedded Cassandra server. If not set, the port will be randomized at runtime

Parameters:

thriftPort - rpc port

Returns:

CassandraEmbeddedServerBuilder

withStoragePort

public CassandraEmbeddedServerBuilder withStoragePort(int storagePort)

Specify the storage port for the embedded Cassandra server. If not set, the port will be randomized at runtime

Parameters:

storagePort - storage port

Returns:

CassandraEmbeddedServerBuilder

withStorageSSLPort

public CassandraEmbeddedServerBuilder withStorageSSLPort(int storageSSLPort)

Specify the storage SSL port for the embedded Cassandra server. If not set, the port will be randomized at runtime

Parameters:

storageSSLPort - storage SSL port

Returns:

CassandraEmbeddedServerBuilder

withConcurrentReads

public CassandraEmbeddedServerBuilder withConcurrentReads(int concurrentReads)

Specify the number threads for concurrent reads for the embedded Cassandra server. If not set, 32

Parameters:

concurrentReads - the number threads for concurrent reads

Returns:

CassandraEmbeddedServerBuilder

withConcurrentWrites

public CassandraEmbeddedServerBuilder withConcurrentWrites(int concurrentWrites)

Specify the number threads for concurrent writes for the embedded Cassandra server. If not set, 32

Parameters:

concurrentWrites - the number threads for concurrent writes

Returns:

CassandraEmbeddedServerBuilder

withDurableWrite

public CassandraEmbeddedServerBuilder withDurableWrite(boolean durableWrite)

Specify the 'durable write' property for the embedded Cassandra server. Default value is 'false'. If not set, Cassandra will not write to commit log. For testing purpose, it is recommended to deactivate it to speed up tests

Parameters:

durableWrite - whether to activate 'durable write' or not

Returns:

CassandraEmbeddedServerBuilder

withAchillesConfigParams

public CassandraEmbeddedServerBuilder withAchillesConfigParams(Map<ConfigurationParameters,Object> configParams)

Add Achilles configuration parameters

Parameters:

configParams - Achilles configuration parameters

Returns:

CassandraEmbeddedServerBuilder

withScript

public CassandraEmbeddedServerBuilder withScript(String scriptLocation)

Load an CQL script in the class path and execute it upon initialization of the embedded Cassandra server
Call this method as many times as there are CQL scripts to be executed.
Example:

      CassandraEmbeddedServerBuilder
          .withScript("script1.cql")
          .withScript("script2.cql")
          ...
  

Parameters:

scriptLocation - location of the CQL script in the class path

Returns:

CassandraEmbeddedServerBuilder

withProtocolVersion

public CassandraEmbeddedServerBuilder withProtocolVersion(com.datastax.driver.core.ProtocolVersion protocolVersion)

buildPersistenceManagerFactory

public PersistenceManagerFactory buildPersistenceManagerFactory()

Build CQL Persistence Manager Factory

Returns:

PersistenceManagerFactory

buildPersistenceManager

public PersistenceManager buildPersistenceManager()

Build CQL Persistence Manager

Returns:

PersistenceManager

buildNativeSessionOnly

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

Start an embedded Cassandra server but DO NOT bootstrap Achilles

Returns:

native Java driver core Session

buildNativeClusterOnly

public com.datastax.driver.core.Cluster buildNativeClusterOnly()

Start an embedded Cassandra server but DO NOT bootstrap Achilles

Returns:

native Java driver core Cluster