Package com.barden.library.database.mongo

Class MongoProvider

java.lang.Object

com.barden.library.database.mongo.MongoProvider

public final class MongoProvider
extends Object

Mongo provider class.

Constructor Summary

Constructors

Constructor	Description
MongoProvider(String host, int port, String username, String password, String auth)	Create MongoDB connection and provider class with sync-driver

Method Summary

Modifier and Type	Method	Description
void	createIndex(String database, String collection, org.bson.conversions.Bson index, com.mongodb.client.model.IndexOptions options)	Creates index for collection.
String	getAuth()	Gets MongoDB auth type.
com.mongodb.client.MongoClient	getClient()	Gets MongoDB connected client.
com.mongodb.MongoClientSettings	getClientSettings()	Gets MongoDB client settings.
com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(String database, String collection)
<T> com.mongodb.client.MongoCollection<T>	getCollection(String database, String collection, Class<T> collectionType)	Gets collection.
com.mongodb.client.MongoDatabase	getDatabase(String database)	Gets database.
String	getHost()	Gets host.
String	getPassword()	Gets password.
int	getPort()	Gets port.
String	getUsername()	Gets username.
boolean	isInitialized()	Gets if MongoDB initialized or not.

Methods inherited from class java.lang.Object

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

Constructor Details

MongoProvider

public MongoProvider(@Nonnull
 String host,
 int port,
 @Nonnull
 String username,
 @Nonnull
 String password,
 @Nonnull
 String auth)

Create MongoDB connection and provider class with sync-driver

Parameters:

host - Host or IP address of MongoDB server.

port - Port address of MongoDB server.

username - (Optional) Username password.

password - (Optional) MongoDB password.

auth - (Optional) Auth type, it's mostly "admin".

Method Details

isInitialized

public boolean isInitialized()

Gets if MongoDB initialized or not.

Returns:

If MongoDB initialized or not.

getHost

@Nonnull
public String getHost()

Gets host.

Returns:

Host.

getPort

public int getPort()

Gets port.

Returns:

Port.

getUsername

@Nonnull
public String getUsername()

Gets username.

Returns:

Username.

getPassword

@Nonnull
public String getPassword()

Gets password.

Returns:

Password.

getAuth

@Nonnull
public String getAuth()

Gets MongoDB auth type. By default, it is "admin"

Returns:

Auth type.

getClient

@Nonnull
public com.mongodb.client.MongoClient getClient()

Gets MongoDB connected client.

Returns:

Client.

getClientSettings

@Nonnull
public com.mongodb.MongoClientSettings getClientSettings()

Gets MongoDB client settings.

Returns:

Client settings.

createIndex

public void createIndex(@Nonnull
 String database,
 @Nonnull
 String collection,
 @Nonnull
 org.bson.conversions.Bson index,
 @Nonnull
 com.mongodb.client.model.IndexOptions options)

Creates index for collection.

Parameters:

database - Database name.

collection - Collection name.

index - Index content.

options - Index options as IndexOptions class.

getDatabase

@Nullable
public com.mongodb.client.MongoDatabase getDatabase(@Nonnull
 String database)

Gets database.

Parameters:

database - Database name.

Returns:

Returns selected database as MongoDatabase.

getCollection

@Nullable
public com.mongodb.client.MongoCollection<org.bson.Document> getCollection(@Nonnull
 String database,
 @Nonnull
 String collection)

Parameters:

database - Database name.

collection - Collection name.

Returns:

Returns selected collection as MongoCollection.

getCollection

@Nullable
public <T> com.mongodb.client.MongoCollection<T> getCollection(@Nonnull
 String database,
 @Nonnull
 String collection,
 @Nonnull
 Class<T> collectionType)

Gets collection.

Type Parameters:

T - Collection object type.

Parameters:

database - Database name.

collection - Collection name.

collectionType - Collection type.

Returns:

Returns selected collection as MongoCollection.