Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-core / org / apache / logging / log4j / core / appender / mom / JmsAppender.html
blob: 19088041080679ef765f4d10b1896387fe7dd22f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>JmsAppender (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: JmsAppender">
<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/JmsAppender.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><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&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 JmsAppender" class="title">Class JmsAppender</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="../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a>
<div class="inheritance"><a href="../../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable</a>
<div class="inheritance"><a href="../AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractAppender</a>
<div class="inheritance">org.apache.logging.log4j.core.appender.mom.JmsAppender</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></code>, <code><a href="../../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></code>, <code><a href="../../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations"><a href="../../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../../config/plugins/Plugin.html#name()">name</a>="JMS",
<a href="../../config/plugins/Plugin.html#category()">category</a>="Core",
<a href="../../config/plugins/Plugin.html#elementType()">elementType</a>="appender",
<a href="../../config/plugins/Plugin.html#printObject()">printObject</a>=true)
<a href="../../config/plugins/PluginAliases.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAliases</a>({"JMSQueue","JMSTopic"})
</span><span class="modifiers">public class </span><span class="element-name type-name-label">JmsAppender</span>
<span class="extends-implements">extends <a href="../AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></span></div>
<div class="block">Generic JMS Appender plugin for both queues and topics. This Appender replaces the previous split ones. However,
configurations set up for the 2.0 version of the JMS appenders will still work.</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="JmsAppender.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender.Builder</a>&lt;<a href="JmsAppender.Builder.html" title="type parameter in JmsAppender.Builder">B</a> extends <a href="JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender.Builder</a>&lt;<a href="JmsAppender.Builder.html" title="type parameter in JmsAppender.Builder">B</a>&gt;&gt;</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.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="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class&nbsp;org.apache.logging.log4j.core.<a href="../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3>
<code><a href="../../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../../AbstractLifeCycle.html#LOGGER">LOGGER</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Appender">Fields inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="../../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></h3>
<code><a href="../../Appender.html#ELEMENT_TYPE">ELEMENT_TYPE</a>, <a href="../../Appender.html#EMPTY_ARRAY">EMPTY_ARRAY</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,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.appender.mom.JmsManager)" class="member-name-link">JmsAppender</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="../../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter,
<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;&nbsp;layout,
boolean&nbsp;ignoreExceptions,
<a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a>&nbsp;manager)</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,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.appender.mom.JmsManager)"><code>JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager)</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,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.appender.mom.JmsManager)" class="member-name-link">JmsAppender</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="../../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter,
<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;&nbsp;layout,
boolean&nbsp;ignoreExceptions,
<a href="../../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[]&nbsp;properties,
<a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a>&nbsp;manager)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructs a new instance.</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-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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
<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-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#getManager()" class="member-name-link">getManager</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 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>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop(long,java.util.concurrent.TimeUnit)" class="member-name-link">stop</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">Cleanup the Filter.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractAppender">Methods inherited from class&nbsp;org.apache.logging.log4j.core.appender.<a href="../AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></h3>
<code><a href="../AbstractAppender.html#error(java.lang.String)">error</a>, <a href="../AbstractAppender.html#error(java.lang.String,java.lang.Throwable)">error</a>, <a href="../AbstractAppender.html#error(java.lang.String,org.apache.logging.log4j.core.LogEvent,java.lang.Throwable)">error</a>, <a href="../AbstractAppender.html#getHandler()">getHandler</a>, <a href="../AbstractAppender.html#getLayout()">getLayout</a>, <a href="../AbstractAppender.html#getName()">getName</a>, <a href="../AbstractAppender.html#ignoreExceptions()">ignoreExceptions</a>, <a href="../AbstractAppender.html#parseInt(java.lang.String,int)">parseInt</a>, <a href="../AbstractAppender.html#requiresLocation()">requiresLocation</a>, <a href="../AbstractAppender.html#setHandler(org.apache.logging.log4j.core.ErrorHandler)">setHandler</a>, <a href="../AbstractAppender.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">toSerializable</a>, <a href="../AbstractAppender.html#toString()">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable">Methods inherited from class&nbsp;org.apache.logging.log4j.core.filter.<a href="../../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h3>
<code><a href="../../filter/AbstractFilterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../../filter/AbstractFilterable.html#getFilter()">getFilter</a>, <a href="../../filter/AbstractFilterable.html#getPropertyArray()">getPropertyArray</a>, <a href="../../filter/AbstractFilterable.html#hasFilter()">hasFilter</a>, <a href="../../filter/AbstractFilterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../../filter/AbstractFilterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a>, <a href="../../filter/AbstractFilterable.html#start()">start</a>, <a href="../../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit,boolean)">stop</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class&nbsp;org.apache.logging.log4j.core.<a href="../../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3>
<code><a href="../../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../../AbstractLifeCycle.html#getState()">getState</a>, <a href="../../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../../AbstractLifeCycle.html#stop()">stop</a>, <a href="../../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</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#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>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.config.Property[],org.apache.logging.log4j.core.appender.mom.JmsManager)">
<h3>JmsAppender</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">JmsAppender</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="../../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter,
<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;&nbsp;layout,
boolean&nbsp;ignoreExceptions,
<a href="../../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[]&nbsp;properties,
<a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a>&nbsp;manager)</span>
throws <span class="exceptions">javax.jms.JMSException</span></div>
<div class="block">Constructs a new instance.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>javax.jms.JMSException</code> - not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.appender.mom.JmsManager)">
<h3>JmsAppender</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>&nbsp;<span class="element-name">JmsAppender</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="../../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter,
<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;&nbsp;layout,
boolean&nbsp;ignoreExceptions,
<a href="JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a>&nbsp;manager)</span>
throws <span class="exceptions">javax.jms.JMSException</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.Layout,boolean,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.appender.mom.JmsManager)"><code>JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager)</code></a>.</div>
</div>
<div class="block">Constructs a new instance.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>javax.jms.JMSException</code> - not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0</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="newBuilder()">
<h3>newBuilder</h3>
<div class="member-signature"><span class="annotations"><a href="../../config/plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender.Builder</a></span>&nbsp;<span class="element-name">newBuilder</span>()</div>
</section>
</li>
<li>
<section class="detail" id="append(org.apache.logging.log4j.core.LogEvent)">
<h3>append</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../Appender.html#append(org.apache.logging.log4j.core.LogEvent)">Appender</a></code></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="getManager()">
<h3>getManager</h3>
<div class="member-signature"><span class="modifiers">public</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">getManager</span>()</div>
</section>
</li>
<li>
<section class="detail" id="stop(long,java.util.concurrent.TimeUnit)">
<h3>stop</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">stop</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="../../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">AbstractFilterable</a></code></span></div>
<div class="block">Cleanup the Filter.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../LifeCycle2.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code>&nbsp;in class&nbsp;<code><a href="../../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code></dd>
<dt>Parameters:</dt>
<dd><code>timeout</code> - the maximum time to wait</dd>
<dd><code>timeUnit</code> - the time unit of the timeout argument</dd>
<dt>Returns:</dt>
<dd>true if the receiver was stopped cleanly and 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>