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

Class JdbcDatabaseManager

java.lang.Object

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

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

org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager

All Implemented Interfaces:

Flushable, AutoCloseable

public final class JdbcDatabaseManager
extends AbstractDatabaseManager

An AbstractDatabaseManager implementation for relational databases accessed via JDBC.

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

Modifier and Type	Method and Description
protected void	closeResources(boolean logExceptions)
protected boolean	commitAndClose() Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the connection pool).
protected void	connectAndStart() Connects to the database and starts a transaction (if applicable).
ConnectionSource	getConnectionSource()
static JdbcDatabaseManager	getJDBCDatabaseManager(String name, int bufferSize, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs) Deprecated. use getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
static JdbcDatabaseManager	getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings) Deprecated.
static JdbcDatabaseManager	getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis) Deprecated. use getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
static JdbcDatabaseManager	getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis, boolean truncateStrings) Creates a JDBC manager for use within the JdbcAppender, or returns a suitable one if it already exists.
String	getSqlStatement()
String	getTableName()
protected boolean	shutdownInternal() Implementations should implement this method to perform any proprietary disconnection / shutdown operations.
protected void	startupInternal() Implementations should implement this method to perform any proprietary startup operations.
protected void	writeInternal(LogEvent event, Serializable serializable) Performs the actual writing of the event in an implementation-specific way.
protected void	writeThrough(LogEvent event, Serializable serializable)

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

buffer, flush, getManager, isBuffered, isRunning, releaseSub, shutdown, startup, toString, write, write, writeInternal

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

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

Methods inherited from class java.lang.Object

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

Method Detail

getJDBCDatabaseManager

@Deprecated
public static JdbcDatabaseManager getJDBCDatabaseManager(String name,
                                                                     int bufferSize,
                                                                     ConnectionSource connectionSource,
                                                                     String tableName,
                                                                     ColumnConfig[] columnConfigs)

Deprecated. use getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)

Creates a JDBC manager for use within the JdbcAppender, 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.

connectionSource - The source for connections to the database.

tableName - The name of the database table to insert log events into.

columnConfigs - Configuration information about the log table columns.

Returns:

a new or existing JDBC manager as applicable.

getManager

@Deprecated
public static JdbcDatabaseManager getManager(String name,
                                                         int bufferSize,
                                                         Layout<? extends Serializable> layout,
                                                         ConnectionSource connectionSource,
                                                         String tableName,
                                                         ColumnConfig[] columnConfigs,
                                                         ColumnMapping[] columnMappings)

Deprecated.

Creates a JDBC manager for use within the JdbcAppender, 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.

layout - The Appender-level layout

connectionSource - The source for connections to the database.

tableName - The name of the database table to insert log events into.

columnConfigs - Configuration information about the log table columns.

columnMappings - column mapping configuration (including type conversion).

Returns:

a new or existing JDBC manager as applicable.

getManager

@Deprecated
public static JdbcDatabaseManager getManager(String name,
                                                         int bufferSize,
                                                         Layout<? extends Serializable> layout,
                                                         ConnectionSource connectionSource,
                                                         String tableName,
                                                         ColumnConfig[] columnConfigs,
                                                         ColumnMapping[] columnMappings,
                                                         boolean immediateFail,
                                                         long reconnectIntervalMillis)

Deprecated. use getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)

Creates a JDBC manager for use within the JdbcAppender, 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.

layout -

connectionSource - The source for connections to the database.

tableName - The name of the database table to insert log events into.

columnConfigs - Configuration information about the log table columns.

columnMappings - column mapping configuration (including type conversion).

reconnectIntervalMillis -

immediateFail -

Returns:

a new or existing JDBC manager as applicable.

getManager

public static JdbcDatabaseManager getManager(String name,
                                             int bufferSize,
                                             Layout<? extends Serializable> layout,
                                             ConnectionSource connectionSource,
                                             String tableName,
                                             ColumnConfig[] columnConfigs,
                                             ColumnMapping[] columnMappings,
                                             boolean immediateFail,
                                             long reconnectIntervalMillis,
                                             boolean truncateStrings)

Creates a JDBC manager for use within the JdbcAppender, 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.

layout - The Appender-level layout

connectionSource - The source for connections to the database.

tableName - The name of the database table to insert log events into.

columnConfigs - Configuration information about the log table columns.

columnMappings - column mapping configuration (including type conversion).

immediateFail - Whether or not to fail immediately with a AppenderLoggingException when connecting to JDBC fails.

reconnectIntervalMillis - How often to reconnect to the database when a SQL exception is detected.

truncateStrings - Whether or not to truncate strings to match column metadata.

Returns:

a new or existing JDBC manager as applicable.

closeResources

protected void closeResources(boolean logExceptions)

commitAndClose

protected boolean commitAndClose()

Description copied from class: AbstractDatabaseManager

Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the connection pool). With buffering enabled, this is called when flushing the buffer completes, after the last call to AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent). With buffering disabled, this is called immediately after every invocation of AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent).

Specified by:

commitAndClose in class AbstractDatabaseManager

Returns:

true if all resources were closed normally, false otherwise.

connectAndStart

protected void connectAndStart()

Description copied from class: AbstractDatabaseManager

Connects to the database and starts a transaction (if applicable). With buffering enabled, this is called when flushing the buffer begins, before the first call to AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent). With buffering disabled, this is called immediately before every invocation of AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent).

Specified by:

connectAndStart in class AbstractDatabaseManager

getConnectionSource

public ConnectionSource getConnectionSource()

getSqlStatement

public String getSqlStatement()

getTableName

public String getTableName()

shutdownInternal

protected boolean shutdownInternal()

Description copied from class: AbstractDatabaseManager

Implementations should implement this method to perform any proprietary disconnection / shutdown operations. This method will never be called twice on the same instance, and it will only be called after AbstractDatabaseManager.startupInternal(). It is safe to throw any exceptions from this method. This method does not necessarily disconnect from the database for the same reasons outlined in AbstractDatabaseManager.startupInternal().

Specified by:

shutdownInternal in class AbstractDatabaseManager

Returns:

true if all resources were closed normally, false otherwise.

startupInternal

protected void startupInternal()
                        throws Exception

Description copied from class: AbstractDatabaseManager

Implementations should implement this method to perform any proprietary startup operations. This method will never be called twice on the same instance. It is safe to throw any exceptions from this method. This method does not necessarily connect to the database, as it is generally unreliable to connect once and use the same connection for hours.

Specified by:

startupInternal in class AbstractDatabaseManager

Throws:

Exception

writeInternal

protected void writeInternal(LogEvent event,
                             Serializable serializable)

Description copied from class: AbstractDatabaseManager

Performs the actual writing of the event in an implementation-specific way. This method is called immediately from AbstractDatabaseManager.write(LogEvent, Serializable) if buffering is off, or from AbstractDatabaseManager.flush() if the buffer has reached its limit.

Specified by:

writeInternal in class AbstractDatabaseManager

Parameters:

event - The event to write to the database.

writeThrough

protected void writeThrough(LogEvent event,
                            Serializable serializable)

Overrides:

writeThrough in class AbstractDatabaseManager