me.lucko.helper.mongo

Interface MongoProvider

All Known Implementing Classes:

MongoPlugin

public interface MongoProvider

Provides HelperMongo instances.

Method Summary

Modifier and Type	Method and Description
HelperMongo	getDataSource() Gets the global datasource.
HelperMongo	getDataSource(MongoDatabaseCredentials credentials) Constructs a new datasource using the given credentials.
MongoDatabaseCredentials	getGlobalCredentials() Gets the global database credentials being used for the global datasource.

Method Detail

getDataSource

@Nonnull
HelperMongo getDataSource()

Gets the global datasource.

Returns:

the global datasource.

getDataSource

@Nonnull
HelperMongo getDataSource(@Nonnull
                                    MongoDatabaseCredentials credentials)

Constructs a new datasource using the given credentials.

These instances are not cached, and a new datasource is created each time this method is called.

Parameters:

credentials - the credentials for the database

Returns:

a new datasource

getGlobalCredentials

@Nonnull
MongoDatabaseCredentials getGlobalCredentials()

Gets the global database credentials being used for the global datasource.

Returns:

the global credentials