blob: ea66b06e23710c43c1eba1860b42d7fbbe500c0b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:45 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ReliabilityStrategy (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReliabilityStrategy (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReliabilityStrategy.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategyFactory.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/ReliabilityStrategy.html" target="_top">Frames</a></li>
<li><a href="ReliabilityStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.core.config</div>
<h2 title="Interface ReliabilityStrategy" class="title">Interface ReliabilityStrategy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitCompletionReliabilityStrategy</a>, <a href="../../../../../../org/apache/logging/log4j/core/config/AwaitUnconditionallyReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">AwaitUnconditionallyReliabilityStrategy</a>, <a href="../../../../../../org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">DefaultReliabilityStrategy</a>, <a href="../../../../../../org/apache/logging/log4j/core/config/LockingReliabilityStrategy.html" title="class in org.apache.logging.log4j.core.config">LockingReliabilityStrategy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.30">ReliabilityStrategy</a></pre>
<div class="block">Interface for objects that know how to ensure delivery of log events to the appropriate appenders, even during and
after the configuration has been modified while the system is actively used.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#afterLogEvent--">afterLogEvent</a></span>()</code>
<div class="block">Called after a log event was logged.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#beforeStopAppenders--">beforeStopAppenders</a></span>()</code>
<div class="block">Called before all appenders are stopped.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#beforeStopConfiguration-org.apache.logging.log4j.core.config.Configuration-">beforeStopConfiguration</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</code>
<div class="block">Called before the configuration is stopped.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#getActiveLoggerConfig-org.apache.logging.log4j.util.Supplier-">getActiveLoggerConfig</a></span>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;next)</code>
<div class="block">For internal use by the ReliabilityStrategy; returns the LoggerConfig to use.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#log-org.apache.logging.log4j.util.Supplier-org.apache.logging.log4j.core.LogEvent-">log</a></span>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;reconfigured,
<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</code>
<div class="block">Logs an event.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategy.html#log-org.apache.logging.log4j.util.Supplier-java.lang.String-java.lang.String-org.apache.logging.log4j.Marker-org.apache.logging.log4j.Level-org.apache.logging.log4j.message.Message-java.lang.Throwable-">log</a></span>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;reconfigured,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loggerName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fqcn,
org.apache.logging.log4j.Marker&nbsp;marker,
org.apache.logging.log4j.Level&nbsp;level,
org.apache.logging.log4j.message.Message&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
<div class="block">Logs an event.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="log-org.apache.logging.log4j.util.Supplier-java.lang.String-java.lang.String-org.apache.logging.log4j.Marker-org.apache.logging.log4j.Level-org.apache.logging.log4j.message.Message-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.43">log</a>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;reconfigured,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loggerName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fqcn,
org.apache.logging.log4j.Marker&nbsp;marker,
org.apache.logging.log4j.Level&nbsp;level,
org.apache.logging.log4j.message.Message&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
<div class="block">Logs an event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconfigured</code> - supplies the next LoggerConfig if the strategy's LoggerConfig is no longer active</dd>
<dd><code>loggerName</code> - The name of the Logger.</dd>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>marker</code> - A Marker or null if none is present.</dd>
<dd><code>level</code> - The event Level.</dd>
<dd><code>data</code> - The Message.</dd>
<dd><code>t</code> - A Throwable or null.</dd>
</dl>
</li>
</ul>
<a name="log-org.apache.logging.log4j.util.Supplier-org.apache.logging.log4j.core.LogEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.52">log</a>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;reconfigured,
<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</pre>
<div class="block">Logs an event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconfigured</code> - supplies the next LoggerConfig if the strategy's LoggerConfig is no longer active</dd>
<dd><code>event</code> - The log event.</dd>
</dl>
</li>
</ul>
<a name="getActiveLoggerConfig-org.apache.logging.log4j.util.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveLoggerConfig</h4>
<pre><a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.60">getActiveLoggerConfig</a>(org.apache.logging.log4j.util.Supplier&lt;<a href="../../../../../../org/apache/logging/log4j/core/config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a>&gt;&nbsp;next)</pre>
<div class="block">For internal use by the ReliabilityStrategy; returns the LoggerConfig to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>next</code> - supplies the next LoggerConfig if the strategy's LoggerConfig is no longer active</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently active LoggerConfig</dd>
</dl>
</li>
</ul>
<a name="afterLogEvent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterLogEvent</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.65">afterLogEvent</a>()</pre>
<div class="block">Called after a log event was logged.</div>
</li>
</ul>
<a name="beforeStopAppenders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeStopAppenders</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.70">beforeStopAppenders</a>()</pre>
<div class="block">Called before all appenders are stopped.</div>
</li>
</ul>
<a name="beforeStopConfiguration-org.apache.logging.log4j.core.config.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>beforeStopConfiguration</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ReliabilityStrategy.html#line.77">beforeStopConfiguration</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</pre>
<div class="block">Called before the configuration is stopped.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - the configuration that will be stopped</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReliabilityStrategy.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/config/Reconfigurable.html" title="interface in org.apache.logging.log4j.core.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/config/ReliabilityStrategyFactory.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/ReliabilityStrategy.html" target="_top">Frames</a></li>
<li><a href="ReliabilityStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>