org.alfresco.bm.common.mongo

Class MongoClientFactory

java.lang.Object

org.alfresco.bm.common.mongo.MongoClientFactory

All Implemented Interfaces:

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

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

A Spring-friendly, singleton factory of MongoClient instances. The client will be closed by the factory 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.

It is really simple to create mongo instances and we need control over the location of usernames/password combinations i.e. in most circumstances we don't want to put sensitive information in the URL. The ability to fetch a database by name is therefore not an option.

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
MongoClientFactory(com.mongodb.MongoClientURI mongoClientURI, String username, String password) Create an instance of the factory.

Method Summary

Modifier and Type	Method and Description
void	destroy()
com.mongodb.MongoClient	getObject() Get the Mongo client that this instance holds
Class<?>	getObjectType()
boolean	isSingleton()
static String	toStringSafe(com.mongodb.MongoClientURI mongoClientURI) Create a string that masks the username password from the uri

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoClientFactory

public MongoClientFactory(com.mongodb.MongoClientURI mongoClientURI,
                          String username,
                          String password)

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:

mongoClientURI - the client URI, which must not reference a database, username or password

username - the username to use when connecting (null allowed and empty string is ignored)

password - the user password for the database (null allowed and empty string is ignored)

Throws:

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

Method Detail

toStringSafe

public static String toStringSafe(com.mongodb.MongoClientURI mongoClientURI)

Create a string that masks the username password from the uri

Parameters:

mongoClientURI - a mongo client URI

Returns:

a string that masks the username password

getObject

public com.mongodb.MongoClient getObject()

Get the Mongo client that this instance holds

Specified by:

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

Returns:

the same MongoClient instance

getObjectType

public Class<?> getObjectType()

Specified by:

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

isSingleton

public boolean isSingleton()

Specified by:

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

destroy

public void destroy()

Specified by:

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