Dropwizard Mongo

A Dropwizard bundle for MongoDB.

Usage

Maven

Releases of this project are available on Maven Central. You can include the project with this dependency:

<dependency>
  <groupId>com.meltmedia.dropwizard</groupId>
  <artifactId>dropwizard-mongo</artifactId>
  <version>0.5.0</version>
</dependency>

To use SNAPSHOTs of this project, you will need to include the sonatype repository in your POM.

<repositories>
    <repository>
        <snapshots>
        <enabled>true</enabled>
        </snapshots>
        <id>sonatype-nexus-snapshots</id>
        <name>Sonatype Nexus Snapshots</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    </repository>
</repositories>

You will also need to include the project in your dependencies.

<dependency>
  <groupId>com.meltmedia.dropwizard</groupId>
  <artifactId>dropwizard-mongo</artifactId>
  <version>0.6.0-SNAPSHOT</version>
</dependency>

Java

Define the MongoConfiguration class somewhere in your applications configuration.

import com.meltmedia.dropwizard.mongo.MongoConfiguration;

...

  @JsonProperty
  protected MongoConfiguration mongo;

  public MongoConfiguration getMongo() {
    return mongo;
  }

Then include the bundle in the initialize method of your application.

import com.meltmedia.dropwizard.mongo.MongoBundle;

...
MongoBundle<ExampleConfiguration> mongoBundle;

@Override
public void initialize(Bootstrap<ExampleConfiguration> bootstrap) {
  bootstrap.addBundle(mongoBundle = MongoBundle.<ExampleConfiguration>builder()
    .withConfiguration(ExampleConfiguration::getMongo)
    .build());
}

Finally, use the bundle to access the client and database in your run method.

@Override
public void run(ExampleConfiguration config, Environment env) throws Exception {
  MongoClient client = mongoBundle.getClient();
  DB db = mongoBundle.getDB();
  // do something cool.
}

Configuration

Add the mongo configuraiton block to your applications config.

mongo:
  seeds:
  - host: localhost
    port: 27017
  database: example
  credentials:
    userName: example
    password: example

RxJava2 Oplog Service

Starting with version 0.4.0, this service provides an oplog watching service. It provides a hot, sharable observable, suitable for restarting processors on collection changes.

To use the service, include the JavaRx2 dependency.

<dependency>
  <groupId>io.reactivex.rxjava2</groupId>
  <artifactId>rxjava</artifactId>
  <version>2.0.4</version>
</dependency>

Then include the bundle in the initialize method of your application, after the bundle for the client.

import com.meltmedia.dropwizard.mongo.MongoBundle;
import com.meltmedia.dropwizard.mongo.rxoplog.RxOplogBundle;

...
MongoBundle<ExampleConfiguration> mongoBundle;
RxOplogBundle<ExampleConfiguration> oplogBundle;

@Override
public void initialize(Bootstrap<ExampleConfiguration> bootstrap) {
  bootstrap.addBundle(mongoBundle = MongoBundle.<ExampleConfiguration>builder()
    .withConfiguration(ExampleConfiguration::getMongo)
    .build());
  bootstrap.addBundle(oplogBundle = RxOplogBundle.<ExampleConfiguration>builder()
    .with(config->serviceBuilder->serviceBuilder
      .withMongoClient(mongoBundle::getClient)
      .matchDatabase(config.getMongo().getDatabase()))
    .build());
}

Then you can access the service in the run method.

@Override
public void run(ExampleConfiguration config, Environment env) throws Exception {
  RxOplogService oplog = oplogBundle.getOplogService();
  
  env.lifecycle().manage(new Managed() {
    Disposable disposable;
    @Override
    public void start() throws Exception {
      disposable = oplogBundle.getOplogService()
        .getOplog()
        .forEach(doc->{
          // do something cool
        });
    }

    @Override
    public void stop() throws Exception {
      if( disposable != null ) disposable.dispose();
    }
  });
}

Building

This project builds with Java8 and Maven 3. After cloning the repo, install the bundle from the root of the project.

mvn clean install

Integration Tests

You can also run integration tests while running the build. First, you will need to make sure the configuration passphrase is in the environment.

export EXAMPLE_PASSPHRASE='correct horse battery staple'

Second you need to install vagrant in version 1.5 and above.

Then run the build with the integration-tests profile.

mvn clean install -P integration-tests

Contributing

This project accepts PRs, so feel free to fork the project and send contributions back.

Formatting

This project contains formatters to help keep the code base consistent. The formatter will update Java source files and add headers to other files. When running the formatter, I suggest the following procedure:

Make sure any outstanding stages are staged. This will prevent the formatter from destroying your code.
Run mvn format, this will format the source and add any missing license headers.
If the changes look good and the project still compiles, add the formatting changes to your staged code.

If things go wrong, you can run git checkout -- . to drop the formatting changes.

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

meltmedia / dropwizard-mongo

Programming Languages

Labels

Projects that are alternatives of or similar to dropwizard-mongo