me.lucko.helper.mongo

Interface MongoProvider

All Known Implementing Classes:

HelperMongoPlugin

public interface MongoProvider

Provides Mongo instances.

Method Summary

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

Method Detail

getMongo

@Nonnull
Mongo getMongo()

Gets the global datasource.

Returns:

the global datasource.

getMongo

@Nonnull
Mongo getMongo(@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