Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meltmedia/dropwizard-mongo

A Dropwizard bundle for MongoDB
https://github.com/meltmedia/dropwizard-mongo

dropwizard dropwizard-bundle java mongodb oplog rxjava

Last synced: 7 days ago
JSON representation

A Dropwizard bundle for MongoDB

Awesome Lists containing this project

README 

        
# Dropwizard Mongo



A Dropwizard bundle for MongoDB.



[![Build Status](https://travis-ci.org/meltmedia/dropwizard-mongo.svg)](https://travis-ci.org/meltmedia/dropwizard-mongo)



## Usage



### Maven



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



```



  com.meltmedia.dropwizard

  dropwizard-mongo

  0.5.0



```



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



```



    

        

        true

        

        sonatype-nexus-snapshots

        Sonatype Nexus Snapshots

        https://oss.sonatype.org/content/repositories/snapshots

    



```



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



```



  com.meltmedia.dropwizard

  dropwizard-mongo

  0.6.0-SNAPSHOT



```



### 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 mongoBundle;



@Override

public void initialize(Bootstrap bootstrap) {

  bootstrap.addBundle(mongoBundle = MongoBundle.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.



```



  io.reactivex.rxjava2

  rxjava

  2.0.4



```



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 mongoBundle;

RxOplogBundle oplogBundle;



@Override

public void initialize(Bootstrap bootstrap) {

  bootstrap.addBundle(mongoBundle = MongoBundle.builder()

    .withConfiguration(ExampleConfiguration::getMongo)

    .build());

  bootstrap.addBundle(oplogBundle = RxOplogBundle.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:



1. Make sure any outstanding stages are staged.  This will prevent the formatter from destroying your code.

2. Run `mvn format`, this will format the source and add any missing license headers.

3. 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.