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

Class DataSourceConnectionSource

java.lang.Object

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

All Implemented Interfaces:

ConnectionSource

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

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

Method Summary

Modifier and Type	Method and 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 java.lang.Object

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

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Description copied from interface: ConnectionSource

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

Specified by:

getConnection in interface ConnectionSource

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(value="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.