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:

org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

@Plugin(name="DataSource",
        category="Core",
        elementType="connectionSource",
        printObject=true)
public final class DataSourceConnectionSource
extends org.apache.logging.log4j.core.appender.db.jdbc.AbstractConnectionSource

A JdbcAppender connection source that uses a DataSource to connect to the database. PaxLogging changes: more dynamic approach to JNDI. The idea is to be able to configure JNDI datasource for Log4J2 JDBC appender in situations where both JNDI (aries-jndi) and DataSource service itself may dynamically come and go to/from OSGi registry.

Nested Class Summary

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

org.apache.logging.log4j.core.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 and Description
static DataSourceConnectionSource	createConnectionSource(String jndiName, String serviceFilter, boolean lazy) Factory method for creating a connection source within the plugin manager.
Connection	getConnection()
void	stop()
String	toString()

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

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

Method Detail

stop

public void stop()

Specified by:

stop in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

stop in class org.apache.logging.log4j.core.AbstractLifeCycle

getConnection

public Connection getConnection()
                         throws SQLException

Throws:

SQLException

toString

public String toString()

Specified by:

toString in interface org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource

Overrides:

toString in class Object

createConnectionSource

@PluginFactory
public static DataSourceConnectionSource createConnectionSource(@PluginAttribute(value="jndiName")
                                                                               String jndiName,
                                                                               @PluginAttribute(value="service")
                                                                               String serviceFilter,
                                                                               @PluginAttribute(value="lazy")
                                                                               boolean lazy)

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

Parameters:

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

serviceFilter - Filter definition to get DataSource directly from OSGi registry without JNDI

lazy - whether we should create lazy ConnectionSource that's more tolerant to missing JNDI and/or actual bound DataSource.

Returns:

the created connection source.