fr.gouv.vitam.common.database.server.mongodb

Class MongoDbAccess

java.lang.Object

fr.gouv.vitam.common.database.server.mongodb.MongoDbAccess

All Implemented Interfaces:

DatabaseConnection

Direct Known Subclasses:

LogbookMongoDbAccessImpl, MongoDbAccessAdminImpl, MongoDbAccessMetadataImpl, SimpleMongoDBAccess

public abstract class MongoDbAccess
extends Object
implements DatabaseConnection

MongoDbAccess interface

Constructor Summary

Constructors

Constructor and Description
MongoDbAccess(com.mongodb.MongoClient mongoClient, String dbname, boolean recreate)

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection() Check the connection of the database
void	close() Close database access
static com.mongodb.MongoClient	createMongoClient(DbConfiguration configuration, com.mongodb.MongoClientOptions options) Create a mongoDB client according to the configuration and using the MongoClientOptions specific to the sub-systems (ex: metadata,logbook)
String	getInfo() Get information on a Database
com.mongodb.client.MongoDatabase	getMongoAdmin()
com.mongodb.MongoClient	getMongoClient()
com.mongodb.client.MongoDatabase	getMongoDatabase()
void	setDatabase(String dbname) Change the target database
MongoDbAccess	setMongoAdmin(com.mongodb.client.MongoDatabase mongoAdmin)
MongoDbAccess	setMongoClient(com.mongodb.MongoClient mongoClient)
MongoDbAccess	setMongoDatabase(com.mongodb.client.MongoDatabase mongoDatabase)

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDbAccess

public MongoDbAccess(com.mongodb.MongoClient mongoClient,
                     String dbname,
                     boolean recreate)

Parameters:

mongoClient - MongoClient

dbname - MongoDB database name

recreate - True to recreate the index

Throws:

IllegalArgumentException - if mongoClient or dbname is null

Method Detail

checkConnection

public boolean checkConnection()

Description copied from interface: DatabaseConnection

Check the connection of the database

Specified by:

checkConnection in interface DatabaseConnection

Returns:

True if the connection is active

getMongoClient

public com.mongodb.MongoClient getMongoClient()

Returns:

MongoClient

setMongoClient

public MongoDbAccess setMongoClient(com.mongodb.MongoClient mongoClient)

Parameters:

mongoClient - MongoClient

Returns:

MongoDbAccess

getMongoDatabase

public com.mongodb.client.MongoDatabase getMongoDatabase()

Returns:

MongoDatabase

setMongoDatabase

public MongoDbAccess setMongoDatabase(com.mongodb.client.MongoDatabase mongoDatabase)

Parameters:

mongoDatabase - MongoDatabase

Returns:

MongoDbAccess

getMongoAdmin

public com.mongodb.client.MongoDatabase getMongoAdmin()

Returns:

MongoDatabase

setMongoAdmin

public MongoDbAccess setMongoAdmin(com.mongodb.client.MongoDatabase mongoAdmin)

Parameters:

mongoAdmin - MongoDatabase

Returns:

MongoDbAccess

close

public void close()

Close database access

createMongoClient

public static com.mongodb.MongoClient createMongoClient(DbConfiguration configuration,
                                                        com.mongodb.MongoClientOptions options)

Create a mongoDB client according to the configuration and using the MongoClientOptions specific to the sub-systems (ex: metadata,logbook)

Parameters:

configuration - the configuration of mongo client (host/port to connect)

options - the option mongo client

Returns:

the MongoClient

getInfo

public String getInfo()

Description copied from interface: DatabaseConnection

Get information on a Database

Specified by:

getInfo in interface DatabaseConnection

Returns:

information on the database

setDatabase

public void setDatabase(String dbname)

Change the target database

Parameters:

dbname - Name of the target database