| <!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 Tue Feb 25 21:03:09 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JmsManager (Apache Log4j Core 2.13.1 API)</title> |
| <meta name="date" content="2020-02-25"> |
| <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="JmsManager (Apache Log4j Core 2.13.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/appender/mom/JmsManager.html" target="_top">Frames</a></li> |
| <li><a href="JmsManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.appender.mom</div> |
| <h2 title="Class JmsManager" class="title">Class JmsManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.appender.mom.JmsManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.53">JmsManager</a> |
| extends <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></pre> |
| <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> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#count">count</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#LOGGER">LOGGER</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="https://docs.oracle.com/javaee/6/api/javax/jms/Message.html?is-external=true" title="class or interface in javax.jms">Message</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#createMessage-java.io.Serializable-">createMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> object)</code> |
| <div class="block">Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javaee/6/api/javax/jms/MessageConsumer.html?is-external=true" title="class or interface in javax.jms">MessageConsumer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#createMessageConsumer--">createMessageConsumer</a></span>()</code> |
| <div class="block">Creates a MessageConsumer on this Destination using the current Session.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javaee/6/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#createMessageProducer-javax.jms.Session-javax.jms.Destination-">createMessageProducer</a></span>(<a href="https://docs.oracle.com/javaee/6/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a> session, |
| <a href="https://docs.oracle.com/javaee/6/api/javax/jms/Destination.html?is-external=true" title="class or interface in javax.jms">Destination</a> destination)</code> |
| <div class="block">Creates a MessageProducer on this Destination using the current Session.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#getJmsManager-java.lang.String-java.util.Properties-java.lang.String-java.lang.String-java.lang.String-char:A-boolean-long-">getJmsManager</a></span>(<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> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> jndiProperties, |
| <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> connectionFactoryName, |
| <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> destinationName, |
| <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> userName, |
| char[] password, |
| boolean immediateFail, |
| long reconnectIntervalMillis)</code> |
| <div class="block">Gets a JmsManager using the specified configuration parameters.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#getJmsManagerConfiguration--">getJmsManagerConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html#releaseSub-long-java.util.concurrent.TimeUnit-">releaseSub</a></span>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">May be overridden by managers to perform processing while the manager is being released and the |
| lock is held.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#close--">close</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getContentFormat--">getContentFormat</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getCount--">getCount</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getLoggerContext--">getLoggerContext</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getManager-java.lang.String-org.apache.logging.log4j.core.appender.ManagerFactory-T-">getManager</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#getName--">getName</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#hasManager-java.lang.String-">hasManager</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#log-org.apache.logging.log4j.Level-java.lang.String-java.lang.Throwable-">log</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logDebug-java.lang.String-java.lang.Throwable-">logDebug</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logError-java.lang.String-java.lang.Throwable-">logError</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logger--">logger</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#logWarn-java.lang.String-java.lang.Throwable-">logWarn</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#narrow-java.lang.Class-org.apache.logging.log4j.core.appender.AbstractManager-">narrow</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#release--">release</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#stop-long-java.util.concurrent.TimeUnit-">stop</a>, <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#updateData-java.lang.Object-">updateData</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </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="getJmsManager-java.lang.String-java.util.Properties-java.lang.String-java.lang.String-java.lang.String-char:A-boolean-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJmsManager</h4> |
| <pre>public static <a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.225">getJmsManager</a>(<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> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> jndiProperties, |
| <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> connectionFactoryName, |
| <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> destinationName, |
| <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> userName, |
| char[] password, |
| boolean immediateFail, |
| long reconnectIntervalMillis)</pre> |
| <div class="block">Gets a JmsManager using the specified configuration parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to use for this JmsManager.</dd> |
| <dd><code>connectionFactoryName</code> - The binding name for the <a href="https://docs.oracle.com/javaee/6/api/javax/jms/ConnectionFactory.html?is-external=true" title="class or interface in javax.jms"><code>ConnectionFactory</code></a>.</dd> |
| <dd><code>destinationName</code> - The binding name for the <a href="https://docs.oracle.com/javaee/6/api/javax/jms/Destination.html?is-external=true" title="class or interface in javax.jms"><code>Destination</code></a>.</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="../../../../../../../org/apache/logging/log4j/core/appender/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><span class="returnLabel">Returns:</span></dt> |
| <dd>The JmsManager as configured.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMessage-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMessage</h4> |
| <pre>public <a href="https://docs.oracle.com/javaee/6/api/javax/jms/Message.html?is-external=true" title="class or interface in javax.jms">Message</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.354">createMessage</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> object) |
| throws <a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></pre> |
| <div class="block">Creates a TextMessage, MapMessage, or ObjectMessage from a Serializable object. |
| <p> |
| For instance, when using a text-based <a href="../../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> such as |
| <a href="../../../../../../../org/apache/logging/log4j/core/layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>PatternLayout</code></a>, the <a href="../../../../../../../org/apache/logging/log4j/core/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="../../../../../../../org/apache/logging/log4j/core/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="../../../../../../../org/apache/logging/log4j/core/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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - The LogEvent or String message to wrap.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new JMS message containing the provided object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMessageConsumer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMessageConsumer</h4> |
| <pre>public <a href="https://docs.oracle.com/javaee/6/api/javax/jms/MessageConsumer.html?is-external=true" title="class or interface in javax.jms">MessageConsumer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.375">createMessageConsumer</a>() |
| throws <a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></pre> |
| <div class="block">Creates a MessageConsumer on this Destination using the current Session.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A MessageConsumer on this Destination.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMessageProducer-javax.jms.Session-javax.jms.Destination-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMessageProducer</h4> |
| <pre>public <a href="https://docs.oracle.com/javaee/6/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.389">createMessageProducer</a>(<a href="https://docs.oracle.com/javaee/6/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a> session, |
| <a href="https://docs.oracle.com/javaee/6/api/javax/jms/Destination.html?is-external=true" title="class or interface in javax.jms">Destination</a> destination) |
| throws <a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></pre> |
| <div class="block">Creates a MessageProducer on this Destination using the current Session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>A MessageProducer on this Destination.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javaee/6/api/javax/jms/JMSException.html?is-external=true" title="class or interface in javax.jms">JMSException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJmsManagerConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJmsManagerConfiguration</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsManager.JmsManagerConfiguration</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.405">getJmsManagerConfiguration</a>()</pre> |
| </li> |
| </ul> |
| <a name="releaseSub-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>releaseSub</h4> |
| <pre>protected boolean <a href="../../../../../../../src-html/org/apache/logging/log4j/core/appender/mom/JmsManager.html#line.435">releaseSub</a>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/logging/log4j/core/appender/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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html#releaseSub-long-java.util.concurrent.TimeUnit-">releaseSub</a></code> in class <code><a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - timeout</dd> |
| <dd><code>timeUnit</code> - timeout time unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if all resources were closed normally, false otherwise.</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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/appender/mom/JmsManager.JmsManagerConfiguration.html" title="class in org.apache.logging.log4j.core.appender.mom"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/appender/mom/JmsManager.html" target="_top">Frames</a></li> |
| <li><a href="JmsManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractManager">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 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> |
