org.apache.beam.it.cassandra

Class CassandraResourceManager

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<GenericContainer<?>>

org.apache.beam.it.cassandra.CassandraResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public class CassandraResourceManager
extends TestContainerResourceManager<GenericContainer<?>>
implements org.apache.beam.it.common.ResourceManager

Client for managing Cassandra resources.

The class supports one database and multiple collections per database object. A database is created when the first collection is created if one has not been created already.

The database name is formed using testId. The database name will be "{testId}-{ISO8601 time, microsecond precision}", with additional formatting.

The class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CassandraResourceManager.Builder Builder for CassandraResourceManager.

Field Summary

Fields inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

HOST_IP, port

Method Summary

Modifier and Type	Method and Description
static CassandraResourceManager.Builder	builder(java.lang.String testId)
void	cleanupAll() Deletes all created resources (VM's, etc.) and stops the container, making the manager object unusable.
com.datastax.oss.driver.api.core.cql.ResultSet	executeStatement(java.lang.String statement) Execute the given statement on the managed keyspace.
java.lang.String	getKeyspaceName() Returns the name of the Database that this Cassandra manager will operate in.
int	getPort() Returns the port to connect to the Cassandra Database.
boolean	insertDocument(java.lang.String tableName, java.util.Map<java.lang.String,java.lang.Object> document) Inserts the given Document into a table.
boolean	insertDocuments(java.lang.String tableName, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> documents) Inserts the given Documents into a collection.
java.lang.Iterable<com.datastax.oss.driver.api.core.cql.Row>	readTable(java.lang.String tableName) Reads all the Documents in a collection.

Methods inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

getDockerImageName, getHost, getPort

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CassandraResourceManager.Builder builder(java.lang.String testId)

getPort

public int getPort()

Returns the port to connect to the Cassandra Database.

getKeyspaceName

public java.lang.String getKeyspaceName()

Returns the name of the Database that this Cassandra manager will operate in.

Returns:

the name of the Cassandra Database.

executeStatement

public com.datastax.oss.driver.api.core.cql.ResultSet executeStatement(java.lang.String statement)

Execute the given statement on the managed keyspace.

Parameters:

statement - The statement to execute.

Returns:

ResultSet from Cassandra.

insertDocument

public boolean insertDocument(java.lang.String tableName,
                              java.util.Map<java.lang.String,java.lang.Object> document)

Inserts the given Document into a table.

A database will be created here, if one does not already exist.

Parameters:

tableName - The name of the table to insert the document into.

document - The document to insert into the table.

Returns:

A boolean indicating whether the Document was inserted successfully.

insertDocuments

public boolean insertDocuments(java.lang.String tableName,
                               java.util.List<java.util.Map<java.lang.String,java.lang.Object>> documents)
                        throws CassandraResourceManagerException

Inserts the given Documents into a collection.

Note: Implementations may do collection creation here, if one does not already exist.

Parameters:

tableName - The name of the collection to insert the documents into.

documents - A list of documents to insert into the collection.

Returns:

A boolean indicating whether the Documents were inserted successfully.

Throws:

CassandraResourceManagerException - if there is an error inserting the documents.

readTable

public java.lang.Iterable<com.datastax.oss.driver.api.core.cql.Row> readTable(java.lang.String tableName)
                                                                       throws CassandraResourceManagerException

Reads all the Documents in a collection.

Parameters:

tableName - The name of the collection to read from.

Returns:

An iterable of all the Documents in the collection.

Throws:

CassandraResourceManagerException - if there is an error reading the collection.

cleanupAll

public void cleanupAll()

Description copied from class: TestContainerResourceManager

Deletes all created resources (VM's, etc.) and stops the container, making the manager object unusable.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager

Overrides:

cleanupAll in class TestContainerResourceManager<GenericContainer<?>>