washingtonpost/dropwizard-mongo-module

Name: dropwizard-mongo-module

Owner: The Washington Post

Description: A guice module for connecting a Dropwizard app to a Mongo DB cluster

Created: 2015-08-25 13:18:41.0

Updated: 2017-06-22 21:11:06.0

Pushed: 2016-11-30 15:25:47.0

Homepage: https://github.com/washingtonpost/dropwizard-mongo-module

Size: 32

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

dropwizard-mongo-module

A guice module for connecting a Dropwizard app to a Mongo DB cluster

This JAR is loosely based off of https://github.com/eeb/dropwizard-mongo, but re-written to support guice integration and to use Mongo URI connection strings.

Usage

This module assumes you are including it in a Dropwizard 0.8.1+ application with dropwizard-guice wiring.

Include as a maven dependency:

endency>
<groupId>com.washingtonpost.dropwizard</groupId>
<artifactId>dropwizard-mongo</artifactId>
<version>${version.wp.dropwizard.mongo}</version>
pendency>

NOTE: this JAR assumes the composing application will provide a compatible version of com.hubspot.dropwizard.dropwizard-guice and a compatible version of org.mongodb.mongo-java-driver.

In your application's main initialize() method, add a new MongoBundle to your guice bundle, for example:

rt com.hubspot.dropwizard.guice.GuiceBundle;
rt com.washingtonpost.mongo.dropwizard.MongoModule;

ic class MyApplication extends Application<MyConfiguration> {

@Override
public void initialize(Bootstrap<MyConfiguration> bootstrap) {
    guiceBundle = GuiceBundle.<MyConfiguration>newBuilder()
            .addModule(new MongoModule())
            .enableAutoConfig("com.washingtonpost")
            .setConfigClass(MyConfiguration.class)
            .build();

Add configuration to your application's configuration class, like:

rt com.washingtonpost.mongo.dropwizard.MongoFactory;

ic class MyConfiguration extends Configuration {

private MongoFactory mongoFactory = new MongoFactory();

@JsonProperty("mongoDB")
public MongoFactory getMongoFactory() {
    return this.mongoFactory;
}

@JsonProperty("mongoDB")
public void setMongoFactory(MongoFactory mongoFactory) {
    this.mongoFactory = mongoFactory;
}

Add reasonable configuration options to your application YML file:

oDB:
user: ${MONGO_USER}
pass: ${MONGO_PASS}
hosts: ${MONGO_HOSTS}
dbName: ${MONGO_DBNAME}
options: ${MONGO_OPTIONS}

And finally make sure your Guice wiring “provides” the MongoFactory as a bean (it's needed by name “mongoFactory” in the MongoModule that you wired into your Guice bundle):

rt com.google.inject.AbstractModule;
rt com.google.inject.Provides;
rt com.washingtonpost.mongo.dropwizard.MongoFactory;
rt javax.inject.Named;

ic class MyModule extends AbstractModule {

@Override
protected void configure() {
}

@Provides
@Named("mongoFactory")
public MongoFactory provideMongoFactory(MyConfiguration configuration) {
    return configuration.getMongoFactory();
}

Runtime DB Connections

If you don't know ahead of time what the name of your DB is going to be, you can create a DB object at runtime with the alternative method signature on the MongoFactory:

MongoFactory factory = new MongoFactory();
factory.setHosts("localhost");
DB db = factory.buildDB("bar");

Configuration

The Mongo configuration options map directly to the different parts of an allowed com.mongo.MongoClientURI, per the scheme defined here [http://docs.mongodb.org/manual/reference/connection-string/]

e.g. mongodb://[user:pass@][mongo_hosts,like:123,this:456][/[dbName][?options]]

oDB:
user: // the username to connect to any & all hosts defined in hosts, optional, but required if pass is provided
pass: // the password associated with the username.  Optional, but required if user is provided
hosts: // at least one, but possibly many comma-separated, host:port pairs hosting Mongo DBs.
dbName: // optional name of the DB Collection to initially connect to when requesting MongoModule.provideDB
options: // optional connection configuration parameters for the Mongo driver
disabled: // optional boolean that will cause the Module to provide non-null, but non-functional DB/MongoClient objects