Package 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 org.apache.logging.log4j.core.appender.db.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

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

Field Summary

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

count, LOGGER

Method Summary

Modifier and Type	Method	Description
protected void	closeResources(boolean logExceptions)
protected boolean	commitAndClose()
protected void	connectAndStart()
org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource	getConnectionSource()
static JdbcDatabaseManager	getJDBCDatabaseManager(String name, int bufferSize, org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource, String tableName, org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs)	Deprecated. use getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
static JdbcDatabaseManager	getManager(String name, int bufferSize, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource, String tableName, org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs, org.apache.logging.log4j.core.appender.db.ColumnMapping[] columnMappings)	Deprecated.
static JdbcDatabaseManager	getManager(String name, int bufferSize, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource, String tableName, org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs, org.apache.logging.log4j.core.appender.db.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, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource, String tableName, org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs, org.apache.logging.log4j.core.appender.db.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()
protected void	startupInternal()
protected void	writeInternal(org.apache.logging.log4j.core.LogEvent event, Serializable serializable)
protected void	writeThrough(org.apache.logging.log4j.core.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, getManager, getName, getStrSubstitutor, 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,
                                                         org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource,
                                                         String tableName,
                                                         org.apache.logging.log4j.core.appender.db.jdbc.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,
                                             org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource,
                                             String tableName,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs,
                                             org.apache.logging.log4j.core.appender.db.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,
                                             org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource,
                                             String tableName,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs,
                                             org.apache.logging.log4j.core.appender.db.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 - 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).

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

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

Returns:

a new or existing JDBC manager as applicable.

getManager

public static JdbcDatabaseManager getManager(String name,
                                             int bufferSize,
                                             org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource connectionSource,
                                             String tableName,
                                             org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[] columnConfigs,
                                             org.apache.logging.log4j.core.appender.db.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()

Specified by:

commitAndClose in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

connectAndStart

protected void connectAndStart()

Specified by:

connectAndStart in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

getConnectionSource

public org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource getConnectionSource()

getSqlStatement

public String getSqlStatement()

getTableName

public String getTableName()

shutdownInternal

protected boolean shutdownInternal()

Specified by:

shutdownInternal in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

startupInternal

protected void startupInternal()
                        throws Exception

Specified by:

startupInternal in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

Throws:

Exception

writeInternal

protected void writeInternal(org.apache.logging.log4j.core.LogEvent event,
                             Serializable serializable)

Specified by:

writeInternal in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager

writeThrough

protected void writeThrough(org.apache.logging.log4j.core.LogEvent event,
                            Serializable serializable)

Overrides:

writeThrough in class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager