blob: b5ab032c71f69e60279663b4536d2c6ee1772c4a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>QueueControl (ActiveMQ Artemis Website 2.33.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="QueueControl (ActiveMQ Artemis Website 2.33.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":38,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":6,"i100":6,"i101":6,"i102":6,"i103":6,"i104":6,"i105":6,"i106":6,"i107":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/QueueControl.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.activemq.artemis.api.core.management</a></div>
<h2 title="Interface QueueControl" class="title">Interface QueueControl</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">QueueControl</span></pre>
<div class="block">A QueueControl is used to manage a queue.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONSUMER_COUNT_DESCRIPTION">CONSUMER_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DELIVERING_MESSAGE_COUNT_DESCRIPTION">DELIVERING_MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DELIVERING_SIZE_DESCRIPTION">DELIVERING_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION">DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_DELIVERING_SIZE_DESCRIPTION">DURABLE_DELIVERING_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_MESSAGE_COUNT_DESCRIPTION">DURABLE_MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_PERSISTENT_SIZE_DESCRIPTION">DURABLE_PERSISTENT_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION">DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DURABLE_SCHEDULED_SIZE_DESCRIPTION">DURABLE_SCHEDULED_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGE_COUNT_DESCRIPTION">MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGES_ACKNOWLEDGED_DESCRIPTION">MESSAGES_ACKNOWLEDGED_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGES_ADDED_DESCRIPTION">MESSAGES_ADDED_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGES_EXPIRED_DESCRIPTION">MESSAGES_EXPIRED_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGES_KILLED_DESCRIPTION">MESSAGES_KILLED_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PERSISTENT_SIZE_DESCRIPTION">PERSISTENT_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCHEDULED_MESSAGE_COUNT_DESCRIPTION">SCHEDULED_MESSAGE_COUNT_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCHEDULED_SIZE_DESCRIPTION">SCHEDULED_SIZE_DESCRIPTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#browse()">browse</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#browse(int,int)">browse</a></span>&#8203;(int&nbsp;page,
int&nbsp;pageSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#browse(int,int,java.lang.String)">browse</a></span>&#8203;(int&nbsp;page,
int&nbsp;pageSize,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#browse(java.lang.String)">browse</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#changeMessagePriority(long,int)">changeMessagePriority</a></span>&#8203;(long&nbsp;messageID,
int&nbsp;newPriority)</code></th>
<td class="colLast">
<div class="block">Changes the message's priority corresponding to the specified message ID to the specified priority.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#changeMessagesPriority(java.lang.String,int)">changeMessagesPriority</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
int&nbsp;newPriority)</code></th>
<td class="colLast">
<div class="block">Changes the priority for all the message corresponding to the specified filter to the specified priority.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countDeliveringMessages(java.lang.String)">countDeliveringMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Counts the number of delivering messages in this queue matching the specified filter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countDeliveringMessages(java.lang.String,java.lang.String)">countDeliveringMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupByProperty)</code></th>
<td class="colLast">
<div class="block">Counts the number of delivering messages in this queue matching the specified filter, grouped by the given property field.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countMessages()">countMessages</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countMessages(java.lang.String)">countMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Counts the number of messages in this queue matching the specified filter.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countMessages(java.lang.String,java.lang.String)">countMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupByProperty)</code></th>
<td class="colLast">
<div class="block">Counts the number of messages in this queue matching the specified filter, grouped by the given property field.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliverScheduledMessage(long)">deliverScheduledMessage</a></span>&#8203;(long&nbsp;messageId)</code></th>
<td class="colLast">
<div class="block">Deliver the scheduled message with the specified message ID</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliverScheduledMessages(java.lang.String)">deliverScheduledMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Deliver the scheduled messages which match the filter</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disable()">disable</a></span>()</code></th>
<td class="colLast">
<div class="block">Enables the queue.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enable()">enable</a></span>()</code></th>
<td class="colLast">
<div class="block">Enables the queue.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expireMessage(long)">expireMessage</a></span>&#8203;(long&nbsp;messageID)</code></th>
<td class="colLast">
<div class="block">Expires the message corresponding to the specified message ID.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expireMessages(java.lang.String)">expireMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Expires all the message corresponding to the specified filter.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushExecutor()">flushExecutor</a></span>()</code></th>
<td class="colLast">
<div class="block">it will flush one cycle on internal executors, so you would be sure that any pending tasks are done before you call
any other measure.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAcknowledgeAttempts()">getAcknowledgeAttempts</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddress()">getAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the address this queue is bound to.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsumerCount()">getConsumerCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of consumers consuming messages from this queue.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsumersBeforeDispatch()">getConsumersBeforeDispatch</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the Consumers Before Dispatch</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeadLetterAddress()">getDeadLetterAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the dead-letter address associated with this queue.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDelayBeforeDispatch()">getDelayBeforeDispatch</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the Consumers Before Dispatch</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeliveringCount()">getDeliveringCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages that this queue is currently delivering to its consumers.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeliveringSize()">getDeliveringSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the persistent size of messages that this queue is currently delivering to its consumers.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableDeliveringCount()">getDurableDeliveringCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of durable messages that this queue is currently delivering to its consumers.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableDeliveringSize()">getDurableDeliveringSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the size of durable messages that this queue is currently delivering to its consumers.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableMessageCount()">getDurableMessageCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of durable messages currently in this queue.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurablePersistentSize()">getDurablePersistentSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the persistent size of durable messages currently in this queue.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableScheduledCount()">getDurableScheduledCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of durable scheduled messages in this queue.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDurableScheduledSize()">getDurableScheduledSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the size of durable scheduled messages in this queue.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpiryAddress()">getExpiryAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the expiry address associated with this queue.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilter()">getFilter</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the filter associated with this queue.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstMessageAge()">getFirstMessageAge</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the age of the first message in milliseconds.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstMessageAsJSON()">getFirstMessageAsJSON</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the first message on the queue as JSON</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstMessageTimestamp()">getFirstMessageTimestamp</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the timestamp of the first message in milliseconds.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupBuckets()">getGroupBuckets</a></span>()</code></th>
<td class="colLast">
<div class="block">Will return the group buckets.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupCount()">getGroupCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Will return the current number of active groups.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupFirstKey()">getGroupFirstKey</a></span>()</code></th>
<td class="colLast">
<div class="block">Will return the header key to notify a consumer of a group change.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getID()">getID</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns this queue ID.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastValueKey()">getLastValueKey</a></span>()</code></th>
<td class="colLast">
<div class="block">The key used for the last value queues</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxConsumers()">getMaxConsumers</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageCount()">getMessageCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages currently in this queue.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesAcknowledged()">getMessagesAcknowledged</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesAdded()">getMessagesAdded</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesExpired()">getMessagesExpired</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages expired from this queue since it was created.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesKilled()">getMessagesKilled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of this queue.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSize()">getPersistentSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the persistent size of all messages currently in this queue.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPreparedTransactionMessageCount()">getPreparedTransactionMessageCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Will return the number of messages stuck in prepared transactions</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRingSize()">getRingSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Will return the ring size.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoutingType()">getRoutingType</a></span>()</code></th>
<td class="colLast">
<div class="block">The routing type of this queue.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduledCount()">getScheduledCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of scheduled messages in this queue.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduledSize()">getScheduledSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the size of scheduled messages in this queue.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUser()">getUser</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the user that is associated with creating the queue.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAutoDelete()">isAutoDelete</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this queue is available for auto deletion.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConfigurationManaged()">isConfigurationManaged</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDurable()">isDurable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this queue is durable.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnabled()">isEnabled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExclusive()">isExclusive</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGroupRebalance()">isGroupRebalance</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the groups of this queue are automatically rebalanced.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGroupRebalancePauseDispatch()">isGroupRebalancePauseDispatch</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the dispatch is paused when groups of this queue are automatically rebalanced.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLastValue()">isLastValue</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPaused()">isPaused</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the queue is paused.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPurgeOnNoConsumers()">isPurgeOnNoConsumers</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRetroactiveResource()">isRetroactiveResource</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this queue is used for a retroactive address.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTemporary()">isTemporary</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this queue is temporary.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listConsumersAsJSON()">listConsumersAsJSON</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDeliveringMessages()">listDeliveringMessages</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists all the messages being deliver per consumer.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDeliveringMessagesAsJSON()">listDeliveringMessagesAsJSON</a></span>()</code></th>
<td class="colLast">
<div class="block">Executes a conversion of <a href="#listDeliveringMessages()"><code>listDeliveringMessages()</code></a> to JSON</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listGroupsAsJSON()">listGroupsAsJSON</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessageCounter()">listMessageCounter</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists the message counter for this queue.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessageCounterAsHTML()">listMessageCounterAsHTML</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists the message counter for this queue as a HTML table.</div>
</td>
</tr>
<tr id="i74" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessageCounterHistory()">listMessageCounterHistory</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists the message counter history for this queue.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessageCounterHistoryAsHTML()">listMessageCounterHistoryAsHTML</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i76" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessages(java.lang.String)">listMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Lists all the messages in this queue matching the specified filter.</div>
</td>
</tr>
<tr id="i77" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMessagesAsJSON(java.lang.String)">listMessagesAsJSON</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Lists all the messages in this queue matching the specified filter using JSON serialization.</div>
</td>
</tr>
<tr id="i78" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listScheduledMessages()">listScheduledMessages</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists all the messages scheduled for delivery for this queue.</div>
</td>
</tr>
<tr id="i79" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listScheduledMessagesAsJSON()">listScheduledMessagesAsJSON</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists all the messages scheduled for delivery for this queue using JSON serialization.</div>
</td>
</tr>
<tr id="i80" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessage(long,java.lang.String)">moveMessage</a></span>&#8203;(long&nbsp;messageID,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName)</code></th>
<td class="colLast">
<div class="block">Moves the message corresponding to the specified message ID to the specified other queue.</div>
</td>
</tr>
<tr id="i81" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessage(long,java.lang.String,boolean)">moveMessage</a></span>&#8203;(long&nbsp;messageID,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)</code></th>
<td class="colLast">
<div class="block">Moves the message corresponding to the specified message ID to the specified other queue.</div>
</td>
</tr>
<tr id="i82" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessages(int,java.lang.String,java.lang.String,boolean)">moveMessages</a></span>&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i83" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessages(int,java.lang.String,java.lang.String,boolean,int)">moveMessages</a></span>&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates,
int&nbsp;messageCount)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i84" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessages(java.lang.String,java.lang.String)">moveMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName)</code></th>
<td class="colLast">
<div class="block">Moves all the message corresponding to the specified filter to the specified other queue.</div>
</td>
</tr>
<tr id="i85" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveMessages(java.lang.String,java.lang.String,boolean)">moveMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)</code></th>
<td class="colLast">
<div class="block">Moves all the message corresponding to the specified filter to the specified other queue.</div>
</td>
</tr>
<tr id="i86" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pause()">pause</a></span>()</code></th>
<td class="colLast">
<div class="block">Pauses the queue.</div>
</td>
</tr>
<tr id="i87" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pause(boolean)">pause</a></span>&#8203;(boolean&nbsp;persist)</code></th>
<td class="colLast">
<div class="block">Pauses the queue.</div>
</td>
</tr>
<tr id="i88" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#peekFirstMessageAsJSON()">peekFirstMessageAsJSON</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the first message on the queue as JSON</div>
</td>
</tr>
<tr id="i89" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#peekFirstScheduledMessageAsJSON()">peekFirstScheduledMessageAsJSON</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the first scheduled message on the queue as JSON</div>
</td>
</tr>
<tr id="i90" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllMessages()">removeAllMessages</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes all the message from the queue.</div>
</td>
</tr>
<tr id="i91" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMessage(long)">removeMessage</a></span>&#8203;(long&nbsp;messageID)</code></th>
<td class="colLast">
<div class="block">Removes the message corresponding to the specified message ID.</div>
</td>
</tr>
<tr id="i92" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMessages(int,java.lang.String)">removeMessages</a></span>&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Removes all the message corresponding to the specified filter.</div>
</td>
</tr>
<tr id="i93" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMessages(java.lang.String)">removeMessages</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Removes all the message corresponding to the specified filter.</div>
</td>
</tr>
<tr id="i94" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetAllGroups()">resetAllGroups</a></span>()</code></th>
<td class="colLast">
<div class="block">Will reset the all the groups.</div>
</td>
</tr>
<tr id="i95" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetGroup(java.lang.String)">resetGroup</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupID)</code></th>
<td class="colLast">
<div class="block">Will reset the group matching the given groupID.</div>
</td>
</tr>
<tr id="i96" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetMessageCounter()">resetMessageCounter</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the message counter for this queue.</div>
</td>
</tr>
<tr id="i97" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetMessagesAcknowledged()">resetMessagesAcknowledged</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the MessagesAdded property</div>
</td>
</tr>
<tr id="i98" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetMessagesAdded()">resetMessagesAdded</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the MessagesAdded property</div>
</td>
</tr>
<tr id="i99" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetMessagesExpired()">resetMessagesExpired</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the MessagesExpired property</div>
</td>
</tr>
<tr id="i100" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetMessagesKilled()">resetMessagesKilled</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the MessagesExpired property</div>
</td>
</tr>
<tr id="i101" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resume()">resume</a></span>()</code></th>
<td class="colLast">
<div class="block">Resumes the queue.</div>
</td>
</tr>
<tr id="i102" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#retryMessage(long)">retryMessage</a></span>&#8203;(long&nbsp;messageID)</code></th>
<td class="colLast">
<div class="block">Retries the message corresponding to the given messageID to the original queue.</div>
</td>
</tr>
<tr id="i103" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#retryMessages()">retryMessages</a></span>()</code></th>
<td class="colLast">
<div class="block">Retries all messages on a DLQ to their respective original queues.</div>
</td>
</tr>
<tr id="i104" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessage(java.util.Map,int,java.lang.String,boolean,java.lang.String,java.lang.String)">sendMessage</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;headers,
int&nbsp;type,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;body,
boolean&nbsp;durable,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;user,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i105" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessage(java.util.Map,int,java.lang.String,boolean,java.lang.String,java.lang.String,boolean)">sendMessage</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;headers,
int&nbsp;type,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;body,
boolean&nbsp;durable,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;user,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password,
boolean&nbsp;createMessageId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i106" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessagesToDeadLetterAddress(java.lang.String)">sendMessagesToDeadLetterAddress</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filterStr)</code></th>
<td class="colLast">
<div class="block">Sends all the message corresponding to the specified filter to this queue's dead letter address.</div>
</td>
</tr>
<tr id="i107" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessageToDeadLetterAddress(long)">sendMessageToDeadLetterAddress</a></span>&#8203;(long&nbsp;messageID)</code></th>
<td class="colLast">
<div class="block">Sends the message corresponding to the specified message ID to this queue's dead letter address.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="PERSISTENT_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERSISTENT_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> PERSISTENT_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.PERSISTENT_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_PERSISTENT_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_PERSISTENT_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_PERSISTENT_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_PERSISTENT_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SCHEDULED_MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SCHEDULED_MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> SCHEDULED_MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.SCHEDULED_MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_SCHEDULED_MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SCHEDULED_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SCHEDULED_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> SCHEDULED_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.SCHEDULED_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_SCHEDULED_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_SCHEDULED_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_SCHEDULED_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_SCHEDULED_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DELIVERING_MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELIVERING_MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DELIVERING_MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DELIVERING_MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_DELIVERING_MESSAGE_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DELIVERING_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELIVERING_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DELIVERING_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DELIVERING_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DURABLE_DELIVERING_SIZE_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DURABLE_DELIVERING_SIZE_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DURABLE_DELIVERING_SIZE_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.DURABLE_DELIVERING_SIZE_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="CONSUMER_COUNT_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONSUMER_COUNT_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> CONSUMER_COUNT_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.CONSUMER_COUNT_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MESSAGES_ADDED_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MESSAGES_ADDED_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> MESSAGES_ADDED_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.MESSAGES_ADDED_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MESSAGES_ACKNOWLEDGED_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MESSAGES_ACKNOWLEDGED_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> MESSAGES_ACKNOWLEDGED_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.MESSAGES_ACKNOWLEDGED_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MESSAGES_EXPIRED_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MESSAGES_EXPIRED_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> MESSAGES_EXPIRED_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.MESSAGES_EXPIRED_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MESSAGES_KILLED_DESCRIPTION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MESSAGES_KILLED_DESCRIPTION</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> MESSAGES_KILLED_DESCRIPTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.activemq.artemis.api.core.management.QueueControl.MESSAGES_KILLED_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getName()</pre>
<div class="block">Returns the name of this queue.</div>
</li>
</ul>
<a id="getAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getAddress()</pre>
<div class="block">Returns the address this queue is bound to.</div>
</li>
</ul>
<a id="getID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre class="methodSignature">long&nbsp;getID()</pre>
<div class="block">Returns this queue ID.</div>
</li>
</ul>
<a id="isTemporary()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTemporary</h4>
<pre class="methodSignature">boolean&nbsp;isTemporary()</pre>
<div class="block">Returns whether this queue is temporary.</div>
</li>
</ul>
<a id="isRetroactiveResource()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRetroactiveResource</h4>
<pre class="methodSignature">boolean&nbsp;isRetroactiveResource()</pre>
<div class="block">Returns whether this queue is used for a retroactive address.</div>
</li>
</ul>
<a id="isDurable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDurable</h4>
<pre class="methodSignature">boolean&nbsp;isDurable()</pre>
<div class="block">Returns whether this queue is durable.</div>
</li>
</ul>
<a id="getUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getUser()</pre>
<div class="block">Returns the user that is associated with creating the queue.</div>
</li>
</ul>
<a id="getRoutingType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoutingType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getRoutingType()</pre>
<div class="block">The routing type of this queue.</div>
</li>
</ul>
<a id="getFilter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getFilter()</pre>
<div class="block">Returns the filter associated with this queue.</div>
</li>
</ul>
<a id="getMessageCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageCount</h4>
<pre class="methodSignature">long&nbsp;getMessageCount()</pre>
<div class="block">Returns the number of messages currently in this queue.</div>
</li>
</ul>
<a id="getPersistentSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistentSize</h4>
<pre class="methodSignature">long&nbsp;getPersistentSize()</pre>
<div class="block">Returns the persistent size of all messages currently in this queue. The persistent size of a message
is the amount of space the message would take up on disk which is used to track how much data there
is to consume on this queue</div>
</li>
</ul>
<a id="getDurableMessageCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurableMessageCount</h4>
<pre class="methodSignature">long&nbsp;getDurableMessageCount()</pre>
<div class="block">Returns the number of durable messages currently in this queue.</div>
</li>
</ul>
<a id="getDurablePersistentSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurablePersistentSize</h4>
<pre class="methodSignature">long&nbsp;getDurablePersistentSize()</pre>
<div class="block">Returns the persistent size of durable messages currently in this queue. The persistent size of a message
is the amount of space the message would take up on disk which is used to track how much data there
is to consume on this queue</div>
</li>
</ul>
<a id="getScheduledCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheduledCount</h4>
<pre class="methodSignature">long&nbsp;getScheduledCount()</pre>
<div class="block">Returns the number of scheduled messages in this queue.</div>
</li>
</ul>
<a id="getScheduledSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheduledSize</h4>
<pre class="methodSignature">long&nbsp;getScheduledSize()</pre>
<div class="block">Returns the size of scheduled messages in this queue.</div>
</li>
</ul>
<a id="getDurableScheduledCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurableScheduledCount</h4>
<pre class="methodSignature">long&nbsp;getDurableScheduledCount()</pre>
<div class="block">Returns the number of durable scheduled messages in this queue.</div>
</li>
</ul>
<a id="getDurableScheduledSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurableScheduledSize</h4>
<pre class="methodSignature">long&nbsp;getDurableScheduledSize()</pre>
<div class="block">Returns the size of durable scheduled messages in this queue.</div>
</li>
</ul>
<a id="getConsumerCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsumerCount</h4>
<pre class="methodSignature">int&nbsp;getConsumerCount()</pre>
<div class="block">Returns the number of consumers consuming messages from this queue.</div>
</li>
</ul>
<a id="getDeliveringCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeliveringCount</h4>
<pre class="methodSignature">int&nbsp;getDeliveringCount()</pre>
<div class="block">Returns the number of messages that this queue is currently delivering to its consumers.</div>
</li>
</ul>
<a id="getDeliveringSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeliveringSize</h4>
<pre class="methodSignature">long&nbsp;getDeliveringSize()</pre>
<div class="block">Returns the persistent size of messages that this queue is currently delivering to its consumers.</div>
</li>
</ul>
<a id="getDurableDeliveringCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurableDeliveringCount</h4>
<pre class="methodSignature">int&nbsp;getDurableDeliveringCount()</pre>
<div class="block">Returns the number of durable messages that this queue is currently delivering to its consumers.</div>
</li>
</ul>
<a id="getDurableDeliveringSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurableDeliveringSize</h4>
<pre class="methodSignature">long&nbsp;getDurableDeliveringSize()</pre>
<div class="block">Returns the size of durable messages that this queue is currently delivering to its consumers.</div>
</li>
</ul>
<a id="getMessagesAdded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesAdded</h4>
<pre class="methodSignature">long&nbsp;getMessagesAdded()</pre>
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</li>
</ul>
<a id="getMessagesAcknowledged()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesAcknowledged</h4>
<pre class="methodSignature">long&nbsp;getMessagesAcknowledged()</pre>
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</li>
</ul>
<a id="getAcknowledgeAttempts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAcknowledgeAttempts</h4>
<pre class="methodSignature">long&nbsp;getAcknowledgeAttempts()</pre>
<div class="block">Returns the number of messages added to this queue since it was created.</div>
</li>
</ul>
<a id="getMessagesExpired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesExpired</h4>
<pre class="methodSignature">long&nbsp;getMessagesExpired()</pre>
<div class="block">Returns the number of messages expired from this queue since it was created.</div>
</li>
</ul>
<a id="getMessagesKilled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesKilled</h4>
<pre class="methodSignature">long&nbsp;getMessagesKilled()</pre>
<div class="block">Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.</div>
</li>
</ul>
<a id="getFirstMessageAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstMessageAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getFirstMessageAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns the first message on the queue as JSON</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="getFirstMessageTimestamp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstMessageTimestamp</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>&nbsp;getFirstMessageTimestamp()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns the timestamp of the first message in milliseconds.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="getFirstMessageAge()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstMessageAge</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>&nbsp;getFirstMessageAge()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns the age of the first message in milliseconds.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="getExpiryAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpiryAddress</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getExpiryAddress()</pre>
<div class="block">Returns the expiry address associated with this queue.</div>
</li>
</ul>
<a id="getDeadLetterAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeadLetterAddress</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getDeadLetterAddress()</pre>
<div class="block">Returns the dead-letter address associated with this queue.</div>
</li>
</ul>
<a id="getMaxConsumers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxConsumers</h4>
<pre class="methodSignature">int&nbsp;getMaxConsumers()</pre>
</li>
</ul>
<a id="isPurgeOnNoConsumers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPurgeOnNoConsumers</h4>
<pre class="methodSignature">boolean&nbsp;isPurgeOnNoConsumers()</pre>
</li>
</ul>
<a id="isEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre class="methodSignature">boolean&nbsp;isEnabled()</pre>
</li>
</ul>
<a id="enable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre class="methodSignature">void&nbsp;enable()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Enables the queue. Messages are now routed to this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="disable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disable</h4>
<pre class="methodSignature">void&nbsp;disable()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Enables the queue. Messages are not routed to this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="isConfigurationManaged()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConfigurationManaged</h4>
<pre class="methodSignature">boolean&nbsp;isConfigurationManaged()</pre>
</li>
</ul>
<a id="isExclusive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExclusive</h4>
<pre class="methodSignature">boolean&nbsp;isExclusive()</pre>
</li>
</ul>
<a id="isLastValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLastValue</h4>
<pre class="methodSignature">boolean&nbsp;isLastValue()</pre>
</li>
</ul>
<a id="getLastValueKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastValueKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getLastValueKey()</pre>
<div class="block">The key used for the last value queues</div>
</li>
</ul>
<a id="getConsumersBeforeDispatch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsumersBeforeDispatch</h4>
<pre class="methodSignature">int&nbsp;getConsumersBeforeDispatch()</pre>
<div class="block">Return the Consumers Before Dispatch</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a id="getDelayBeforeDispatch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelayBeforeDispatch</h4>
<pre class="methodSignature">long&nbsp;getDelayBeforeDispatch()</pre>
<div class="block">Return the Consumers Before Dispatch</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a id="listScheduledMessages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listScheduledMessages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]&nbsp;listScheduledMessages()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists all the messages scheduled for delivery for this queue.
<br>
1 Map represents 1 message, keys are the message's properties and headers, values are the corresponding values.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listScheduledMessagesAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listScheduledMessagesAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listScheduledMessagesAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists all the messages scheduled for delivery for this queue using JSON serialization.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listDeliveringMessages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listDeliveringMessages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]&gt;&nbsp;listDeliveringMessages()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists all the messages being deliver per consumer.
<br>
The Map's key is a toString representation for the consumer. Each consumer will then return a <code>Map&lt;String,Object&gt;[]</code> same way is returned by <a href="#listScheduledMessages()"><code>listScheduledMessages()</code></a></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listDeliveringMessagesAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listDeliveringMessagesAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listDeliveringMessagesAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Executes a conversion of <a href="#listDeliveringMessages()"><code>listDeliveringMessages()</code></a> to JSON</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;[]&nbsp;listMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists all the messages in this queue matching the specified filter.
<br>
1 Map represents 1 message, keys are the message's properties and headers, values are the corresponding values.
<br>
Using <code>null</code> or an empty filter will list <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessagesAsJSON(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessagesAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listMessagesAsJSON&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists all the messages in this queue matching the specified filter using JSON serialization.
<br>
Using <code>null</code> or an empty filter will list <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="countMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countMessages</h4>
<pre class="methodSignature">long&nbsp;countMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Counts the number of messages in this queue matching the specified filter.
<br>
Using <code>null</code> or an empty filter will count <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="countMessages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countMessages</h4>
<pre class="methodSignature">long&nbsp;countMessages()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="countMessages(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countMessages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;countMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupByProperty)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Counts the number of messages in this queue matching the specified filter, grouped by the given property field.
In case of null property will be grouped in "null"
<br>
Using <code>null</code> or an empty filter will count <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="countDeliveringMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countDeliveringMessages</h4>
<pre class="methodSignature">long&nbsp;countDeliveringMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Counts the number of delivering messages in this queue matching the specified filter.
<br>
Using <code>null</code> or an empty filter will count <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="countDeliveringMessages(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countDeliveringMessages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;countDeliveringMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupByProperty)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Counts the number of delivering messages in this queue matching the specified filter, grouped by the given property field.
In case of null property will be grouped in "null"
<br>
Using <code>null</code> or an empty filter will count <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="removeMessage(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMessage</h4>
<pre class="methodSignature">boolean&nbsp;removeMessage&#8203;(long&nbsp;messageID)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Removes the message corresponding to the specified message ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was removed, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="removeMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMessages</h4>
<pre class="methodSignature">int&nbsp;removeMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Removes all the message corresponding to the specified filter.
<br>
Using <code>null</code> or an empty filter will remove <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of removed messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="removeMessages(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMessages</h4>
<pre class="methodSignature">int&nbsp;removeMessages&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Removes all the message corresponding to the specified filter.
<br>
Using <code>null</code> or an empty filter will remove <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of removed messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="removeAllMessages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllMessages</h4>
<pre class="methodSignature">int&nbsp;removeAllMessages()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Removes all the message from the queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of removed messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="expireMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expireMessages</h4>
<pre class="methodSignature">int&nbsp;expireMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Expires all the message corresponding to the specified filter.
<br>
Using <code>null</code> or an empty filter will expire <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of expired messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="expireMessage(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expireMessage</h4>
<pre class="methodSignature">boolean&nbsp;expireMessage&#8203;(long&nbsp;messageID)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Expires the message corresponding to the specified message ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was expired, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="retryMessage(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retryMessage</h4>
<pre class="methodSignature">boolean&nbsp;retryMessage&#8203;(long&nbsp;messageID)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Retries the message corresponding to the given messageID to the original queue.
This is appropriate on dead messages on Dead letter queues only.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageID</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was retried, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="retryMessages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retryMessages</h4>
<pre class="methodSignature">int&nbsp;retryMessages()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Retries all messages on a DLQ to their respective original queues.
This is appropriate on dead messages on Dead letter queues only.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of retried messages.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessage(long,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessage</h4>
<pre class="methodSignature">boolean&nbsp;moveMessage&#8203;(long&nbsp;messageID,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Moves the message corresponding to the specified message ID to the specified other queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was moved, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessage(long,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessage</h4>
<pre class="methodSignature">boolean&nbsp;moveMessage&#8203;(long&nbsp;messageID,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Moves the message corresponding to the specified message ID to the specified other queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was moved, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessages(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessages</h4>
<pre class="methodSignature">int&nbsp;moveMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Moves all the message corresponding to the specified filter to the specified other queue.
RejectDuplicates = false on this case
<br>
Using <code>null</code> or an empty filter will move <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of moved messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessages(java.lang.String,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessages</h4>
<pre class="methodSignature">int&nbsp;moveMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Moves all the message corresponding to the specified filter to the specified other queue.
<br>
Using <code>null</code> or an empty filter will move <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of moved messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessages(int,java.lang.String,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessages</h4>
<pre class="methodSignature">int&nbsp;moveMessages&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="moveMessages(int,java.lang.String,java.lang.String,boolean,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveMessages</h4>
<pre class="methodSignature">int&nbsp;moveMessages&#8203;(int&nbsp;flushLimit,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;otherQueueName,
boolean&nbsp;rejectDuplicates,
int&nbsp;messageCount)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="sendMessageToDeadLetterAddress(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessageToDeadLetterAddress</h4>
<pre class="methodSignature">boolean&nbsp;sendMessageToDeadLetterAddress&#8203;(long&nbsp;messageID)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Sends the message corresponding to the specified message ID to this queue's dead letter address.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message was sent to the dead letter address, <code>false</code> else</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="sendMessagesToDeadLetterAddress(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessagesToDeadLetterAddress</h4>
<pre class="methodSignature">int&nbsp;sendMessagesToDeadLetterAddress&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filterStr)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Sends all the message corresponding to the specified filter to this queue's dead letter address.
<br>
Using <code>null</code> or an empty filter will send <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of sent messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="sendMessage(java.util.Map,int,java.lang.String,boolean,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sendMessage&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;headers,
int&nbsp;type,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;body,
boolean&nbsp;durable,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;user,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - the message headers and properties to set. Can only
container Strings maped to primitive types.</dd>
<dd><code>body</code> - the text to send</dd>
<dd><code>durable</code> - </dd>
<dd><code>user</code> - </dd>
<dd><code>password</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="sendMessage(java.util.Map,int,java.lang.String,boolean,java.lang.String,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sendMessage&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;headers,
int&nbsp;type,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;body,
boolean&nbsp;durable,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;user,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password,
boolean&nbsp;createMessageId)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - the message headers and properties to set. Can only
container Strings maped to primitive types.</dd>
<dd><code>body</code> - the text to send</dd>
<dd><code>durable</code> - </dd>
<dd><code>user</code> - </dd>
<dd><code>password</code> - </dd>
<dd><code>createMessageId</code> - whether or not to auto generate a Message ID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="changeMessagePriority(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMessagePriority</h4>
<pre class="methodSignature">boolean&nbsp;changeMessagePriority&#8203;(long&nbsp;messageID,
int&nbsp;newPriority)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Changes the message's priority corresponding to the specified message ID to the specified priority.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newPriority</code> - between 0 and 9 inclusive.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message priority was changed</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="changeMessagesPriority(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMessagesPriority</h4>
<pre class="methodSignature">int&nbsp;changeMessagesPriority&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter,
int&nbsp;newPriority)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Changes the priority for all the message corresponding to the specified filter to the specified priority.
<br>
Using <code>null</code> or an empty filter will change <em>all</em> messages from this queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of changed messages</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessageCounter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessageCounter</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listMessageCounter()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists the message counter for this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resetMessageCounter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMessageCounter</h4>
<pre class="methodSignature">void&nbsp;resetMessageCounter()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resets the message counter for this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessageCounterAsHTML()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessageCounterAsHTML</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listMessageCounterAsHTML()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists the message counter for this queue as a HTML table.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessageCounterHistory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessageCounterHistory</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listMessageCounterHistory()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Lists the message counter history for this queue.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listMessageCounterHistoryAsHTML()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMessageCounterHistoryAsHTML</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>
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listMessageCounterHistoryAsHTML()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Lists the message counter history for this queue as a HTML table.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="pause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pause</h4>
<pre class="methodSignature">void&nbsp;pause()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Pauses the queue. Messages are no longer delivered to its consumers.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="pause(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pause</h4>
<pre class="methodSignature">void&nbsp;pause&#8203;(boolean&nbsp;persist)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Pauses the queue. Messages are no longer delivered to its consumers.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resume()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre class="methodSignature">void&nbsp;resume()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resumes the queue. Messages are again delivered to its consumers.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="listConsumersAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listConsumersAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listConsumersAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="isPaused()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPaused</h4>
<pre class="methodSignature">boolean&nbsp;isPaused()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns whether the queue is paused.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="browse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>browse</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]&nbsp;browse()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="browse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>browse</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]&nbsp;browse&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="browse(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>browse</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]&nbsp;browse&#8203;(int&nbsp;page,
int&nbsp;pageSize)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="browse(int,int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>browse</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/CompositeData.html?is-external=true" title="class or interface in javax.management.openmbean" class="externalLink">CompositeData</a>[]&nbsp;browse&#8203;(int&nbsp;page,
int&nbsp;pageSize,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resetMessagesAdded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMessagesAdded</h4>
<pre class="methodSignature">void&nbsp;resetMessagesAdded()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resets the MessagesAdded property</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resetMessagesAcknowledged()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMessagesAcknowledged</h4>
<pre class="methodSignature">void&nbsp;resetMessagesAcknowledged()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resets the MessagesAdded property</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resetMessagesExpired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMessagesExpired</h4>
<pre class="methodSignature">void&nbsp;resetMessagesExpired()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resets the MessagesExpired property</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="resetMessagesKilled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMessagesKilled</h4>
<pre class="methodSignature">void&nbsp;resetMessagesKilled()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Resets the MessagesExpired property</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="flushExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushExecutor</h4>
<pre class="methodSignature">void&nbsp;flushExecutor()</pre>
<div class="block">it will flush one cycle on internal executors, so you would be sure that any pending tasks are done before you call
any other measure.
It is useful if you need the exact number of counts on a message</div>
</li>
</ul>
<a id="resetAllGroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetAllGroups</h4>
<pre class="methodSignature">void&nbsp;resetAllGroups()</pre>
<div class="block">Will reset the all the groups.
This is useful if you want a complete rebalance of the groups to consumers</div>
</li>
</ul>
<a id="resetGroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetGroup</h4>
<pre class="methodSignature">void&nbsp;resetGroup&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupID)</pre>
<div class="block">Will reset the group matching the given groupID.
This is useful if you want the given group to be rebalanced to the consumers</div>
</li>
</ul>
<a id="getGroupCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupCount</h4>
<pre class="methodSignature">int&nbsp;getGroupCount()</pre>
<div class="block">Will return the current number of active groups.</div>
</li>
</ul>
<a id="listGroupsAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGroupsAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;listGroupsAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="getRingSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRingSize</h4>
<pre class="methodSignature">long&nbsp;getRingSize()</pre>
<div class="block">Will return the ring size.</div>
</li>
</ul>
<a id="isGroupRebalance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGroupRebalance</h4>
<pre class="methodSignature">boolean&nbsp;isGroupRebalance()</pre>
<div class="block">Returns whether the groups of this queue are automatically rebalanced.</div>
</li>
</ul>
<a id="isGroupRebalancePauseDispatch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGroupRebalancePauseDispatch</h4>
<pre class="methodSignature">boolean&nbsp;isGroupRebalancePauseDispatch()</pre>
<div class="block">Returns whether the dispatch is paused when groups of this queue are automatically rebalanced.</div>
</li>
</ul>
<a id="getGroupBuckets()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupBuckets</h4>
<pre class="methodSignature">int&nbsp;getGroupBuckets()</pre>
<div class="block">Will return the group buckets.</div>
</li>
</ul>
<a id="getGroupFirstKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupFirstKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getGroupFirstKey()</pre>
<div class="block">Will return the header key to notify a consumer of a group change.</div>
</li>
</ul>
<a id="getPreparedTransactionMessageCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreparedTransactionMessageCount</h4>
<pre class="methodSignature">int&nbsp;getPreparedTransactionMessageCount()</pre>
<div class="block">Will return the number of messages stuck in prepared transactions</div>
</li>
</ul>
<a id="deliverScheduledMessages(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliverScheduledMessages</h4>
<pre class="methodSignature">void&nbsp;deliverScheduledMessages&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;filter)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Deliver the scheduled messages which match the filter</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="deliverScheduledMessage(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliverScheduledMessage</h4>
<pre class="methodSignature">void&nbsp;deliverScheduledMessage&#8203;(long&nbsp;messageId)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Deliver the scheduled message with the specified message ID</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="isAutoDelete()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoDelete</h4>
<pre class="methodSignature">boolean&nbsp;isAutoDelete()</pre>
<div class="block">Returns whether this queue is available for auto deletion.</div>
</li>
</ul>
<a id="peekFirstMessageAsJSON()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peekFirstMessageAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;peekFirstMessageAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns the first message on the queue as JSON</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="peekFirstScheduledMessageAsJSON()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>peekFirstScheduledMessageAsJSON</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;peekFirstScheduledMessageAsJSON()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Returns the first scheduled message on the queue as JSON</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</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/QueueControl.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>