org.jooby.mongodb

Class Mongodb

java.lang.Object

org.jooby.mongodb.Mongodb

All Implemented Interfaces:

Jooby.Module

public class Mongodb
extends Object
implements Jooby.Module

Exposes MongoClient and a DB.

usage

application.conf:

 db = "mongodb://localhost/mydb"
 

 {
   use(new Mongodb());

   get("/", req  -> {
     MongoClient client = req.require(MongoClient.class);
     // work with client
     DB = req.require(DB.class);
     // work with mydb
   });
 }
 

Default URI connection property is db but of course you can use any other name:

application.conf:

 mydb = "mongodb://localhost/mydb"
 

 {
   use(new Mongodb("mydb"));

   get("/", req  -> {
     DB mydb = req.require(DB.class);
     // work with mydb
   });
 }
 

options

Options can be set via .conf file:

 mongodb.connectionsPerHost  = 100
 

or programmatically:

 {
   use(new Mongodb()
     .options((options, config)  -> {
       options.connectionsPerHost(100);
     })
   );
 }
 

connection URI

Default connection URI is defined by the db property. Mongodb URI looks like:

   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database[.collection]][?options]]
 

For more detailed information please check: MongoClientURI.

two or more connections

Use named() when you need two or more mongodb connections:

 db1 = "mongodb://localhost/mydb1"
 db2 = "mongodb://localhost/mydb2"
 

 {
   use(new Mongodb("db1").named());
   use(new Mongodb("db2").named());

   get("/", req  -> {
     MongoClient client1 = req.require("mydb1", MongoClient.class);
     // work with mydb1
     MongoClient client2 = req.require("mydb2", MongoClient.class);
     // work with mydb1
   });
 }
 

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Mongodb() Creates a new Mongodb using the default property: db.
Mongodb(String db) Creates a new Mongodb module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
protected void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder, BiConsumer<com.mongodb.MongoClientURI,javax.inject.Provider<com.mongodb.MongoClient>> callback)
protected <T> com.google.inject.Key<T>	key(Class<T> type, String db)
Mongodb	named() Exposes services with Named annotation.
Mongodb	options(BiConsumer<com.mongodb.MongoClientOptions.Builder,com.typesafe.config.Config> options) Set an options callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mongodb

public Mongodb(String db)

Creates a new Mongodb module.

Parameters:

db - Name of the property with the connection URI.

Mongodb

public Mongodb()

Creates a new Mongodb using the default property: db.

Method Detail

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

configure

protected void configure(Env env,
                         com.typesafe.config.Config config,
                         com.google.inject.Binder binder,
                         BiConsumer<com.mongodb.MongoClientURI,javax.inject.Provider<com.mongodb.MongoClient>> callback)

named

public Mongodb named()

Exposes services with Named annotation.

Returns:

This module.

options

public Mongodb options(BiConsumer<com.mongodb.MongoClientOptions.Builder,com.typesafe.config.Config> options)

Set an options callback.

 {
   use(new Mongodb()
     .options((options, config)  -> {
       options.connectionsPerHost(100);
     })
   );
 }
 

Parameters:

options - Configure callback.

Returns:

This module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module

key

protected <T> com.google.inject.Key<T> key(Class<T> type,
                                           String db)