blob: dc7686268598c00ff51e36fd924862a74485cc92 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.18">
<link rel="icon" type="image/png" href="images/favicon.png">
<title>Overview</title>
<link rel="stylesheet" href="css/asciidoctor.css">
<link rel="stylesheet" href="css/font-awesome.css">
</head>
<body class="book toc2 toc-left">
<div id="header">
<div id="toc" class="toc2">
<div id="toctitle"><a href="index.html">User Manual for 2.32.0</a></div>
<ul class="sectlevel1">
<li><a href="#overview">1. Overview</a></li>
<li><a href="#protocols-apis">2. Protocols &amp; APIs</a></li>
<li><a href="#upgrading">3. Upgrading</a></li>
<li><a href="#getting-started">4. Getting Started</a></li>
<li><a href="#addressing">5. Addressing</a></li>
<li><a href="#management-and-monitoring">6. Management and Monitoring</a></li>
<li><a href="#broker-to-broker-connectivity">7. Broker-to-Broker Connectivity</a></li>
<li><a href="#security">8. Security</a></li>
<li><a href="#performance">9. Performance</a></li>
<li><a href="#advanced-use-cases">10. Advanced Use-cases</a></li>
<li><a href="#data-disk">11. Data &amp; Disk</a></li>
<li><a href="#network-connectivity-configuration">12. Network Connectivity &amp; Configuration</a></li>
<li><a href="#customizing-broker-behavior">13. Customizing Broker Behavior</a></li>
<li><a href="#miscellaneous">14. Miscellaneous</a></li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="imageblock text-center">
<div class="content">
<img src="images/activemq-logo.png" alt="activemq logo">
</div>
</div>
<div class="paragraph text-center">
<p><strong>An in-depth manual on all aspects of Apache ActiveMQ Artemis 2.32.0</strong></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="overview"><a class="anchor" href="#overview"></a><a class="link" href="#overview">1. Overview</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="project-info.html#general-project-information">General Project Information</a></p>
</li>
<li>
<p><a href="preface.html#why-use-apache-activemq-artemis">Why use Apache ActiveMQ Artemis?</a></p>
</li>
<li>
<p><a href="messaging-concepts.html#messaging-concepts">Messaging Concepts</a></p>
</li>
<li>
<p><a href="architecture.html#core-architecture">Core Architecture</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="protocols-apis"><a class="anchor" href="#protocols-apis"></a><a class="link" href="#protocols-apis">2. Protocols &amp; APIs</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="protocols-interoperability.html#protocols-and-interoperability">Protocols and Interoperability</a></p>
</li>
<li>
<p><a href="amqp.html#amqp">AMQP</a></p>
</li>
<li>
<p><a href="stomp.html#stomp">STOMP</a></p>
</li>
<li>
<p><a href="mqtt.html#mqtt">MQTT</a></p>
</li>
<li>
<p><a href="openwire.html#openwire">OpenWire</a></p>
</li>
<li>
<p><a href="core.html#using-core">Using Core</a></p>
<div class="ulist">
<ul>
<li>
<p><a href="client-failover.html#core-client-failover">Core Client Failover</a></p>
</li>
</ul>
</div>
</li>
<li>
<p><a href="jms-core-mapping.html#mapping-jms-concepts-to-the-core-api">Mapping JMS Concepts to the Core API</a></p>
</li>
<li>
<p><a href="using-jms.html#using-jms-or-jakarta-messaging">Using JMS or Jakarta Messaging</a></p>
<div class="ulist">
<ul>
<li>
<p><a href="pre-acknowledge.html#extra-acknowledge-modes">Extra Acknowledge Modes</a></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="upgrading"><a class="anchor" href="#upgrading"></a><a class="link" href="#upgrading">3. Upgrading</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="versions.html#versions">Version History</a></p>
</li>
<li>
<p><a href="upgrading.html#upgrading-the-broker">Basic Upgrade Instructions</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="getting-started"><a class="anchor" href="#getting-started"></a><a class="link" href="#getting-started">4. Getting Started</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="docker.html#docker">Docker</a></p>
</li>
<li>
<p><a href="using-server.html#using-the-server">Using the Server</a></p>
</li>
<li>
<p><a href="using-cli.html#command-line-interface">Using the Command-Line Interface</a></p>
</li>
<li>
<p><a href="client-classpath.html#the-client-classpath">JMS &amp; Jakarta Client Classpath</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="addressing"><a class="anchor" href="#addressing"></a><a class="link" href="#addressing">5. Addressing</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="address-model.html#address-model">Address Model</a></p>
</li>
<li>
<p><a href="address-settings.html#address-settings">Address Settings</a></p>
</li>
<li>
<p><a href="wildcard-syntax.html#wildcard-syntax">Wildcard Syntax</a></p>
</li>
<li>
<p><a href="wildcard-routing.html#routing-messages-with-wild-cards">Wildcard Routing</a></p>
</li>
<li>
<p><a href="diverts.html#diverting-and-splitting-message-flows">Splitting and Diverting Message Flow</a></p>
</li>
<li>
<p><a href="transformers.html#transformers">Transforming Messages</a></p>
</li>
<li>
<p><a href="filter-expressions.html#filter-expressions">Filter Expressions</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="management-and-monitoring"><a class="anchor" href="#management-and-monitoring"></a><a class="link" href="#management-and-monitoring">6. Management and Monitoring</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="management.html#management">Management</a></p>
</li>
<li>
<p><a href="management-console.html#management-console">Web Management Console</a></p>
</li>
<li>
<p><a href="metrics.html#metrics">Metrics</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="broker-to-broker-connectivity"><a class="anchor" href="#broker-to-broker-connectivity"></a><a class="link" href="#broker-to-broker-connectivity">7. Broker-to-Broker Connectivity</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="core-bridges.html#core-bridges">Core Bridges</a></p>
</li>
<li>
<p><a href="clusters.html#clusters">Clustering</a></p>
</li>
<li>
<p><a href="federation.html#federation">Federation</a></p>
<div class="ulist">
<ul>
<li>
<p><a href="federation-address.html#address-federation">Address Federation</a></p>
</li>
<li>
<p><a href="federation-queue.html#queue-federation">Queue Federation</a></p>
</li>
</ul>
</div>
</li>
<li>
<p><a href="ha.html#high-availability-and-failover">High Availability &amp; Failover</a></p>
<div class="ulist">
<ul>
<li>
<p><a href="network-isolation.html#network-isolation-split-brain">Network Isolation</a></p>
</li>
<li>
<p><a href="restart-sequence.html#restart-sequence">Restart Sequence</a></p>
</li>
<li>
<p><a href="activation-tools.html#activation-sequence-tools">Activation Tools</a></p>
</li>
</ul>
</div>
</li>
<li>
<p><a href="connection-routers.html#connection-routers">Routing Connections</a></p>
</li>
<li>
<p><a href="amqp-broker-connections.html#broker-connections">Broker Connections</a></p>
</li>
<li>
<p><a href="jms-bridge.html#the-jms-bridge">JMS Bridge</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="security"><a class="anchor" href="#security"></a><a class="link" href="#security">8. Security</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="security.html#authentication-authorization">Authentication &amp; Authorization</a></p>
</li>
<li>
<p><a href="masking-passwords.html#masking-passwords">Masking Passwords</a></p>
</li>
<li>
<p><a href="resource-limits.html#resource-limits">Limiting Resource Utilization</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="performance"><a class="anchor" href="#performance"></a><a class="link" href="#performance">9. Performance</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="perf-tuning.html#performance-tuning">Tuning</a></p>
</li>
<li>
<p><a href="perf-tools.html#performance-tools">Tools</a></p>
</li>
<li>
<p><a href="thread-pooling.html#thread-management">Thread Management</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="advanced-use-cases"><a class="anchor" href="#advanced-use-cases"></a><a class="link" href="#advanced-use-cases">10. Advanced Use-cases</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="scheduled-messages.html#scheduled-messages">Scheduled Messages</a></p>
</li>
<li>
<p><a href="last-value-queues.html#last-value-queues">Last-value Queues</a></p>
</li>
<li>
<p><a href="non-destructive-queues.html#non-destructive-queues">Non-destructive Queues</a></p>
</li>
<li>
<p><a href="ring-queues.html#ring-queue">Ring Queues</a></p>
</li>
<li>
<p><a href="retroactive-addresses.html#retroactive-addresses">Retroactive Addresses</a></p>
</li>
<li>
<p><a href="exclusive-queues.html#exclusive-queues">Exclusive Queues</a></p>
</li>
<li>
<p><a href="message-grouping.html#message-grouping">Message Grouping</a></p>
</li>
<li>
<p><a href="consumer-priority.html#consumer-priority">Consumer Priority</a></p>
</li>
<li>
<p><a href="message-expiry.html#message-expiry">Message Expiry</a></p>
</li>
<li>
<p><a href="large-messages.html#large-messages">Large Messages</a></p>
</li>
<li>
<p><a href="paging.html#paging">Paging</a></p>
</li>
<li>
<p><a href="duplicate-detection.html#duplicate-message-detection">Detecting Duplicate Messages</a></p>
</li>
<li>
<p><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">Message Redelivery and Undelivered Messages</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="data-disk"><a class="anchor" href="#data-disk"></a><a class="link" href="#data-disk">11. Data &amp; Disk</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="persistence.html#persistence">Persistence</a></p>
</li>
<li>
<p><a href="data-tools.html#data-tools">Data Tools</a></p>
</li>
<li>
<p><a href="libaio.html#libaio-native-libraries">Libaio Native Libraries</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="network-connectivity-configuration"><a class="anchor" href="#network-connectivity-configuration"></a><a class="link" href="#network-connectivity-configuration">12. Network Connectivity &amp; Configuration</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="connection-ttl.html#detecting-dead-connections">Detecting Dead Connections</a></p>
</li>
<li>
<p><a href="configuring-transports.html#configuring-the-transport">Configuring Network Transports</a></p>
</li>
<li>
<p><a href="flow-control.html#flow-control">Flow Control for Remote Core Clients</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="customizing-broker-behavior"><a class="anchor" href="#customizing-broker-behavior"></a><a class="link" href="#customizing-broker-behavior">13. Customizing Broker Behavior</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="broker-plugins.html#plugin-support">Broker Plugins</a></p>
</li>
<li>
<p><a href="intercepting-operations.html#intercepting-operations">Intercepting Network Operations</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="miscellaneous"><a class="anchor" href="#miscellaneous"></a><a class="link" href="#miscellaneous">14. Miscellaneous</a></h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="config-reload.html#configuration-reload">Reloading Configuration</a></p>
</li>
<li>
<p><a href="slow-consumers.html#detecting-slow-consumers">Detecting Slow Consumers</a></p>
</li>
<li>
<p><a href="critical-analysis.html#critical-analysis-of-the-broker">Critical Analyzer</a></p>
</li>
<li>
<p><a href="transaction-config.html#resource-manager-configuration">JTA Resource Manager Configuration</a></p>
</li>
<li>
<p><a href="send-guarantees.html#guarantees-of-sends-and-commits">Guarantees of Sends and Commits</a></p>
</li>
<li>
<p><a href="graceful-shutdown.html#graceful-server-shutdown">Graceful Server Shutdown</a></p>
</li>
<li>
<p><a href="web-server.html#embedded-web-server">Configuring &amp; Managing the Embedded Web Server</a></p>
</li>
<li>
<p><a href="logging.html#logging">Logging</a></p>
</li>
<li>
<p><a href="embedding-activemq.html#embedding-apache-activemq-artemis">Embedding Apache ActiveMQ Artemis</a></p>
</li>
<li>
<p><a href="karaf.html#artemis-on-apache-karaf">Apache Karaf Integration</a></p>
</li>
<li>
<p><a href="tomcat.html#apache-tomcat-support">Apache Tomcat Support</a></p>
</li>
<li>
<p><a href="cdi-integration.html#cdi-integration">CDI Integration</a></p>
</li>
<li>
<p><a href="copied-message-properties.html#properties-for-copied-messages">Properties for Copied Messages</a></p>
</li>
<li>
<p><a href="maven-plugin.html#maven-plugins">Maven Plugin</a></p>
</li>
<li>
<p><a href="unit-testing.html#unit-testing">Unit Testing</a></p>
</li>
<li>
<p><a href="resource-adapter.html#jca-resource-adapter">JCA Resource Adapter</a></p>
</li>
<li>
<p><a href="configuration-index.html#configuration-reference">Configuration Index</a></p>
</li>
<li>
<p><a href="examples.html#examples">Examples</a></p>
</li>
<li>
<p><a href="notice.html#legal-notice">Legal Notice</a></p>
</li>
</ul>
</div>
</div>
</div>
</div>
</body>
</html>