Package org.apache.logging.log4j.mongodb3

Class MongoDbProvider

java.lang.Object

org.apache.logging.log4j.mongodb3.MongoDbProvider

All Implemented Interfaces:

NoSqlProvider<MongoDbConnection>

@Plugin(name="MongoDb3",
        category="Core",
        printObject=true)
public final class MongoDbProvider
extends Object
implements NoSqlProvider<MongoDbConnection>

The MongoDB implementation of NoSqlProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoDbProvider.Builder<B extends MongoDbProvider.Builder<B>>

Method Summary

Modifier and Type	Method	Description
MongoDbConnection	getConnection()	Obtains a connection from this provider.
static <B extends MongoDbProvider.Builder<B>> B	newBuilder()
String	toString()	All implementations must override Object.toString() to provide information about the provider configuration (obscuring passwords with one-way hashes).

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

@PluginBuilderFactory
public static <B extends MongoDbProvider.Builder<B>> B newBuilder()

getConnection

public MongoDbConnection getConnection()

Description copied from interface: NoSqlProvider

Obtains a connection from this provider. The concept of a connection in this case is not strictly an active duplex UDP or TCP connection to the underlying database. It can be thought of more as a gateway, a path for inserting objects that may use a persistent connection or may use HTTP web service calls, etc.

Where applicable, this method should return a connection from the connection pool as opposed to opening a brand new connection every time.

Specified by:

getConnection in interface NoSqlProvider<MongoDbConnection>

Returns:

a connection that can be used to create and persist objects to this database.

See Also:

NoSqlConnection

toString

public String toString()

Description copied from interface: NoSqlProvider

All implementations must override Object.toString() to provide information about the provider configuration (obscuring passwords with one-way hashes).

Specified by:

toString in interface NoSqlProvider<MongoDbConnection>

Overrides:

toString in class Object

Returns:

the string representation of this NoSQL provider.