Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-core / org / apache / logging / log4j / core / Appender.html
blob: c74143ef2968da9bf087bbe9856cb064d387e4a1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Appender (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, interface: Appender">
<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/Appender.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core</a></div>
<h1 title="Interface Appender" class="title">Interface Appender</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="appender/AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></code>, <code><a href="appender/db/AbstractDatabaseAppender.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseAppender</a></code>, <code><a href="appender/AbstractFileAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractFileAppender</a></code>, <code><a href="appender/AbstractOutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractOutputStreamAppender</a></code>, <code><a href="appender/AbstractWriterAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractWriterAppender</a></code>, <code><a href="appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a></code>, <code><a href="appender/ConsoleAppender.html" title="class in org.apache.logging.log4j.core.appender">ConsoleAppender</a></code>, <code><a href="appender/CountingNoOpAppender.html" title="class in org.apache.logging.log4j.core.appender">CountingNoOpAppender</a></code>, <code><a href="appender/FailoverAppender.html" title="class in org.apache.logging.log4j.core.appender">FailoverAppender</a></code>, <code><a href="appender/FileAppender.html" title="class in org.apache.logging.log4j.core.appender">FileAppender</a></code>, <code><a href="appender/HttpAppender.html" title="class in org.apache.logging.log4j.core.appender">HttpAppender</a></code>, <code><a href="appender/db/jdbc/JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender</a></code>, <code><a href="appender/mom/jeromq/JeroMqAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.jeromq">JeroMqAppender</a></code>, <code><a href="appender/mom/JmsAppender.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender</a></code>, <code><a href="appender/mom/kafka/KafkaAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.kafka">KafkaAppender</a></code>, <code><a href="appender/MemoryMappedFileAppender.html" title="class in org.apache.logging.log4j.core.appender">MemoryMappedFileAppender</a></code>, <code><a href="appender/nosql/NoSqlAppender.html" title="class in org.apache.logging.log4j.core.appender.nosql">NoSqlAppender</a></code>, <code><a href="appender/NullAppender.html" title="class in org.apache.logging.log4j.core.appender">NullAppender</a></code>, <code><a href="appender/OutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamAppender</a></code>, <code><a href="appender/RandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RandomAccessFileAppender</a></code>, <code><a href="appender/rewrite/RewriteAppender.html" title="class in org.apache.logging.log4j.core.appender.rewrite">RewriteAppender</a></code>, <code><a href="appender/RollingFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingFileAppender</a></code>, <code><a href="appender/RollingRandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingRandomAccessFileAppender</a></code>, <code><a href="appender/routing/RoutingAppender.html" title="class in org.apache.logging.log4j.core.appender.routing">RoutingAppender</a></code>, <code><a href="appender/ScriptAppenderSelector.html" title="class in org.apache.logging.log4j.core.appender">ScriptAppenderSelector</a></code>, <code><a href="appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></code>, <code><a href="appender/SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></code>, <code><a href="appender/SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></code>, <code><a href="appender/WriterAppender.html" title="class in org.apache.logging.log4j.core.appender">WriterAppender</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Appender</span><span class="extends-implements">
extends <a href="LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></span></div>
<div class="block">Appends <a href="LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>s. An Appender can contain a <a href="Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> if applicable as well
as an <a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core"><code>ErrorHandler</code></a>. Typical Appender implementations coordinate with an
implementation of <a href="appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender"><code>AbstractManager</code></a> to handle external resources
such as streams, connections, and other shared state. As Appenders are plugins, concrete implementations need to
be annotated with <a href="config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>Plugin</code></a> and need to provide a static
factory method annotated with <a href="config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginFactory</code></a>.
<p>Most core plugins are written using a related Manager class that handle the actual task of serializing a
<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> to some output location. For instance, many Appenders can take
advantage of the <a href="appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender"><code>OutputStreamManager</code></a> class.</p>
<p>It is recommended that Appenders don't do any heavy lifting since there can be many instances of the class
being used at any given time. When resources require locking (e.g., through <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/FileLock.html" title="class or interface in java.nio.channels" class="external-link"><code>FileLock</code></a>),
it is important to isolate synchronized code to prevent concurrency issues.</p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2>
<code><a href="LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static 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"><code><a href="#ELEMENT_TYPE" class="member-name-link">ELEMENT_TYPE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Main <a href="config/plugins/Plugin.html#elementType()">plugin element type</a> for
Appender plugins.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>[]</code></div>
<div class="col-second odd-row-color"><code><a href="#EMPTY_ARRAY" class="member-name-link">EMPTY_ARRAY</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Empty array.</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-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></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-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#append(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">append</a><wbr>(<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Logs a LogEvent using whatever logic this Appender wishes to use.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core">ErrorHandler</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHandler()" class="member-name-link">getHandler</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the <a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core"><code>ErrorHandler</code></a> used for handling exceptions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;? 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>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLayout()" class="member-name-link">getLayout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the Layout used by this Appender if applicable.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the name of this Appender.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ignoreExceptions()" class="member-name-link">ignoreExceptions</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Some Appenders need to propagate exceptions back to the application.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setHandler(org.apache.logging.log4j.core.ErrorHandler)" class="member-name-link">setHandler</a><wbr>(<a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core">ErrorHandler</a>&nbsp;handler)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the <a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core"><code>ErrorHandler</code></a> used for handling exceptions.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3>
<code><a href="LifeCycle.html#getState()">getState</a>, <a href="LifeCycle.html#initialize()">initialize</a>, <a href="LifeCycle.html#isStarted()">isStarted</a>, <a href="LifeCycle.html#isStopped()">isStopped</a>, <a href="LifeCycle.html#start()">start</a>, <a href="LifeCycle.html#stop()">stop</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="ELEMENT_TYPE">
<h3>ELEMENT_TYPE</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<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>&nbsp;<span class="element-name">ELEMENT_TYPE</span></div>
<div class="block">Main <a href="config/plugins/Plugin.html#elementType()">plugin element type</a> for
Appender plugins.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.6</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.logging.log4j.core.Appender.ELEMENT_TYPE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="EMPTY_ARRAY">
<h3>EMPTY_ARRAY</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>[]</span>&nbsp;<span class="element-name">EMPTY_ARRAY</span></div>
<div class="block">Empty array.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="append(org.apache.logging.log4j.core.LogEvent)">
<h3>append</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">append</span><wbr><span class="parameters">(<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</span></div>
<div class="block">Logs a LogEvent using whatever logic this Appender wishes to use. It is typically recommended to use a
bridge pattern not only for the benefits from decoupling an Appender from its implementation, but it is also
handy for sharing resources which may require some form of locking.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>event</code> - The LogEvent.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><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>&nbsp;<span class="element-name">getName</span>()</div>
<div class="block">Gets the name of this Appender.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>name, may be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLayout()">
<h3>getLayout</h3>
<div class="member-signature"><span class="return-type"><a href="Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;? 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>&gt;</span>&nbsp;<span class="element-name">getLayout</span>()</div>
<div class="block">Returns the Layout used by this Appender if applicable.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Layout for this Appender or <code>null</code> if none is configured.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ignoreExceptions()">
<h3>ignoreExceptions</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">ignoreExceptions</span>()</div>
<div class="block">Some Appenders need to propagate exceptions back to the application. When <code>ignoreExceptions</code> is
<code>false</code> the AppenderControl will allow the exception to percolate.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if exceptions will be logged but not thrown, <code>false</code> otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHandler()">
<h3>getHandler</h3>
<div class="member-signature"><span class="return-type"><a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core">ErrorHandler</a></span>&nbsp;<span class="element-name">getHandler</span>()</div>
<div class="block">Gets the <a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core"><code>ErrorHandler</code></a> used for handling exceptions.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ErrorHandler for handling exceptions.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setHandler(org.apache.logging.log4j.core.ErrorHandler)">
<h3>setHandler</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setHandler</span><wbr><span class="parameters">(<a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core">ErrorHandler</a>&nbsp;handler)</span></div>
<div class="block">Sets the <a href="ErrorHandler.html" title="interface in org.apache.logging.log4j.core"><code>ErrorHandler</code></a> used for handling exceptions.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>handler</code> - the ErrorHandler to use for handling exceptions.</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 &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>