| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ActiveMQServerConsumerPlugin (ActiveMQ Artemis Website 2.32.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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="ActiveMQServerConsumerPlugin (ActiveMQ Artemis Website 2.32.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":18,"i2":18,"i3":50,"i4":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ActiveMQServerConsumerPlugin.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="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.activemq.artemis.core.server.plugin</a></div> |
| <h2 title="Interface ActiveMQServerConsumerPlugin" class="title">Interface ActiveMQServerConsumerPlugin</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ActiveMQServerBasePlugin.html" title="interface in org.apache.activemq.artemis.core.server.plugin">ActiveMQServerBasePlugin</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ActiveMQServerPlugin.html" title="interface in org.apache.activemq.artemis.core.server.plugin">ActiveMQServerPlugin</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ActiveMQServerConsumerPlugin</span> |
| extends <a href="ActiveMQServerBasePlugin.html" title="interface in org.apache.activemq.artemis.core.server.plugin">ActiveMQServerBasePlugin</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterCloseConsumer(org.apache.activemq.artemis.core.server.ServerConsumer,boolean)">afterCloseConsumer</a></span>​(org.apache.activemq.artemis.core.server.ServerConsumer consumer, |
| boolean failed)</code></th> |
| <td class="colLast"> |
| <div class="block">After a consumer is closed</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterCreateConsumer(org.apache.activemq.artemis.core.server.ServerConsumer)">afterCreateConsumer</a></span>​(org.apache.activemq.artemis.core.server.ServerConsumer consumer)</code></th> |
| <td class="colLast"> |
| <div class="block">After a consumer has been created</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeCloseConsumer(org.apache.activemq.artemis.core.server.ServerConsumer,boolean)">beforeCloseConsumer</a></span>​(org.apache.activemq.artemis.core.server.ServerConsumer consumer, |
| boolean failed)</code></th> |
| <td class="colLast"> |
| <div class="block">Before a consumer is closed</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeCreateConsumer(long,org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)">beforeCreateConsumer</a></span>​(long consumerID, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> queueName, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> filterString, |
| boolean browseOnly, |
| boolean supportLargeMessage)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#beforeCreateConsumer(long,org.apache.activemq.artemis.core.postoffice.QueueBinding,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)"><code>beforeCreateConsumer(long, QueueBinding, SimpleString, boolean, boolean)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeCreateConsumer(long,org.apache.activemq.artemis.core.postoffice.QueueBinding,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)">beforeCreateConsumer</a></span>​(long consumerID, |
| org.apache.activemq.artemis.core.postoffice.QueueBinding queueBinding, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> filterString, |
| boolean browseOnly, |
| boolean supportLargeMessage)</code></th> |
| <td class="colLast"> |
| <div class="block">Before a consumer is created</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.server.plugin.ActiveMQServerBasePlugin"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.<a href="ActiveMQServerBasePlugin.html" title="interface in org.apache.activemq.artemis.core.server.plugin">ActiveMQServerBasePlugin</a></h3> |
| <code><a href="ActiveMQServerBasePlugin.html#init(java.util.Map)">init</a>, <a href="ActiveMQServerBasePlugin.html#registered(org.apache.activemq.artemis.core.server.ActiveMQServer)">registered</a>, <a href="ActiveMQServerBasePlugin.html#setInit(java.util.Map)">setInit</a>, <a href="ActiveMQServerBasePlugin.html#unregistered(org.apache.activemq.artemis.core.server.ActiveMQServer)">unregistered</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="beforeCreateConsumer(long,org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeCreateConsumer</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default void beforeCreateConsumer​(long consumerID, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> queueName, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> filterString, |
| boolean browseOnly, |
| boolean supportLargeMessage) |
| throws <a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#beforeCreateConsumer(long,org.apache.activemq.artemis.core.postoffice.QueueBinding,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)"><code>beforeCreateConsumer(long, QueueBinding, SimpleString, boolean, boolean)</code></a></div> |
| </div> |
| <div class="block">Before a consumer is created</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumerID</code> - </dd> |
| <dd><code>queueName</code> - </dd> |
| <dd><code>filterString</code> - </dd> |
| <dd><code>browseOnly</code> - </dd> |
| <dd><code>supportLargeMessage</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="beforeCreateConsumer(long,org.apache.activemq.artemis.core.postoffice.QueueBinding,org.apache.activemq.artemis.api.core.SimpleString,boolean,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeCreateConsumer</h4> |
| <pre class="methodSignature">default void beforeCreateConsumer​(long consumerID, |
| org.apache.activemq.artemis.core.postoffice.QueueBinding queueBinding, |
| <a href="../../../api/core/SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> filterString, |
| boolean browseOnly, |
| boolean supportLargeMessage) |
| throws <a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">Before a consumer is created</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumerID</code> - </dd> |
| <dd><code>queueBinding</code> - </dd> |
| <dd><code>filterString</code> - </dd> |
| <dd><code>browseOnly</code> - </dd> |
| <dd><code>supportLargeMessage</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="afterCreateConsumer(org.apache.activemq.artemis.core.server.ServerConsumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterCreateConsumer</h4> |
| <pre class="methodSignature">default void afterCreateConsumer​(org.apache.activemq.artemis.core.server.ServerConsumer consumer) |
| throws <a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">After a consumer has been created</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - the created consumer</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="beforeCloseConsumer(org.apache.activemq.artemis.core.server.ServerConsumer,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeCloseConsumer</h4> |
| <pre class="methodSignature">default void beforeCloseConsumer​(org.apache.activemq.artemis.core.server.ServerConsumer consumer, |
| boolean failed) |
| throws <a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">Before a consumer is closed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - </dd> |
| <dd><code>failed</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="afterCloseConsumer(org.apache.activemq.artemis.core.server.ServerConsumer,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>afterCloseConsumer</h4> |
| <pre class="methodSignature">default void afterCloseConsumer​(org.apache.activemq.artemis.core.server.ServerConsumer consumer, |
| boolean failed) |
| throws <a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">After a consumer is closed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - </dd> |
| <dd><code>failed</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../api/core/ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ActiveMQServerConsumerPlugin.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="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |