org.apache.logging.log4j.nosql.appender.mongodb

Class MongoDbConnection

java.lang.Object

org.apache.logging.log4j.nosql.appender.mongodb.MongoDbConnection

All Implemented Interfaces:

Closeable, AutoCloseable, NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

public final class MongoDbConnection
extends Object
implements NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

The MongoDB implementation of NoSqlConnection.

Constructor Summary

Constructors

Constructor and Description
MongoDbConnection(com.mongodb.DB database, com.mongodb.WriteConcern writeConcern, String collectionName)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying connection.
MongoDbObject[]	createList(int length) Creates an array of the specified length typed to match the NoSqlObject implementation appropriate for this provider.
MongoDbObject	createObject() Instantiates and returns a NoSqlObject instance whose properties can be configured before ultimate insertion via NoSqlConnection.insertObject(NoSqlObject).
void	insertObject(NoSqlObject<com.mongodb.BasicDBObject> object) Inserts the given object into the underlying NoSQL database.
boolean	isClosed() Indicates whether the underlying connection is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDbConnection

public MongoDbConnection(com.mongodb.DB database,
                         com.mongodb.WriteConcern writeConcern,
                         String collectionName)

Method Detail

createObject

public MongoDbObject createObject()

Description copied from interface: NoSqlConnection

Instantiates and returns a NoSqlObject instance whose properties can be configured before ultimate insertion via NoSqlConnection.insertObject(NoSqlObject).

Specified by:

createObject in interface NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

Returns:

a new object.

See Also:

NoSqlObject

createList

public MongoDbObject[] createList(int length)

Description copied from interface: NoSqlConnection

Creates an array of the specified length typed to match the NoSqlObject implementation appropriate for this provider.

Specified by:

createList in interface NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

Parameters:

length - the length of the array to create.

Returns:

a new array.

See Also:

NoSqlObject

insertObject

public void insertObject(NoSqlObject<com.mongodb.BasicDBObject> object)

Description copied from interface: NoSqlConnection

Inserts the given object into the underlying NoSQL database.

Specified by:

insertObject in interface NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

Parameters:

object - The object to insert.

close

public void close()

Description copied from interface: NoSqlConnection

Closes the underlying connection. This method call should be idempotent. Only the first call should have any effect; all further calls should be ignored. It's possible the underlying connection is stateless (such as an HTTP web service), in which case this method would be a no-op. This method should also commit any open transactions, if applicable and if not already committed.

If this connection is part of a connection pool, executing this method should commit the transaction and return the connection to the pool, but it should not actually close the underlying connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

isClosed

public boolean isClosed()

Description copied from interface: NoSqlConnection

Indicates whether the underlying connection is closed. If the underlying connection is stateless (such as an HTTP web service), this method would likely always return true. Essentially, this method should only return true if a call to NoSqlConnection.insertObject(NoSqlObject) will fail due to the state of this object.

Specified by:

isClosed in interface NoSqlConnection<com.mongodb.BasicDBObject,MongoDbObject>

Returns:

true if this object is considered closed.