| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractDatabaseManager (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, class: AbstractDatabaseManager"> |
| <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/AbstractDatabaseManager.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><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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</a></div> |
| <h1 title="Class AbstractDatabaseManager" class="title">Class AbstractDatabaseManager</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">org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager</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> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="jdbc/JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></code>, <code><a href="../nosql/NoSqlDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.nosql">NoSqlDatabaseManager</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractDatabaseManager</span> |
| <span class="extends-implements">extends <a href="../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a> |
| implements <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></span></div> |
| <div class="block">Manager that allows database appenders to have their configuration reloaded without losing events.</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>protected static class </code></div> |
| <div class="col-second even-row-color"><code><a href="AbstractDatabaseManager.AbstractFactoryData.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager.AbstractFactoryData</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementations should extend this class for passing data between the getManager method and the manager factory |
| class.</div> |
| </div> |
| </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> |
| <!-- ======== 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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,int)" class="member-name-link">AbstractDatabaseManager</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)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)"><code>AbstractDatabaseManager(String, int, Layout, Configuration)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout)" class="member-name-link">AbstractDatabaseManager</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)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)"><code>AbstractDatabaseManager(String, int, Layout, Configuration)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">AbstractDatabaseManager</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="../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs the base manager.</div> |
| </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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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="#buffer(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">buffer</a><wbr>(<a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</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-tab3"><code>protected abstract boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code>protected abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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>final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#flush()" class="member-name-link">flush</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method is called automatically when the buffer size reaches its maximum or at the beginning of a call to |
| <a href="#shutdown()"><code>shutdown()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <M extends <a href="AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a>,<wbr> |
| T extends <a href="AbstractDatabaseManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager.AbstractFactoryData</a>><br>M</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getManager(java.lang.String,T,org.apache.logging.log4j.core.appender.ManagerFactory)" 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, |
| T data, |
| <a href="../ManagerFactory.html" title="interface in org.apache.logging.log4j.core.appender">ManagerFactory</a><M,<wbr>T> factory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Implementations should define their own getManager method and call this method from that to create or get |
| existing managers.</div> |
| </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="#isBuffered()" class="member-name-link">isBuffered</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>final boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRunning()" class="member-name-link">isRunning</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates whether the manager is currently connected <a href="#startup()"><code>startup()</code></a> has been called and <a href="#shutdown()"><code>shutdown()</code></a> |
| has not been called).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#releaseSub(long,java.util.concurrent.TimeUnit)" class="member-name-link">releaseSub</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">May be overridden by managers to perform processing while the manager is being released and the |
| lock is held.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method is called from the <a href="../AbstractManager.html#close()"><code>AbstractManager.close()</code></a> method when the appender is stopped or the appender's manager |
| is replaced.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shutdownInternal()" class="member-name-link">shutdownInternal</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Implementations should implement this method to perform any proprietary disconnection / shutdown operations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startup()" class="member-name-link">startup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method is called within the appender when the appender is started.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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>final <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="#toString()" class="member-name-link">toString</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 method-summary-table-tab6"><code>final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#write(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">write</a><wbr>(<a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 2.11.0 Use <a href="#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>write(LogEvent, Serializable)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)" class="member-name-link">write</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">This method manages buffering and writing of events.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#writeInternal(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">writeInternal</a><wbr>(<a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>writeInternal(LogEvent, Serializable)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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.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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,int)"> |
| <h3>AbstractDatabaseManager</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">protected</span> <span class="element-name">AbstractDatabaseManager</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)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)"><code>AbstractDatabaseManager(String, int, Layout, Configuration)</code></a>.</div> |
| </div> |
| <div class="block">Constructs the base manager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The manager name, which should include any configuration details that one might want to be able to |
| reconfigure at runtime, such as database name, username, (hashed) password, etc.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,int,org.apache.logging.log4j.core.Layout)"> |
| <h3>AbstractDatabaseManager</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">protected</span> <span class="element-name">AbstractDatabaseManager</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)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#%3Cinit%3E(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)"><code>AbstractDatabaseManager(String, int, Layout, Configuration)</code></a>.</div> |
| </div> |
| <div class="block">Constructs the base manager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The manager name, which should include any configuration details that one might want to be able to |
| reconfigure at runtime, such as database name, username, (hashed) password, etc.</dd> |
| <dd><code>layout</code> - the Appender-level layout.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,int,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>AbstractDatabaseManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractDatabaseManager</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="../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block">Constructs the base manager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The manager name, which should include any configuration details that one might want to be able to |
| reconfigure at runtime, such as database name, username, (hashed) password, etc.</dd> |
| <dd><code>layout</code> - the Appender-level layout.</dd> |
| <dd><code>bufferSize</code> - The size of the log event buffer.</dd> |
| <dd><code>configuration</code> - My configuration.</dd> |
| </dl> |
| </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="getManager(java.lang.String,T,org.apache.logging.log4j.core.appender.ManagerFactory)"> |
| <h3 id="getManager(java.lang.String,org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager.AbstractFactoryData,org.apache.logging.log4j.core.appender.ManagerFactory)">getManager</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="type-parameters-long"><M extends <a href="AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager</a>,<wbr> |
| T extends <a href="AbstractDatabaseManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseManager.AbstractFactoryData</a>></span> |
| <span class="return-type">M</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, |
| T data, |
| <a href="../ManagerFactory.html" title="interface in org.apache.logging.log4j.core.appender">ManagerFactory</a><M,<wbr>T> factory)</span></div> |
| <div class="block">Implementations should define their own getManager method and call this method from that to create or get |
| existing managers.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>M</code> - The concrete manager type.</dd> |
| <dd><code>T</code> - The concrete <a href="AbstractDatabaseManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender.db"><code>AbstractDatabaseManager.AbstractFactoryData</code></a> type.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The manager name, which should include any configuration details that one might want to be able to |
| reconfigure at runtime, such as database name, username, (hashed) password, etc.</dd> |
| <dd><code>data</code> - The concrete instance of <a href="AbstractDatabaseManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender.db"><code>AbstractDatabaseManager.AbstractFactoryData</code></a> appropriate for the given manager.</dd> |
| <dd><code>factory</code> - A factory instance for creating the appropriate manager.</dd> |
| <dt>Returns:</dt> |
| <dd>a new or existing manager of the specified type and name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="buffer(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>buffer</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">buffer</span><wbr><span class="parameters">(<a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commitAndClose()"> |
| <h3>commitAndClose</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">boolean</span> <span class="element-name">commitAndClose</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="#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>. With buffering disabled, this is called immediately after every invocation of |
| <a href="#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>.</div> |
| <dl class="notes"> |
| <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 abstract</span> <span class="return-type">void</span> <span class="element-name">connectAndStart</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="#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>. With buffering disabled, this is |
| called immediately before every invocation of <a href="#writeInternal(org.apache.logging.log4j.core.LogEvent)"><code>writeInternal(org.apache.logging.log4j.core.LogEvent)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="flush()"> |
| <h3>flush</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">flush</span>()</div> |
| <div class="block">This method is called automatically when the buffer size reaches its maximum or at the beginning of a call to |
| <a href="#shutdown()"><code>shutdown()</code></a>. It can also be called manually to flush events to the database.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html#flush--" title="class or interface in java.io" class="external-link">flush</a></code> in interface <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBuffered()"> |
| <h3>isBuffered</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isBuffered</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRunning()"> |
| <h3>isRunning</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isRunning</span>()</div> |
| <div class="block">Indicates whether the manager is currently connected <a href="#startup()"><code>startup()</code></a> has been called and <a href="#shutdown()"><code>shutdown()</code></a> |
| has not been called).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the manager is connected.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="releaseSub(long,java.util.concurrent.TimeUnit)"> |
| <h3>releaseSub</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">releaseSub</span><wbr><span class="parameters">(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractManager.html#releaseSub(long,java.util.concurrent.TimeUnit)">AbstractManager</a></code></span></div> |
| <div class="block">May be overridden by managers to perform processing while the manager is being released and the |
| lock is held. A timeout is passed for implementors to use as they see fit.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractManager.html#releaseSub(long,java.util.concurrent.TimeUnit)">releaseSub</a></code> in class <code><a href="../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - timeout</dd> |
| <dd><code>timeUnit</code> - timeout time unit</dd> |
| <dt>Returns:</dt> |
| <dd>true if all resources were closed normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">shutdown</span>()</div> |
| <div class="block">This method is called from the <a href="../AbstractManager.html#close()"><code>AbstractManager.close()</code></a> method when the appender is stopped or the appender's manager |
| is replaced. If it has not already been called, it calls <a href="#shutdownInternal()"><code>shutdownInternal()</code></a> and catches any exceptions |
| it might throw.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if all resources were closed normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownInternal()"> |
| <h3>shutdownInternal</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">boolean</span> <span class="element-name">shutdownInternal</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">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="#startupInternal()"><code>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="#startupInternal()"><code>startupInternal()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if all resources were closed normally, false otherwise.</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="startup()"> |
| <h3>startup</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">startup</span>()</div> |
| <div class="block">This method is called within the appender when the appender is started. If it has not already been called, it |
| calls <a href="#startupInternal()"><code>startupInternal()</code></a> and catches any exceptions it might throw.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startupInternal()"> |
| <h3>startupInternal</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</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">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>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="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public final</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>write</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 final</span> <span class="return-type">void</span> <span class="element-name">write</span><wbr><span class="parameters">(<a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 2.11.0 Use <a href="#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>write(LogEvent, Serializable)</code></a>.</div> |
| </div> |
| <div class="block">This method manages buffering and writing of events.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The event to write to the database.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">write</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">This method manages buffering and writing of events.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The event to write to the database.</dd> |
| <dd><code>serializable</code> - Serializable event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeInternal(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>writeInternal</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">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)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#writeInternal(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>writeInternal(LogEvent, Serializable)</code></a>.</div> |
| </div> |
| <div class="block">Performs the actual writing of the event in an implementation-specific way. This method is called immediately |
| from <a href="#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>write(LogEvent, Serializable)</code></a> if buffering is off, or from <a href="#flush()"><code>flush()</code></a> if the buffer has reached its limit.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The event to write to the database.</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 abstract</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">Performs the actual writing of the event in an implementation-specific way. This method is called immediately |
| from <a href="#write(org.apache.logging.log4j.core.LogEvent,java.io.Serializable)"><code>write(LogEvent, Serializable)</code></a> if buffering is off, or from <a href="#flush()"><code>flush()</code></a> if the buffer has reached its limit.</div> |
| <dl class="notes"> |
| <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> |
| </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> |