| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>JdbcDatabaseManager (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: JdbcDatabaseManager"> |
| <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/JdbcDatabaseManager.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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.logging.log4j.core.appender.db.jdbc</a></div> |
| <h1 title="Class JdbcDatabaseManager" class="title">Class JdbcDatabaseManager</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="../../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractManager</a> |
| <div class="inheritance"><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager</a> |
| <div class="inheritance">org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html" title="class or interface in java.io" class="external-link">Flushable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">JdbcDatabaseManager</span> |
| <span class="extends-implements">extends <a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></span></div> |
| <div class="block">An <a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db"><code>AbstractDatabaseManager</code></a> implementation for relational databases accessed via JDBC.</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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.db.<a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></h2> |
| <code><a href="../AbstractDatabaseManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager.AbstractFactoryData</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.appender.AbstractManager">Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../AbstractManager.html#count">count</a>, <a href="../../AbstractManager.html#LOGGER">LOGGER</a></code></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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeResources(boolean)" class="member-name-link">closeResources</a><wbr>(boolean logExceptions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commitAndClose()" class="member-name-link">commitAndClose</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the |
| connection pool).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connectAndStart()" class="member-name-link">connectAndStart</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connects to the database and starts a transaction (if applicable).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConnectionSource()" class="member-name-link">getConnectionSource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getJDBCDatabaseManager(java.lang.String,int,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D)" class="member-name-link">getJDBCDatabaseManager</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> name, |
| int bufferSize, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use |
| <a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long)"><code>getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)</code></a></div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D)" class="member-name-link">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long)" class="member-name-link">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings, |
| boolean immediateFail, |
| long reconnectIntervalMillis)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use |
| <a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long)"><code>getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)</code></a></div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long,boolean)" class="member-name-link">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings, |
| boolean immediateFail, |
| long reconnectIntervalMillis, |
| boolean truncateStrings)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a JDBC manager for use within the <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>, or returns a suitable one if it already exists.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSqlStatement()" class="member-name-link">getSqlStatement</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableName()" class="member-name-link">getTableName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdownInternal()" class="member-name-link">shutdownInternal</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Implementations should implement this method to perform any proprietary disconnection / shutdown operations.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startupInternal()" class="member-name-link">startupInternal</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Implementations should implement this method to perform any proprietary startup operations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)" class="member-name-link">writeInternal</a><wbr>(<a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a> serializable)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Performs the actual writing of the event in an implementation-specific way.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeThrough(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)" class="member-name-link">writeThrough</a><wbr>(<a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a> serializable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager">Methods inherited from class org.apache.logging.log4j.core.appender.db.<a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></h3> |
| <code><a href="../AbstractDatabaseManager.html#buffer(org.apache.logging.log4j.core.LogEvent)">buffer</a>, <a href="../AbstractDatabaseManager.html#flush()">flush</a>, <a href="../AbstractDatabaseManager.html#getManager(java.lang.String,T,org.apache.logging.log4j.core.appender.ManagerFactory)">getManager</a>, <a href="../AbstractDatabaseManager.html#isBuffered()">isBuffered</a>, <a href="../AbstractDatabaseManager.html#isRunning()">isRunning</a>, <a href="../AbstractDatabaseManager.html#releaseSub(long,java.util.concurrent.TimeUnit)">releaseSub</a>, <a href="../AbstractDatabaseManager.html#shutdown()">shutdown</a>, <a href="../AbstractDatabaseManager.html#startup()">startup</a>, <a href="../AbstractDatabaseManager.html#toString()">toString</a>, <a href="../AbstractDatabaseManager.html#write(org.apache.logging.log4j.core.LogEvent)">write</a>, <a href="../AbstractDatabaseManager.html#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)">write</a>, <a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent)">writeInternal</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../AbstractManager.html#close()">close</a>, <a href="../../AbstractManager.html#getContentFormat()">getContentFormat</a>, <a href="../../AbstractManager.html#getCount()">getCount</a>, <a href="../../AbstractManager.html#getLoggerContext()">getLoggerContext</a>, <a href="../../AbstractManager.html#getManager(java.lang.String,org.apache.logging.log4j.core.appender.ManagerFactory,T)">getManager</a>, <a href="../../AbstractManager.html#getName()">getName</a>, <a href="../../AbstractManager.html#getStrSubstitutor()">getStrSubstitutor</a>, <a href="../../AbstractManager.html#hasManager(java.lang.String)">hasManager</a>, <a href="../../AbstractManager.html#log(org.apache.logging.log4j.Level,java.lang.String,java.lang.Throwable)">log</a>, <a href="../../AbstractManager.html#logDebug(java.lang.String,java.lang.Throwable)">logDebug</a>, <a href="../../AbstractManager.html#logError(java.lang.String,java.lang.Throwable)">logError</a>, <a href="../../AbstractManager.html#logger()">logger</a>, <a href="../../AbstractManager.html#logWarn(java.lang.String,java.lang.Throwable)">logWarn</a>, <a href="../../AbstractManager.html#narrow(java.lang.Class,org.apache.logging.log4j.core.appender.AbstractManager)">narrow</a>, <a href="../../AbstractManager.html#release()">release</a>, <a href="../../AbstractManager.html#stop(long,java.util.concurrent.TimeUnit)">stop</a>, <a href="../../AbstractManager.html#updateData(java.lang.Object)">updateData</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getJDBCDatabaseManager(java.lang.String,int,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[])"> |
| <h3>getJDBCDatabaseManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></span> <span class="element-name">getJDBCDatabaseManager</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> name, |
| int bufferSize, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use |
| <a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long)"><code>getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)</code></a></div> |
| </div> |
| <div class="block">Creates a JDBC manager for use within the <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>, or returns a suitable one if it already exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the manager, which should include connection details and hashed passwords where possible.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| <dd><code>connectionSource</code> - The source for connections to the database.</dd> |
| <dd><code>tableName</code> - The name of the database table to insert log events into.</dd> |
| <dd><code>columnConfigs</code> - Configuration information about the log table columns.</dd> |
| <dt>Returns:</dt> |
| <dd>a new or existing JDBC manager as applicable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[],org.apache.logging.log4j.core.appender.db.ColumnMapping[])"> |
| <h3>getManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></span> <span class="element-name">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Creates a JDBC manager for use within the <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>, or returns a suitable one if it already exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the manager, which should include connection details and hashed passwords where possible.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| <dd><code>layout</code> - The Appender-level layout</dd> |
| <dd><code>connectionSource</code> - The source for connections to the database.</dd> |
| <dd><code>tableName</code> - The name of the database table to insert log events into.</dd> |
| <dd><code>columnConfigs</code> - Configuration information about the log table columns.</dd> |
| <dd><code>columnMappings</code> - column mapping configuration (including type conversion).</dd> |
| <dt>Returns:</dt> |
| <dd>a new or existing JDBC manager as applicable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[],org.apache.logging.log4j.core.appender.db.ColumnMapping[],boolean,long)"> |
| <h3>getManager</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></span> <span class="element-name">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings, |
| boolean immediateFail, |
| long reconnectIntervalMillis)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use |
| <a href="#getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig%5B%5D,org.apache.logging.log4j.core.appender.db.ColumnMapping%5B%5D,boolean,long)"><code>getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)</code></a></div> |
| </div> |
| <div class="block">Creates a JDBC manager for use within the <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>, or returns a suitable one if it already exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the manager, which should include connection details and hashed passwords where possible.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| <dd><code>layout</code> - the Appender-level layout</dd> |
| <dd><code>connectionSource</code> - The source for connections to the database.</dd> |
| <dd><code>tableName</code> - The name of the database table to insert log events into.</dd> |
| <dd><code>columnConfigs</code> - Configuration information about the log table columns.</dd> |
| <dd><code>columnMappings</code> - column mapping configuration (including type conversion).</dd> |
| <dd><code>reconnectIntervalMillis</code> - How often to reconnect to the database when a SQL exception is detected.</dd> |
| <dd><code>immediateFail</code> - Whether to fail immediately with a <a href="../../AppenderLoggingException.html" title="class in org.apache.logging.log4j.core.appender"><code>AppenderLoggingException</code></a> when connecting |
| to JDBC fails.</dd> |
| <dt>Returns:</dt> |
| <dd>a new or existing JDBC manager as applicable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getManager(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource,java.lang.String,org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig[],org.apache.logging.log4j.core.appender.db.ColumnMapping[],boolean,long,boolean)"> |
| <h3>getManager</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></span> <span class="element-name">getManager</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> name, |
| int bufferSize, |
| <a href="../../../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a> connectionSource, |
| <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> tableName, |
| <a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a>[] columnConfigs, |
| <a href="../ColumnMapping.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping</a>[] columnMappings, |
| boolean immediateFail, |
| long reconnectIntervalMillis, |
| boolean truncateStrings)</span></div> |
| <div class="block">Creates a JDBC manager for use within the <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>, or returns a suitable one if it already exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the manager, which should include connection details and hashed passwords where possible.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| <dd><code>layout</code> - The Appender-level layout</dd> |
| <dd><code>connectionSource</code> - The source for connections to the database.</dd> |
| <dd><code>tableName</code> - The name of the database table to insert log events into.</dd> |
| <dd><code>columnConfigs</code> - Configuration information about the log table columns.</dd> |
| <dd><code>columnMappings</code> - column mapping configuration (including type conversion).</dd> |
| <dd><code>immediateFail</code> - Whether or not to fail immediately with a <a href="../../AppenderLoggingException.html" title="class in org.apache.logging.log4j.core.appender"><code>AppenderLoggingException</code></a> when connecting |
| to JDBC fails.</dd> |
| <dd><code>reconnectIntervalMillis</code> - How often to reconnect to the database when a SQL exception is detected.</dd> |
| <dd><code>truncateStrings</code> - Whether or not to truncate strings to match column metadata.</dd> |
| <dt>Returns:</dt> |
| <dd>a new or existing JDBC manager as applicable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeResources(boolean)"> |
| <h3>closeResources</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">closeResources</span><wbr><span class="parameters">(boolean logExceptions)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commitAndClose()"> |
| <h3>commitAndClose</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">commitAndClose</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractDatabaseManager.html#commitAndClose()">AbstractDatabaseManager</a></code></span></div> |
| <div class="block">Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the |
| connection pool). With buffering enabled, this is called when flushing the buffer completes, after the last call |
| to <a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>. With buffering disabled, this is called immediately after every invocation of |
| <a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#commitAndClose()">commitAndClose</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if all resources were closed normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connectAndStart()"> |
| <h3>connectAndStart</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">connectAndStart</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractDatabaseManager.html#connectAndStart()">AbstractDatabaseManager</a></code></span></div> |
| <div class="block">Connects to the database and starts a transaction (if applicable). With buffering enabled, this is called when |
| flushing the buffer begins, before the first call to <a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>. With buffering disabled, this is |
| called immediately before every invocation of <a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>AbstractDatabaseManager.writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#connectAndStart()">connectAndStart</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnectionSource()"> |
| <h3>getConnectionSource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a></span> <span class="element-name">getConnectionSource</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSqlStatement()"> |
| <h3>getSqlStatement</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getSqlStatement</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableName()"> |
| <h3>getTableName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getTableName</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownInternal()"> |
| <h3>shutdownInternal</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">shutdownInternal</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractDatabaseManager.html#shutdownInternal()">AbstractDatabaseManager</a></code></span></div> |
| <div class="block">Implementations should implement this method to perform any proprietary disconnection / shutdown operations. This |
| method will never be called twice on the same instance, and it will only be called <em>after</em> |
| <a href="../AbstractDatabaseManager.html#startupInternal()"><code>AbstractDatabaseManager.startupInternal()</code></a>. It is safe to throw any exceptions from this method. This method does not |
| necessarily disconnect from the database for the same reasons outlined in <a href="../AbstractDatabaseManager.html#startupInternal()"><code>AbstractDatabaseManager.startupInternal()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#shutdownInternal()">shutdownInternal</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if all resources were closed normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startupInternal()"> |
| <h3>startupInternal</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">startupInternal</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractDatabaseManager.html#startupInternal()">AbstractDatabaseManager</a></code></span></div> |
| <div class="block">Implementations should implement this method to perform any proprietary startup operations. This method will |
| never be called twice on the same instance. It is safe to throw any exceptions from this method. This method |
| does not necessarily connect to the database, as it is generally unreliable to connect once and use the same |
| connection for hours.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#startupInternal()">startupInternal</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"> |
| <h3>writeInternal</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">writeInternal</span><wbr><span class="parameters">(<a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a> serializable)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)">AbstractDatabaseManager</a></code></span></div> |
| <div class="block">Performs the actual writing of the event in an implementation-specific way. This method is called immediately |
| from <a href="../AbstractDatabaseManager.html#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>AbstractDatabaseManager.write(LogEvent, Serializable)</code></a> if buffering is off, or from <a href="../AbstractDatabaseManager.html#flush()"><code>AbstractDatabaseManager.flush()</code></a> if the buffer has reached its limit.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)">writeInternal</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The event to write to the database.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeThrough(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"> |
| <h3>writeThrough</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">writeThrough</span><wbr><span class="parameters">(<a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a> serializable)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractDatabaseManager.html#writeThrough(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)">writeThrough</a></code> in class <code><a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a></code></dd> |
| </dl> |
| </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 © 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> |