blob: 1c798b843923e1d600b28c99fdb469120a2594bb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>DriverManagerConnectionSource (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender.db.jdbc, class: DriverManagerConnectionSource">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/DriverManagerConnectionSource.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.appender.db.jdbc</a></div>
<h1 title="Class DriverManagerConnectionSource" class="title">Class DriverManagerConnectionSource</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a>
<div class="inheritance"><a href="AbstractConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">org.apache.logging.log4j.core.appender.db.jdbc.AbstractConnectionSource</a>
<div class="inheritance"><a href="AbstractDriverManagerConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource</a>
<div class="inheritance">org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a></code>, <code><a href="../../../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../../../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations"><a href="../../../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../../../config/plugins/Plugin.html#name()">name</a>="DriverManager",
<a href="../../../config/plugins/Plugin.html#category()">category</a>="Core",
<a href="../../../config/plugins/Plugin.html#elementType()">elementType</a>="connectionSource",
<a href="../../../config/plugins/Plugin.html#printObject()">printObject</a>=true)
</span><span class="modifiers">public class </span><span class="element-name type-name-label">DriverManagerConnectionSource</span>
<span class="extends-implements">extends <a href="AbstractDriverManagerConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractDriverManagerConnectionSource</a></span></div>
<div class="block">A <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc"><code>ConnectionSource</code></a> that uses a JDBC connection string, a user name, and a password to call
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html#getConnection-java.lang.String-java.lang.String-java.lang.String-" title="class or interface in java.sql" class="external-link"><code>DriverManager.getConnection(String, String, String)</code></a>.
<p>
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.
</p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="DriverManagerConnectionSource.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;<a href="DriverManagerConnectionSource.Builder.html" title="type parameter in DriverManagerConnectionSource.Builder">B</a> extends <a href="DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;<a href="DriverManagerConnectionSource.Builder.html" title="type parameter in DriverManagerConnectionSource.Builder">B</a>&gt;&gt;</code></div>
<div class="col-last even-row-color">
<div class="block">Builds DriverManagerConnectionSource instances.</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="../../../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2>
<code><a href="../../../LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class&nbsp;org.apache.logging.log4j.core.<a href="../../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3>
<code><a href="../../../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../../../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,char%5B%5D,char%5B%5D,org.apache.logging.log4j.core.config.Property%5B%5D)" class="member-name-link">DriverManagerConnectionSource</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;driverClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connectionString,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;actualConnectionString,
char[]&nbsp;userName,
char[]&nbsp;password,
<a href="../../../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[]&nbsp;properties)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;B extends <a href="DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;B&gt;&gt;<br>B</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource">Methods inherited from class&nbsp;org.apache.logging.log4j.core.appender.db.jdbc.<a href="AbstractDriverManagerConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractDriverManagerConnectionSource</a></h3>
<code><a href="AbstractDriverManagerConnectionSource.html#getActualConnectionString()">getActualConnectionString</a>, <a href="AbstractDriverManagerConnectionSource.html#getConnection()">getConnection</a>, <a href="AbstractDriverManagerConnectionSource.html#getConnectionString()">getConnectionString</a>, <a href="AbstractDriverManagerConnectionSource.html#getDriverClassName()">getDriverClassName</a>, <a href="AbstractDriverManagerConnectionSource.html#getLogger()">getLogger</a>, <a href="AbstractDriverManagerConnectionSource.html#getPassword()">getPassword</a>, <a href="AbstractDriverManagerConnectionSource.html#getProperties()">getProperties</a>, <a href="AbstractDriverManagerConnectionSource.html#getUserName()">getUserName</a>, <a href="AbstractDriverManagerConnectionSource.html#loadDriver()">loadDriver</a>, <a href="AbstractDriverManagerConnectionSource.html#loadDriver(java.lang.String)">loadDriver</a>, <a href="AbstractDriverManagerConnectionSource.html#toProperties(org.apache.logging.log4j.core.config.Property%5B%5D)">toProperties</a>, <a href="AbstractDriverManagerConnectionSource.html#toString()">toString</a>, <a href="AbstractDriverManagerConnectionSource.html#toString(char%5B%5D)">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class&nbsp;org.apache.logging.log4j.core.<a href="../../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3>
<code><a href="../../../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../../../AbstractLifeCycle.html#getState()">getState</a>, <a href="../../../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../../../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../../../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../../../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../../../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../../../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../../../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../../../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../../../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../../../AbstractLifeCycle.html#start()">start</a>, <a href="../../../AbstractLifeCycle.html#stop()">stop</a>, <a href="../../../AbstractLifeCycle.html#stop(long,java.util.concurrent.TimeUnit)">stop</a>, <a href="../../../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="../../../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3>
<code><a href="../../../LifeCycle.html#getState()">getState</a>, <a href="../../../LifeCycle.html#initialize()">initialize</a>, <a href="../../../LifeCycle.html#isStarted()">isStarted</a>, <a href="../../../LifeCycle.html#isStopped()">isStopped</a>, <a href="../../../LifeCycle.html#start()">start</a>, <a href="../../../LifeCycle.html#stop()">stop</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,char[],char[],org.apache.logging.log4j.core.config.Property[])">
<h3>DriverManagerConnectionSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DriverManagerConnectionSource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;driverClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connectionString,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;actualConnectionString,
char[]&nbsp;userName,
char[]&nbsp;password,
<a href="../../../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[]&nbsp;properties)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="newBuilder()">
<h3>newBuilder</h3>
<div class="member-signature"><span class="annotations"><a href="../../../config/plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="type-parameters-long">&lt;B extends <a href="DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;B&gt;&gt;</span>
<span class="return-type">B</span>&nbsp;<span class="element-name">newBuilder</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>