org.apache.beam.it.mongodb

Class MongoDBResourceManager

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<MongoDBContainer>

org.apache.beam.it.mongodb.MongoDBResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public class MongoDBResourceManager
extends TestContainerResourceManager<MongoDBContainer>
implements org.apache.beam.it.common.ResourceManager

Client for managing MongoDB 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	MongoDBResourceManager.Builder Builder for MongoDBResourceManager.

Field Summary

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

HOST_IP, port

Method Summary

Modifier and Type	Method and Description
static MongoDBResourceManager.Builder	builder(java.lang.String testId)
void	cleanupAll() Deletes all created resources (VM's, etc.) and stops the container, making the manager object unusable.
long	countCollection(java.lang.String collectionName) Counts the number of Documents in a collection.
boolean	createCollection(java.lang.String collectionName) Creates a collection in MongoDB for storing Documents.
java.lang.String	getDatabaseName() Returns the name of the Database that this MongoDB manager will operate in.
java.lang.String	getUri() Returns the URI connection string to the MongoDB Database.
boolean	insertDocument(java.lang.String collectionName, org.bson.Document document) Inserts the given Document into a collection.
boolean	insertDocuments(java.lang.String collectionName, java.util.List<org.bson.Document> documents) Inserts the given Documents into a collection.
java.util.List<org.bson.Document>	readCollection(java.lang.String collectionName) 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 MongoDBResourceManager.Builder builder(java.lang.String testId)

getUri

public java.lang.String getUri()

Returns the URI connection string to the MongoDB Database.

getDatabaseName

public java.lang.String getDatabaseName()

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

Returns:

the name of the MongoDB Database.

createCollection

public boolean createCollection(java.lang.String collectionName)
                         throws MongoDBResourceManagerException

Creates a collection in MongoDB for storing Documents.

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

Parameters:

collectionName - Collection name to associate with the given MongoDB instance.

Returns:

A boolean indicating whether the resource was created.

Throws:

MongoDBResourceManagerException - if there is an error creating the collection in MongoDB.

insertDocument

public boolean insertDocument(java.lang.String collectionName,
                              org.bson.Document document)

Inserts the given Document into a collection.

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

Parameters:

collectionName - The name of the collection to insert the document into.

document - The document to insert into the collection.

Returns:

A boolean indicating whether the Document was inserted successfully.

insertDocuments

public boolean insertDocuments(java.lang.String collectionName,
                               java.util.List<org.bson.Document> documents)
                        throws MongoDBResourceManagerException

Inserts the given Documents into a collection.

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

Parameters:

collectionName - 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:

MongoDBResourceManagerException - if there is an error inserting the documents.

readCollection

public java.util.List<org.bson.Document> readCollection(java.lang.String collectionName)
                                                 throws MongoDBResourceManagerException

Reads all the Documents in a collection.

Parameters:

collectionName - The name of the collection to read from.

Returns:

A List of all the Documents in the collection.

Throws:

MongoDBResourceManagerException - if there is an error reading the collection.

countCollection

public long countCollection(java.lang.String collectionName)
                     throws MongoDBResourceManagerException

Counts the number of Documents in a collection.

Parameters:

collectionName - The name of the collection to read from.

Returns:

The number of Documents in the collection.

Throws:

MongoDBResourceManagerException - 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<MongoDBContainer>