cz.jirutka.spring.embedmongo

Class EmbeddedMongoBuilder

java.lang.Object

cz.jirutka.spring.embedmongo.EmbeddedMongoBuilder

public class EmbeddedMongoBuilder
extends Object

A convenient builder for EmbedMongo that builds MongodStarter and MongodExecutable with Slf4j as a logger (instead of JUL), then starts "embedded" MongoDB and exposes preconfigured instance of MongoClient. Due to Slf4j you use any logging implementation you want.

To tweak logging levels use these classes as logger names:

• de.flapdoodle.embed.mongo.MongodProcess
• de.flapdoodle.embed.process.store.Downloader
• cz.jirutka.spring.embedmongo.EmbeddedMongoFactoryBean

EmbedMongo runs MongoDB as a managed process. It is not truly embedded Mongo as there's no Java implementation of the MongoDB. EmbedMongo actually downloads an original MongoDB binary for your platform and executes it. The EmbedMongo process is stopped automatically when you close connection with Mongo.

Since:

1.2

Author:

Jakub Jirutka

See Also:

embedmongo.flapdoodle.de

Constructor Summary

Constructors

Constructor and Description
EmbeddedMongoBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
EmbeddedMongoBuilder	bindIp(String bindIp) An IPv4 or IPv6 address for the MongoDB instance to be bound to during its execution.
com.mongodb.MongoClient	build() Builds MongodStarter, then starts "embedded" MongoDB instance and returns initialized MongoClient.
EmbeddedMongoBuilder	port(int port) The port MongoDB should run on.
EmbeddedMongoBuilder	version(String version) The version of MongoDB to run e.g.
EmbeddedMongoBuilder	version(de.flapdoodle.embed.mongo.distribution.Version version) The version of MongoDB to run.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedMongoBuilder

public EmbeddedMongoBuilder()

Method Detail

build

public com.mongodb.MongoClient build()
                              throws IOException

Builds MongodStarter, then starts "embedded" MongoDB instance and returns initialized MongoClient.

You should invoke Mongo.close() after job is done to close the client and stop the MongoDB instance.

Returns:

A fully initialized {@code MongoClient).

Throws:

IOException

version

public EmbeddedMongoBuilder version(de.flapdoodle.embed.mongo.distribution.Version version)

The version of MongoDB to run. When no version is provided, then PRODUCTION is used by default. The value must not be null.

version

public EmbeddedMongoBuilder version(String version)

The version of MongoDB to run e.g. 2.1.1, 1.6 v1.8.2, V2_0_4. When no version is provided, then PRODUCTION is used by default. The value must not be empty.

port

public EmbeddedMongoBuilder port(int port)

The port MongoDB should run on. When no port is provided, then some free server port is automatically assigned. The value must be between 0 and 65535.

bindIp

public EmbeddedMongoBuilder bindIp(String bindIp)

An IPv4 or IPv6 address for the MongoDB instance to be bound to during its execution. Default is a loopback address. The value must not be empty.