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
An
AbstractDatabaseManager
implementation for relational databases accessed via JDBC.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
Encapsulates data thatJdbcDatabaseManager.JdbcDatabaseManagerFactory
uses to create managers.private static final class
Creates managers.private final class
Handles reconnecting to JDBC once on a Thread.private static final class
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager
AbstractDatabaseManager.AbstractFactoryData
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List<ColumnConfig>
private Connection
private final JdbcDatabaseManager.FactoryData
private static final JdbcDatabaseManager.JdbcDatabaseManagerFactory
private boolean
private JdbcDatabaseManager.Reconnector
private final String
private PreparedStatement
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager
count, LOGGER
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
JdbcDatabaseManager
(String name, String sqlStatement, List<ColumnConfig> columnConfigs, JdbcDatabaseManager.FactoryData factoryData) -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
appendColumnName
(int i, String columnName, StringBuilder sb) private static void
appendColumnNames
(String sqlVerb, JdbcDatabaseManager.FactoryData data, StringBuilder sb) Appends column names to the given buffer in the format"A,B,C"
.private void
protected void
closeResources
(boolean logExceptions) protected boolean
Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the connection pool).private boolean
private void
protected void
Connects to the database and starts a transaction (if applicable).private JdbcDatabaseManager.Reconnector
private String
private String
private static JdbcDatabaseManager.JdbcDatabaseManagerFactory
static JdbcDatabaseManager
getJDBCDatabaseManager
(String name, int bufferSize, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs) Deprecated.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) 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 theJdbcAppender
, or returns a suitable one if it already exists.private void
private boolean
isClosed
(Connection connection) Checks if a connection is closed.private boolean
Checks if a statement is closed.private void
reconnectOn
(Exception exception) private void
setFields
(MapMessage<?, ?> mapMessage) private void
setStatementObject
(int j, String nameKey, Object value) Sets the given Object in the prepared statement.protected boolean
Implementations should implement this method to perform any proprietary disconnection / shutdown operations.protected void
Implementations should implement this method to perform any proprietary startup operations.private Object
Truncates the value if needed.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, getManager, getName, getStrSubstitutor, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData
-
Field Details
-
INSTANCE
-
columnConfigs
-
sqlStatement
-
factoryData
-
connection
-
statement
-
reconnector
-
isBatchSupported
private volatile boolean isBatchSupported -
columnMetaData
-
-
Constructor Details
-
JdbcDatabaseManager
private JdbcDatabaseManager(String name, String sqlStatement, List<ColumnConfig> columnConfigs, JdbcDatabaseManager.FactoryData factoryData)
-
-
Method Details
-
appendColumnName
-
appendColumnNames
private static void appendColumnNames(String sqlVerb, JdbcDatabaseManager.FactoryData data, StringBuilder sb) Appends column names to the given buffer in the format"A,B,C"
. -
getFactory
-
getJDBCDatabaseManager
@Deprecated public static JdbcDatabaseManager getJDBCDatabaseManager(String name, int bufferSize, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs) Deprecated.Creates a JDBC manager for use within theJdbcAppender
, 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 theJdbcAppender
, 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 layoutconnectionSource
- 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.Creates a JDBC manager for use within theJdbcAppender
, 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 theJdbcAppender
, 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 layoutconnectionSource
- 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 aAppenderLoggingException
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.
-
checkConnection
private void checkConnection() -
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 toAbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)
. With buffering disabled, this is called immediately after every invocation ofAbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)
.- Specified by:
commitAndClose
in classAbstractDatabaseManager
- Returns:
- true if all resources were closed normally, false otherwise.
-
commitAndCloseAll
private boolean commitAndCloseAll() -
connectAndPrepare
- Throws:
SQLException
-
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 toAbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)
. With buffering disabled, this is called immediately before every invocation ofAbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)
.- Specified by:
connectAndStart
in classAbstractDatabaseManager
-
createReconnector
-
createSqlSelect
-
fieldsToString
-
getConnectionSource
-
getSqlStatement
-
getTableName
-
initColumnMetaData
- Throws:
SQLException
-
isClosed
Checks if a statement is closed. A null statement is considered closed.- Parameters:
statement
- The statement to check.- Returns:
- true if a statement is closed, false if null.
- Throws:
SQLException
- if a database access error occurs
-
isClosed
Checks if a connection is closed. A null connection is considered closed.- Parameters:
connection
- The connection to check.- Returns:
- true if a connection is closed, false if null.
- Throws:
SQLException
- if a database access error occurs
-
reconnectOn
-
setFields
- Throws:
SQLException
-
setStatementObject
Sets the given Object in the prepared statement. The value is truncated if needed.- Throws:
SQLException
-
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 afterAbstractDatabaseManager.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 inAbstractDatabaseManager.startupInternal()
.- Specified by:
shutdownInternal
in classAbstractDatabaseManager
- Returns:
- true if all resources were closed normally, false otherwise.
-
startupInternal
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 classAbstractDatabaseManager
- Throws:
Exception
-
truncate
Truncates the value if needed. -
writeInternal
Description copied from class:AbstractDatabaseManager
Performs the actual writing of the event in an implementation-specific way. This method is called immediately fromAbstractDatabaseManager.write(LogEvent, Serializable)
if buffering is off, or fromAbstractDatabaseManager.flush()
if the buffer has reached its limit.- Specified by:
writeInternal
in classAbstractDatabaseManager
- Parameters:
event
- The event to write to the database.
-
writeThrough
- Overrides:
writeThrough
in classAbstractDatabaseManager
-
getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)