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

Class AbstractDriverManagerConnectionSource

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

All Implemented Interfaces:

ConnectionSource, LifeCycle, LifeCycle2

Direct Known Subclasses:

DriverManagerConnectionSource

public class AbstractDriverManagerConnectionSource
extends AbstractConnectionSource

A ConnectionSource that uses a JDBC connection string, a user name, and a password to call DriverManager.getConnection(String, String, String).

This plugin does not provide any connection pooling unless it is available through the connection string and driver itself. This handy to get you off the ground without having to deal with JNDI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDriverManagerConnectionSource.Builder<B extends AbstractDriverManagerConnectionSource.Builder<B>> Builds DriverManagerConnectionSource instances.

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

Constructor Summary

Constructors

Constructor and Description
AbstractDriverManagerConnectionSource(String driverClassName, String connectionString, String actualConnectionString, char[] userName, char[] password, Property[] properties)

Method Summary

Modifier and Type	Method and Description
String	getActualConnectionString()
Connection	getConnection() This should return a new connection every time it is called.
String	getConnectionString()
String	getDriverClassName()
static org.apache.logging.log4j.Logger	getLogger()
char[]	getPassword()
Property[]	getProperties()
char[]	getUserName()
protected void	loadDriver()
protected void	loadDriver(String className) Loads a JDBC driver for the given class name
protected Properties	toProperties(Property[] properties)
String	toString() All implementations must override Object.toString() to provide information about the connection configuration (obscuring passwords with one-way hashes).
protected String	toString(char[] value)

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

Constructor Detail

AbstractDriverManagerConnectionSource

public AbstractDriverManagerConnectionSource(String driverClassName,
                                             String connectionString,
                                             String actualConnectionString,
                                             char[] userName,
                                             char[] password,
                                             Property[] properties)

Method Detail

getLogger

public static org.apache.logging.log4j.Logger getLogger()

getActualConnectionString

public String getActualConnectionString()

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.

getConnectionString

public String getConnectionString()

getDriverClassName

public String getDriverClassName()

getPassword

public char[] getPassword()

getProperties

public Property[] getProperties()

getUserName

public char[] getUserName()

loadDriver

protected void loadDriver()
                   throws SQLException

Throws:

SQLException

loadDriver

protected void loadDriver(String className)
                   throws SQLException

Loads a JDBC driver for the given class name

Parameters:

className - the fully-qualified class name for a JDBC Driver.

Throws:

SQLException - thrown when loading the driver throws an exception.

toProperties

protected Properties toProperties(Property[] properties)

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.

toString

protected String toString(char[] value)