org.jooby.mongodb

Class Monphia

java.lang.Object

org.jooby.mongodb.Mongodb

org.jooby.mongodb.Monphia

All Implemented Interfaces:

org.jooby.Jooby.Module

public class Monphia
extends Mongodb

Extends Mongodb with object-document mapping via Morphia. Exposes Morphia and Datastore services.

usage

application.conf:

 db = "mongodb://localhost/mydb"
 

 {
   use(new Monphia());

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

options

morphia callback

The Morphia callback let you map classes and/or set mapper options.

 {
   use(new Monphia()
     .doWith((morphia, config)  -> {
       // work with morphia
       morphia.map(MyObject.class);
     });
   );
 }
 

For more detailed information, check here

datastore callback

This Datastore callback is executed only once, it's perfect for checking indexes:

 {
   use(new Monphia()
     .doWith(datastore  -> {
       // work with datastore
       datastore.ensureIndexes();
       datastore.ensureCap();
     });
   );
 }
 

For more detailed information, check here

auto-incremental ID

This modules comes with auto-incremental ID generation.

usage:

 {
   use(new Monphia().with(IdGen.GLOBAL); // or IdGen.LOCAL
 }
 

ID must be of type: Long and annotated with GeneratedValue:

 @Entity
 public class MyEntity {
   @Id @GeneratedValue Long id;
 }
 

There two ID gen:

• GLOBAL: generates a global and unique ID regardless of entity type.
• LOCAL: generates an unique ID per entity type.

entity listeners

Guice will create and inject entity listeners (when need it).

 public class MyListener {

   private Service service;

   @Inject
   public MyListener(Service service) {
     this.service = service;
   }

   @PreLoad void preLoad(MyObject object) {
     service.doSomething(object);
   }

 }
 

NOTE: ONLY Constructor injection is supported.

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	configure(org.jooby.Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)
Monphia	doWith(BiConsumer<org.mongodb.morphia.Morphia,com.typesafe.config.Config> callback) Morphia startup callback, from here you can map classes, set mapper options, etc..
Monphia	doWith(Consumer<org.mongodb.morphia.Datastore> callback) Datastore startup callback, from here you can call Datastore.ensureIndexes().
Monphia	with(IdGen gen) Setup up an EntityInterceptor on PrePersist events that generates an incremental ID.

Methods inherited from class org.jooby.mongodb.Mongodb

config, configure, options

Methods inherited from class java.lang.Object

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

Constructor Detail

Monphia

public Monphia(String db)

Creates a new Monphia module.

Parameters:

db - Name of the property with the connection URI.

Monphia

public Monphia()

Creates a new Monphia using the default property: db.

Method Detail

doWith

public Monphia doWith(BiConsumer<org.mongodb.morphia.Morphia,com.typesafe.config.Config> callback)

Morphia startup callback, from here you can map classes, set mapper options, etc..

Parameters:

callback - Morphia callback.

Returns:

This module.

doWith

public Monphia doWith(Consumer<org.mongodb.morphia.Datastore> callback)

Datastore startup callback, from here you can call Datastore.ensureIndexes().

Parameters:

callback - Datastore callback.

Returns:

This module.

with

public Monphia with(IdGen gen)

Setup up an EntityInterceptor on PrePersist events that generates an incremental ID.

Usage:

 {
   use(new Monphia().with(IdGen.GLOBAL);
 }
 

ID must be of type: Long and annotated with GeneratedValue:

 @Entity
 public class MyEntity {
   @Id @GeneratedValue Long id;
 }
 

Parameters:

gen - an IdGen strategy

Returns:

This module.

configure

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

Specified by:

configure in interface org.jooby.Jooby.Module

Overrides:

configure in class Mongodb