CassandraEmbeddedServerBuilder (Achilles Embedded 6.1.0 API)

java.lang.Object
- info.archinnov.achilles.embedded.CassandraEmbeddedServerBuilder

public class CassandraEmbeddedServerBuilder
extends Object

Builder for embedded Cassandra server



 CassandraEmbeddedServerBuilder
 .builder()
 .withListenAdress("127.0.0.1")
 .withRpcAdress("127.0.0.1")
 .withBroadcastAdress("127.0.0.1")
 .withBroadcastRPCAdress("127.0.0.1")
 .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")
 .buildNativeCluster();

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CassandraEmbeddedServerBuilder`	`builder()` Create a new CassandraEmbeddedServerBuilder
`Cluster`	`buildNativeCluster()` Start an embedded Cassandra server but DO NOT bootstrap Achilles
`Session`	`buildNativeSession()` Start an embedded Cassandra server but DO NOT bootstrap Achilles
`CassandraEmbeddedServer`	`buildServer()`
`CassandraEmbeddedServerBuilder`	`cleanDataFilesAtStartup(boolean cleanDataFilesAtStartup)` Whether to clean all data files in data folder, commit log folder and saved caches folder at startup or not.
`CassandraEmbeddedServerBuilder`	`useUnsafeCassandraDeamon()` Use an unsafe version of the Cassandra daemon.
`CassandraEmbeddedServerBuilder`	`useUnsafeCassandraDeamon(boolean useUnsafeCassandraDaemon)` Use an unsafe version of the Cassandra daemon.
`CassandraEmbeddedServerBuilder`	`withBroadcastAddress(String broadcastAddress)` Specify the broadcast address.
`CassandraEmbeddedServerBuilder`	`withBroadcastRpcAddress(String broadcastRpcAddress)` Specify the broadcast RPC address.
`CassandraEmbeddedServerBuilder`	`withCdcRawFolder(String cdcRawFolder)` Specify cdc_raw folder for the embedded Cassandra server.
`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`	`withConnectionProtocol(ProtocolVersion protocolVersion)` Specify the connection protocol version 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.
`CassandraEmbeddedServerBuilder`	`withHintsFolder(String hintsFolder)` Specify hints folder for the embedded Cassandra server.
`CassandraEmbeddedServerBuilder`	`withJMXPort(int jmxPort)` Specify the JMX port for the embedded Cassandra server.
`CassandraEmbeddedServerBuilder`	`withKeyspaceName(String keyspaceName)` Specify the keyspace name for the embedded Cassandra server.
`CassandraEmbeddedServerBuilder`	`withListenAddress(String listenAddress)` Specify the listen address.
`CassandraEmbeddedServerBuilder`	`withParams(info.archinnov.achilles.type.TypedMap cassandraParams)` Inject Cassandra parameters
`CassandraEmbeddedServerBuilder`	`withRpcAddress(String rpcAddress)` Specify the rpc address.
`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`	`withScriptTemplate(String scriptTemplateLocation, Map<String,Object> values)` Load an CQL script template in the class path, inject the values into the template to produce the final script and execute it upon initialization of the embedded Cassandra server Call this method as many times as there are CQL templates to be executed.
`CassandraEmbeddedServerBuilder`	`withShutdownHook(CassandraShutDownHook cassandraShutDownHook)` Inject a shutdown hook to control when to shutdown the embedded Cassandra process.
`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
  - builder
```
public static CassandraEmbeddedServerBuilder builder()
```
    Create a new CassandraEmbeddedServerBuilder
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withListenAddress
```
public CassandraEmbeddedServerBuilder withListenAddress(String listenAddress)
```
    Specify the listen address. Default value = localhost
    
    Parameters:
    
    listenAddress - the listen address
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withRpcAddress
```
public CassandraEmbeddedServerBuilder withRpcAddress(String rpcAddress)
```
    Specify the rpc address. Default value = localhost
    
    Parameters:
    
    rpcAddress - the RPC address
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withBroadcastAddress
```
public CassandraEmbeddedServerBuilder withBroadcastAddress(String broadcastAddress)
```
    Specify the broadcast address. Default value = localhost
    
    Leaving this blank will set it to the same value as listen_address
    
    Parameters:
    
    broadcastAddress - the address to broadcast to other Cassandra nodes.
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withBroadcastRpcAddress
```
public CassandraEmbeddedServerBuilder withBroadcastRpcAddress(String broadcastRpcAddress)
```
    Specify the broadcast RPC address. Default value = localhost
    
    This cannot be set to 0.0.0.0. If left blank, this will be set to the value of rpc_address. If rpc_address is set to 0.0.0.0, broadcast_rpc_address must be set
    
    Parameters:
    
    broadcastRpcAddress - the RPC address to broadcast to drivers and other Cassandra nodes
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withShutdownHook
```
public CassandraEmbeddedServerBuilder withShutdownHook(CassandraShutDownHook cassandraShutDownHook)
```
    Inject a shutdown hook to control when to shutdown the embedded Cassandra process.
```
 CassandraShutDownHook shutdownHook = new CassandraShutDownHook();

 Session session = CassandraEmbeddedServerBuilder.builder()
   .withShutdownHook(shutdownHook)
   ...
   .buildNativeSession();

 ...

 shutdownHook.shutdownNow();
 
```
    Please note that upon call on shutdownNow(), Achilles will trigger the shutdown of:
    - the embedded Cassandra server
    - the associated Cluster object
    - the associated Session object
    Parameters:
    
    cassandraShutDownHook - shutdown hook to control the shutdown of the embedded Cassandra process;
    
    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
  - withHintsFolder
```
public CassandraEmbeddedServerBuilder withHintsFolder(String hintsFolder)
```
    Specify hints folder for the embedded Cassandra server. Default value is 'target/cassandra_embedded/hints'
    
    Parameters:
    
    hintsFolder - hints folder for the embedded Cassandra server
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withCdcRawFolder
```
public CassandraEmbeddedServerBuilder withCdcRawFolder(String cdcRawFolder)
```
    Specify cdc_raw folder for the embedded Cassandra server. Default value is 'target/cassandra_embedded/cdc_raw'
    
    Parameters:
    
    cdcRawFolder - cdc_raw 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
  - withConnectionProtocol
```
public CassandraEmbeddedServerBuilder withConnectionProtocol(ProtocolVersion protocolVersion)
```
    Specify the connection protocol version for the embedded Cassandra server. If not set, the version will be the newest supported.
    
    Parameters:
    
    protocolVersion - connection protocol version
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withJMXPort
```
public CassandraEmbeddedServerBuilder withJMXPort(int jmxPort)
```
    Specify the JMX port for the embedded Cassandra server. If not set, the port will be randomized at runtime
    
    Parameters:
    
    jmxPort - JMX 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
  - 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")
 ...
 .build();
 
```
    Parameters:
    
    scriptLocation - location of the CQL script in the class path
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withScriptTemplate
```
public CassandraEmbeddedServerBuilder withScriptTemplate(String scriptTemplateLocation,
                                                         Map<String,Object> values)
```
    Load an CQL script template in the class path, inject the values into the template to produce the final script and execute it upon initialization of the embedded Cassandra server
    Call this method as many times as there are CQL templates to be executed.
    Example:
```
 Map<String, Object> map1 = new HashMap<>();

 map1.put("id", 100L);
 map1.put("date", new Date());
 ...

 CassandraEmbeddedServerBuilder
 .withScriptTemplate("script1.cql", map1)
 .withScriptTemplate("script2.cql", map2)
 ...
 .build();
 
```
    Parameters:
    
    scriptTemplateLocation - location of the CQL script in the class path
    
    values - values to inject into the template.
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - withParams
```
public CassandraEmbeddedServerBuilder withParams(info.archinnov.achilles.type.TypedMap cassandraParams)
```
    Inject Cassandra parameters
    
    Parameters:
    
    cassandraParams - cassandra parameter
    
    Returns:
    
    CassandraEmbeddedServerBuilder
  - useUnsafeCassandraDeamon
```
public CassandraEmbeddedServerBuilder useUnsafeCassandraDeamon()
```
    Use an unsafe version of the Cassandra daemon. This version will:
    - disable JMX
    - disable legacy schema migration
    - disable pre-3.0 hints migration
    - disable pre-3.0 batch entries migration
    - disable auto compaction on all keyspaces. Your test/dev data should fit in memory normally
    - disable metrics
    - disable GCInspector
    - disable native mlock system call
    - disable Thrift server
    - disable startup checks (Jemalloc, validLaunchDate, JMXPorts, JvmOptions, JnaInitialization, initSigarLibrary, dataDirs, SSTablesFormat, SystemKeyspaceState, Datacenter, Rack)
    - disable materialized view rebuild. You should clean your data folder between each test anyway
    - disable the SizeEstimatesRecorder (estimate SSTable size, who cares for unit testing or dev ?)
    Returns:
  - useUnsafeCassandraDeamon
```
public CassandraEmbeddedServerBuilder useUnsafeCassandraDeamon(boolean useUnsafeCassandraDaemon)
```
    Use an unsafe version of the Cassandra daemon. This version will:
    - disable JMX
    - disable legacy schema migration
    - disable pre-3.0 hints migration
    - disable pre-3.0 batch entries migration
    - disable auto compaction on all keyspaces. Your test/dev data should fit in memory normally
    - disable metrics
    - disable GCInspector
    - disable native mlock system call
    - disable Thrift server
    - disable startup checks (Jemalloc, validLaunchDate, JMXPorts, JvmOptions, JnaInitialization, initSigarLibrary, dataDirs, SSTablesFormat, SystemKeyspaceState, Datacenter, Rack)
    - disable materialized view rebuild. You should clean your data folder between each test anyway
    - disable the SizeEstimatesRecorder (estimate SSTable size, who cares for unit testing or dev ?)
    Returns:
  - buildNativeCluster
```
public Cluster buildNativeCluster()
```
    Start an embedded Cassandra server but DO NOT bootstrap Achilles
    
    Returns:
    
    native Java driver core Cluster
  - buildNativeSession
```
public Session buildNativeSession()
```
    Start an embedded Cassandra server but DO NOT bootstrap Achilles
    
    Returns:
    
    native Java driver core Session
  - buildServer
```
public CassandraEmbeddedServer buildServer()
```

Class CassandraEmbeddedServerBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

withListenAddress

withRpcAddress

withBroadcastAddress

withBroadcastRpcAddress

withShutdownHook

withDataFolder

withCommitLogFolder

withSavedCachesFolder

withHintsFolder

withCdcRawFolder

cleanDataFilesAtStartup

withClusterName

withKeyspaceName

withCQLPort

withConnectionProtocol

withJMXPort

withThriftPort

withStoragePort

withStorageSSLPort

withConcurrentReads

withConcurrentWrites

withDurableWrite

withScript

withScriptTemplate

withParams

useUnsafeCassandraDeamon

useUnsafeCassandraDeamon

buildNativeCluster

buildNativeSession

buildServer