org.alfresco.bm.common.mongo

Class MongoDBFactory

java.lang.Object

org.alfresco.bm.common.mongo.MongoDBFactory

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<com.mongodb.DB>

public class MongoDBFactory
extends Object
implements org.springframework.beans.factory.FactoryBean<com.mongodb.DB>, org.springframework.beans.factory.DisposableBean

A Spring-friendly, singleton factory of DB instances. Client code should retrieve the DB instance and keep hold of it. The DB instance will be closed by this factory when the Spring context shuts down.

The use of the Spring FactoryBean means that we can use an instance of this to inject DB instances into the DAO layers directly.

Since:

2.0

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
MongoDBFactory(com.mongodb.MongoClient mongoClient, String database) Create an instance of the factory.

Method Summary

Modifier and Type	Method and Description
void	destroy()
com.mongodb.DB	getObject() Get the database that this instance is produces.
Class<?>	getObjectType()
boolean	isSingleton()

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDBFactory

public MongoDBFactory(com.mongodb.MongoClient mongoClient,
                      String database)

Create an instance of the factory. The URI given must not contain a database name or user/password details. This forces the client URI to be an instance that can be shared between instances of this factory.

Parameters:

mongoClient - the mongo client

database - the database to connect to (never null)

Throws:

IllegalArgumentException - if the arguments are null when not allowed or contain invalid information

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

getObject

public com.mongodb.DB getObject()

Get the database that this instance is produces. The calling code need not shut down the database as it will be done by the factory.

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<com.mongodb.DB>

Returns:

a singleton DB instance

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<com.mongodb.DB>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<com.mongodb.DB>