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

Class DataSourceConnectionSource

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

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

All Implemented Interfaces:

ConnectionSource, LifeCycle, LifeCycle2

@Plugin(name="DataSource",
        category="Core",
        elementType="connectionSource",
        printObject=true)
public final class DataSourceConnectionSource
extends AbstractConnectionSource

A JdbcAppender connection source that uses a DataSource to connect to the database.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT

Method Summary

Modifier and Type	Method	Description
static DataSourceConnectionSource	createConnectionSource(String jndiName)	Factory method for creating a connection source within the plugin manager.
Connection	getConnection()	This should return a new connection every time it is called.
String	toString()	All implementations must override Object.toString() to provide information about the connection configuration (obscuring passwords with one-way hashes).

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Method Details

getConnection

public Connection getConnection()
                         throws SQLException

Description copied from interface: ConnectionSource

This should return a new connection every time it is called.

Returns:

the SQL connection object.

Throws:

SQLException - if a database error occurs.

toString

public String toString()

Description copied from interface: ConnectionSource

All implementations must override Object.toString() to provide information about the connection configuration (obscuring passwords with one-way hashes).

Specified by:

toString in interface ConnectionSource

Overrides:

toString in class Object

Returns:

the string representation of this connection source.

createConnectionSource

@PluginFactory
public static DataSourceConnectionSource createConnectionSource(@PluginAttribute("jndiName")
 String jndiName)

Factory method for creating a connection source within the plugin manager.

Parameters:

jndiName - The full JNDI path where the data source is bound. Must start with java:/comp/env or environment-equivalent.

Returns:

the created connection source.