blob: 4a3abeed0b832976defe5f362bdc8bbd8922dac3 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>JmsManager (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.mom, class: JmsManager">
<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/JmsManager.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>Field&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.appender.mom</a></div>
<h1 title="Class JmsManager" class="title">Class JmsManager</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.mom.JmsManager</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/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JmsManager</span>
<span class="extends-implements">extends <a href="../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></span></div>
<div class="block">Consider this class <b>private</b>; it is only <b>public</b> for access by integration tests.
<p>
JMS connection and session manager. Can be used to access MessageProducer, MessageConsumer, and Message objects
involving a configured ConnectionFactory and Destination.
</p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="JmsManager.JmsManagerConfiguration.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Nested classes/interfaces inherited from class&nbsp;org.apache.logging.log4j.core.appender.<a href="../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h2>
<code><a href="../AbstractManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager.AbstractFactoryData</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Fields inherited from class&nbsp;org.apache.logging.log4j.core.appender.<a href="../AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3>
<code><a href="../AbstractManager.html#count">count</a>, <a href="../AbstractManager.html#LOGGER">LOGGER</a></code></div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></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>javax.jms.Message</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMessage(java.io.Serializable)" class="member-name-link">createMessage</a><wbr>(<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>&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>javax.jms.MessageConsumer</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMessageConsumer()" class="member-name-link">createMessageConsumer</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a MessageConsumer on this Destination using the current Session.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>javax.jms.MessageProducer</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMessageProducer(javax.jms.Session,javax.jms.Destination)" class="member-name-link">createMessageProducer</a><wbr>(javax.jms.Session&nbsp;session,
javax.jms.Destination&nbsp;destination)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a MessageProducer on this Destination using the current Session.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getJmsManager(java.lang.String,java.util.Properties,java.lang.String,java.lang.String,java.lang.String,char%5B%5D,boolean,long)" class="member-name-link">getJmsManager</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a>&nbsp;jndiProperties,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connectionFactoryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userName,
char[]&nbsp;password,
boolean&nbsp;immediateFail,
long&nbsp;reconnectIntervalMillis)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Gets a JmsManager using the specified configuration parameters.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJmsManagerConfiguration()" class="member-name-link">getJmsManagerConfiguration</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#releaseSub(long,java.util.concurrent.TimeUnit)" class="member-name-link">releaseSub</a><wbr>(long&nbsp;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>&nbsp;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>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Methods inherited from class&nbsp;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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getJmsManager(java.lang.String,java.util.Properties,java.lang.String,java.lang.String,java.lang.String,char[],boolean,long)">
<h3>getJmsManager</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a></span>&nbsp;<span class="element-name">getJmsManager</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a>&nbsp;jndiProperties,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connectionFactoryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userName,
char[]&nbsp;password,
boolean&nbsp;immediateFail,
long&nbsp;reconnectIntervalMillis)</span></div>
<div class="block">Gets a JmsManager using the specified configuration parameters.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name to use for this JmsManager.</dd>
<dd><code>connectionFactoryName</code> - The binding name for the <code>ConnectionFactory</code>.</dd>
<dd><code>destinationName</code> - The binding name for the <code>Destination</code>.</dd>
<dd><code>userName</code> - The userName to connect with or <code>null</code> for no authentication.</dd>
<dd><code>password</code> - The password to use with the given userName or <code>null</code> for no authentication.</dd>
<dd><code>immediateFail</code> - Whether or not to fail immediately with a <a href="../AppenderLoggingException.html" title="class in org.apache.logging.log4j.core.appender"><code>AppenderLoggingException</code></a> when connecting to JMS
fails.</dd>
<dd><code>reconnectIntervalMillis</code> - How to log sleep in milliseconds before trying to reconnect to JMS.</dd>
<dd><code>jndiProperties</code> - JNDI properties.</dd>
<dt>Returns:</dt>
<dd>The JmsManager as configured.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createMessage(java.io.Serializable)">
<h3>createMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">javax.jms.Message</span>&nbsp;<span class="element-name">createMessage</span><wbr><span class="parameters">(<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>&nbsp;object)</span>
throws <span class="exceptions">javax.jms.JMSException</span></div>
<div class="block">Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.
<p>
For instance, when using a text-based <a href="../../Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> such as
<a href="../../layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>PatternLayout</code></a>, the <a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>
message will be serialized to a String.
</p>
<p>
When using a layout such as <a href="../../layout/SerializedLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>SerializedLayout</code></a>, the LogEvent message
will be serialized as a Java object.
</p>
<p>
When using a layout such as <a href="../../layout/MessageLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>MessageLayout</code></a> and the LogEvent message
is a Log4j MapMessage, the message will be serialized as a JMS MapMessage.
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - The LogEvent or String message to wrap.</dd>
<dt>Returns:</dt>
<dd>A new JMS message containing the provided object.</dd>
<dt>Throws:</dt>
<dd><code>javax.jms.JMSException</code> - if the JMS provider fails to create this message due to some internal error.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createMessageConsumer()">
<h3>createMessageConsumer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">javax.jms.MessageConsumer</span>&nbsp;<span class="element-name">createMessageConsumer</span>()
throws <span class="exceptions">javax.jms.JMSException</span></div>
<div class="block">Creates a MessageConsumer on this Destination using the current Session.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A MessageConsumer on this Destination.</dd>
<dt>Throws:</dt>
<dd><code>javax.jms.JMSException</code> - if the session fails to create a consumer due to some internal error.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createMessageProducer(javax.jms.Session,javax.jms.Destination)">
<h3>createMessageProducer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">javax.jms.MessageProducer</span>&nbsp;<span class="element-name">createMessageProducer</span><wbr><span class="parameters">(javax.jms.Session&nbsp;session,
javax.jms.Destination&nbsp;destination)</span>
throws <span class="exceptions">javax.jms.JMSException</span></div>
<div class="block">Creates a MessageProducer on this Destination using the current Session.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>session</code> - The JMS Session to use to create the MessageProducer</dd>
<dd><code>destination</code> - The JMS Destination for the MessageProducer</dd>
<dt>Returns:</dt>
<dd>A MessageProducer on this Destination.</dd>
<dt>Throws:</dt>
<dd><code>javax.jms.JMSException</code> - if the session fails to create a MessageProducer due to some internal error.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getJmsManagerConfiguration()">
<h3>getJmsManagerConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a></span>&nbsp;<span class="element-name">getJmsManagerConfiguration</span>()</div>
</section>
</li>
<li>
<section class="detail" id="releaseSub(long,java.util.concurrent.TimeUnit)">
<h3>releaseSub</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">releaseSub</span><wbr><span class="parameters">(long&nbsp;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>&nbsp;timeUnit)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<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>
</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>