blob: b340cb2c5c8a004d12d3654ee8984d563fc04abe [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.activemq.artemis.core.server (ActiveMQ Artemis Website 2.29.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="org.apache.activemq.artemis.core.server (ActiveMQ Artemis Website 2.29.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.activemq.artemis.core.server</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActivateCallback.html" title="interface in org.apache.activemq.artemis.core.server">ActivateCallback</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ActivationFailureListener.html" title="interface in org.apache.activemq.artemis.core.server">ActivationFailureListener</a></th>
<td class="colLast">
<div class="block">This interface represents a way users can be alerted to activation failures that don't necessarily constitute a
fatal problem for the broker (e.g.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActiveMQMessageBundle.html" title="interface in org.apache.activemq.artemis.core.server">ActiveMQMessageBundle</a></th>
<td class="colLast">
<div class="block">Logger Code 22</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ActiveMQServer.html" title="interface in org.apache.activemq.artemis.core.server">ActiveMQServer</a></th>
<td class="colLast">
<div class="block">This interface defines the internal interface of the ActiveMQ Artemis Server exposed to other components
of the server.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActiveMQServerLogger.html" title="interface in org.apache.activemq.artemis.core.server">ActiveMQServerLogger</a></th>
<td class="colLast">
<div class="block">Logger Code 22</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Bindable.html" title="interface in org.apache.activemq.artemis.core.server">Bindable</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BrokerConnection.html" title="interface in org.apache.activemq.artemis.core.server">BrokerConnection</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ConnectorService.html" title="interface in org.apache.activemq.artemis.core.server">ConnectorService</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ConnectorServiceFactory.html" title="interface in org.apache.activemq.artemis.core.server">ConnectorServiceFactory</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Consumer.html" title="interface in org.apache.activemq.artemis.core.server">Consumer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ConsumerInfo.html" title="interface in org.apache.activemq.artemis.core.server">ConsumerInfo</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CoreLargeServerMessage.html" title="interface in org.apache.activemq.artemis.core.server">CoreLargeServerMessage</a></th>
<td class="colLast">
<div class="block">This is a tagging interface,
as we need to make sure the LargeMessage is a core large message is certain places.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Divert.html" title="interface in org.apache.activemq.artemis.core.server">Divert</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LargeServerMessage.html" title="interface in org.apache.activemq.artemis.core.server">LargeServerMessage</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LiveNodeLocator.BackupRegistrationListener.html" title="interface in org.apache.activemq.artemis.core.server">LiveNodeLocator.BackupRegistrationListener</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></th>
<td class="colLast">
<div class="block">A reference to a message.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NodeManager.LockListener.html" title="interface in org.apache.activemq.artemis.core.server">NodeManager.LockListener</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PostQueueCreationCallback.html" title="interface in org.apache.activemq.artemis.core.server">PostQueueCreationCallback</a></th>
<td class="colLast">
<div class="block">When a "core" queue is created this callback will be invoked</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PostQueueDeletionCallback.html" title="interface in org.apache.activemq.artemis.core.server">PostQueueDeletionCallback</a></th>
<td class="colLast">
<div class="block">When a "core" queue is deleted this callback will be invoked</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Queue.html" title="interface in org.apache.activemq.artemis.core.server">Queue</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QueueFactory.html" title="interface in org.apache.activemq.artemis.core.server">QueueFactory</a></th>
<td class="colLast">
<div class="block">A QueueFactory</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QueueManager.html" title="interface in org.apache.activemq.artemis.core.server">QueueManager</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RouteContextList.html" title="interface in org.apache.activemq.artemis.core.server">RouteContextList</a></th>
<td class="colLast">
<div class="block">This is a simple datatype containing the list of a routing context</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RoutingContext.html" title="interface in org.apache.activemq.artemis.core.server">RoutingContext</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ScheduledDeliveryHandler.html" title="interface in org.apache.activemq.artemis.core.server">ScheduledDeliveryHandler</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SecuritySettingPlugin.html" title="interface in org.apache.activemq.artemis.core.server">SecuritySettingPlugin</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServerConsumer.html" title="interface in org.apache.activemq.artemis.core.server">ServerConsumer</a></th>
<td class="colLast">
<div class="block">A ServerConsumer</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ServerMessage.html" title="interface in org.apache.activemq.artemis.core.server">ServerMessage</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServerProducer.html" title="interface in org.apache.activemq.artemis.core.server">ServerProducer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ServerSession.html" title="interface in org.apache.activemq.artemis.core.server">ServerSession</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServiceRegistry.html" title="interface in org.apache.activemq.artemis.core.server">ServiceRegistry</a></th>
<td class="colLast">
<div class="block">A holder for common services leveraged by the broker.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SlowConsumerDetectionListener.html" title="interface in org.apache.activemq.artemis.core.server">SlowConsumerDetectionListener</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TempQueueObserver.html" title="interface in org.apache.activemq.artemis.core.server">TempQueueObserver</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TransientQueueManager.html" title="interface in org.apache.activemq.artemis.core.server">TransientQueueManager</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActivationParams.html" title="class in org.apache.activemq.artemis.core.server">ActivationParams</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ActiveMQMessageBundle_impl.html" title="class in org.apache.activemq.artemis.core.server">ActiveMQMessageBundle_impl</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActiveMQServerLogger_impl.html" title="class in org.apache.activemq.artemis.core.server">ActiveMQServerLogger_impl</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ActiveMQServers.html" title="class in org.apache.activemq.artemis.core.server">ActiveMQServers</a></th>
<td class="colLast">
<div class="block">ActiveMQServers is a factory class for instantiating ActiveMQServer instances.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AddressQueryResult.html" title="class in org.apache.activemq.artemis.core.server">AddressQueryResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BindingQueryResult.html" title="class in org.apache.activemq.artemis.core.server">BindingQueryResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LiveNodeLocator.html" title="class in org.apache.activemq.artemis.core.server">LiveNodeLocator</a></th>
<td class="colLast">
<div class="block">A class that will locate a particular live server running in a cluster.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MemoryManager.html" title="class in org.apache.activemq.artemis.core.server">MemoryManager</a></th>
<td class="colLast">
<div class="block">A memory usage watcher.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MessageReference.Factory.html" title="class in org.apache.activemq.artemis.core.server">MessageReference.Factory</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NodeManager.html" title="class in org.apache.activemq.artemis.core.server">NodeManager</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QueueConfig.html" title="class in org.apache.activemq.artemis.core.server">QueueConfig</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QueueConfig.Builder.html" title="class in org.apache.activemq.artemis.core.server">QueueConfig.Builder</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QueueQueryResult.html" title="class in org.apache.activemq.artemis.core.server">QueueQueryResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActiveMQServer.SERVER_STATE.html" title="enum in org.apache.activemq.artemis.core.server">ActiveMQServer.SERVER_STATE</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ComponentConfigurationRoutingType.html" title="enum in org.apache.activemq.artemis.core.server">ComponentConfigurationRoutingType</a></th>
<td class="colLast">
<div class="block">This class essentially mirrors <code>RoutingType</code> except it has some additional members to support special
configuration semantics for diverts and bridges.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HandleStatus.html" title="enum in org.apache.activemq.artemis.core.server">HandleStatus</a></th>
<td class="colLast">
<div class="block">A HandleStatus
HANDLED means the MessageReference was handled
NO_MATCH means the MessageReference was rejected by a Filter
BUSY means the MessageReference was rejected since the ClientConsumer was busy</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JournalType.html" title="enum in org.apache.activemq.artemis.core.server">JournalType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RoutingContext.MirrorOption.html" title="enum in org.apache.activemq.artemis.core.server">RoutingContext.MirrorOption</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ActiveMQLockAcquisitionTimeoutException.html" title="class in org.apache.activemq.artemis.core.server">ActiveMQLockAcquisitionTimeoutException</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NodeManager.NodeManagerException.html" title="class in org.apache.activemq.artemis.core.server">NodeManager.NodeManagerException</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>