Class MongoDbAccess
java.lang.Object
fr.gouv.vitam.common.database.server.mongodb.MongoDbAccess
- All Implemented Interfaces:
DatabaseConnection
- Direct Known Subclasses:
LogbookMongoDbAccessImpl,MongoDbAccessAdminImpl,MongoDbAccessMetadataImpl,SimpleMongoDBAccess
MongoDbAccess interface
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanCheck the connection of the databasevoidclose()Close database accessstatic com.mongodb.client.MongoClientcreateMongoClient(DbConfiguration configuration) Create a mongoDB client according to the configuration and using the MongoClientOptions specific to the sub-systems (ex: metadata,logbook)static com.mongodb.client.MongoClientcreateMongoClient(DbConfiguration configuration, List<Class<?>> classList) getInfo()Get information on a Databasecom.mongodb.client.MongoDatabasecom.mongodb.client.MongoClientstatic com.mongodb.MongoClientSettings.BuildergetMongoClientSettingsBuilder(Class<?>... classes) static com.mongodb.MongoClientSettings.BuildergetMongoClientSettingsBuilder(List<Class<?>> classList) com.mongodb.client.MongoDatabasevoidsetDatabase(String dbname) Change the target databasesetMongoAdmin(com.mongodb.client.MongoDatabase mongoAdmin) setMongoClient(com.mongodb.client.MongoClient mongoClient) setMongoDatabase(com.mongodb.client.MongoDatabase mongoDatabase)
-
Constructor Details
-
MongoDbAccess
- Parameters:
mongoClient- MongoClientdbname- MongoDB database name- Throws:
IllegalArgumentException- if mongoClient or dbname is null
-
-
Method Details
-
checkConnection
public boolean checkConnection()Description copied from interface:DatabaseConnectionCheck the connection of the database- Specified by:
checkConnectionin interfaceDatabaseConnection- Returns:
- True if the connection is active
-
getMongoClient
public com.mongodb.client.MongoClient getMongoClient()- Returns:
- MongoClient
-
setMongoClient
- Parameters:
mongoClient- MongoClient- Returns:
- MongoDbAccess
-
getMongoDatabase
public com.mongodb.client.MongoDatabase getMongoDatabase()- Returns:
- MongoDatabase
-
setMongoDatabase
- Parameters:
mongoDatabase- MongoDatabase- Returns:
- MongoDbAccess
-
getMongoAdmin
public com.mongodb.client.MongoDatabase getMongoAdmin()- Returns:
- MongoDatabase
-
setMongoAdmin
- Parameters:
mongoAdmin- MongoDatabase- Returns:
- MongoDbAccess
-
close
public void close()Close database access -
getInfo
Description copied from interface:DatabaseConnectionGet information on a Database- Specified by:
getInfoin interfaceDatabaseConnection- Returns:
- information on the database
-
createMongoClient
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)- Returns:
- the MongoClient
-
createMongoClient
public static com.mongodb.client.MongoClient createMongoClient(DbConfiguration configuration, List<Class<?>> classList) -
getMongoClientSettingsBuilder
public static com.mongodb.MongoClientSettings.Builder getMongoClientSettingsBuilder(Class<?>... classes) -
getMongoClientSettingsBuilder
-
setDatabase
Change the target database- Parameters:
dbname- Name of the target database
-