org.apache.logging.log4j.nosql.appender

Class NoSqlDatabaseManager<W>

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

org.apache.logging.log4j.nosql.appender.NoSqlDatabaseManager<W>

Type Parameters:

W - A type parameter for reassuring the compiler that all operations are using the same NoSqlObject.

All Implemented Interfaces:

Flushable, AutoCloseable

public final class NoSqlDatabaseManager<W>
extends AbstractDatabaseManager

An AbstractDatabaseManager implementation for all NoSQL databases.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

AbstractDatabaseManager.AbstractFactoryData

Field Summary

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager

count, LOGGER

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	commitAndClose()
protected void	connectAndStart()
static NoSqlDatabaseManager<?>	getNoSqlDatabaseManager(String name, int bufferSize, NoSqlProvider<?> provider) Creates a NoSQL manager for use within the NoSqlAppender, or returns a suitable one if it already exists.
protected boolean	shutdownInternal()
protected void	startupInternal()
protected void	writeInternal(LogEvent event)

Methods inherited from class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

flush, getManager, isRunning, releaseSub, shutdown, startup, toString, write

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager

close, getContentFormat, getCount, getLoggerContext, getName, hasManager, log, logDebug, logError, logWarn, release, stop, updateData

Methods inherited from class java.lang.Object

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

Method Detail

startupInternal

protected void startupInternal()

Specified by:

startupInternal in class AbstractDatabaseManager

shutdownInternal

protected boolean shutdownInternal()

Specified by:

shutdownInternal in class AbstractDatabaseManager

connectAndStart

protected void connectAndStart()

Specified by:

connectAndStart in class AbstractDatabaseManager

writeInternal

protected void writeInternal(LogEvent event)

Specified by:

writeInternal in class AbstractDatabaseManager

commitAndClose

protected boolean commitAndClose()

Specified by:

commitAndClose in class AbstractDatabaseManager

getNoSqlDatabaseManager

public static NoSqlDatabaseManager<?> getNoSqlDatabaseManager(String name,
                                              int bufferSize,
                                              NoSqlProvider<?> provider)

Creates a NoSQL manager for use within the NoSqlAppender, or returns a suitable one if it already exists.

Parameters:

name - The name of the manager, which should include connection details and hashed passwords where possible.

bufferSize - The size of the log event buffer.

provider - A provider instance which will be used to obtain connections to the chosen NoSQL database.

Returns:

a new or existing NoSQL manager as applicable.