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

Class FactoryMethodConnectionSource

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.FactoryMethodConnectionSource

All Implemented Interfaces:

ConnectionSource, LifeCycle, LifeCycle2

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

A JdbcAppender connection source that uses a public static factory method to obtain a Connection or DataSource.

Nested Class Summary

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

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private javax.sql.DataSource	dataSource
private java.lang.String	description
private static Logger	LOGGER

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

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FactoryMethodConnectionSource(javax.sql.DataSource dataSource, java.lang.String className, java.lang.String methodName, java.lang.String returnType)

Method Summary

Modifier and Type	Method	Description
static FactoryMethodConnectionSource	createConnectionSource(java.lang.String className, java.lang.String methodName)	Factory method for creating a connection source within the plugin manager.
java.sql.Connection	getConnection()	This should return a new connection every time it is called.
java.lang.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

Field Detail

LOGGER

private static final Logger LOGGER

dataSource

private final javax.sql.DataSource dataSource

description

private final java.lang.String description

Constructor Detail

FactoryMethodConnectionSource

private FactoryMethodConnectionSource(javax.sql.DataSource dataSource,
                                      java.lang.String className,
                                      java.lang.String methodName,
                                      java.lang.String returnType)

Method Detail

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Description copied from interface: ConnectionSource

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

Returns:

the SQL connection object.

Throws:

java.sql.SQLException - if a database error occurs.

toString

public java.lang.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 java.lang.Object

Returns:

the string representation of this connection source.

createConnectionSource

@PluginFactory
public static FactoryMethodConnectionSource createConnectionSource(@PluginAttribute("class")
                                                                   java.lang.String className,
                                                                   @PluginAttribute("method")
                                                                   java.lang.String methodName)

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

Parameters:

className - The name of a public class that contains a static method capable of returning either a DataSource or a Connection.

methodName - The name of the public static method on the aforementioned class that returns the data source or connection. If this method returns a Connection, it should return a new connection every call.

Returns:

the created connection source.