You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by jb...@apache.org on 2024/05/03 17:10:33 UTC
(activemq-website) branch main updated: NO-JIRA clarify Artemis docs around queue auto-creation
This is an automated email from the ASF dual-hosted git repository.
jbertram pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-website.git
The following commit(s) were added to refs/heads/main by this push:
new 0ade36afa NO-JIRA clarify Artemis docs around queue auto-creation
0ade36afa is described below
commit 0ade36afad180e983ff38e6414486a5942d5c29d
Author: Justin Bertram <jb...@apache.org>
AuthorDate: Fri May 3 12:10:05 2024 -0500
NO-JIRA clarify Artemis docs around queue auto-creation
---
.../documentation/latest/address-model.html | 16 +++++-
.../documentation/latest/address-settings.html | 22 +++++++-
.../documentation/latest/jms-core-mapping.html | 58 +++++++++++++++-------
3 files changed, 74 insertions(+), 22 deletions(-)
diff --git a/src/components/artemis/documentation/latest/address-model.html b/src/components/artemis/documentation/latest/address-model.html
index 1707626e8..cd9e6fa7e 100644
--- a/src/components/artemis/documentation/latest/address-model.html
+++ b/src/components/artemis/documentation/latest/address-model.html
@@ -194,6 +194,20 @@ This saves you from having to preconfigure each address and queue before a clien
</li>
</ul>
</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Automatic queue creation is for queues that <em>would not otherwise be created during normal operation</em>.
+For example, when a remote application creates a consumer on a JMS topic then a queue will be created representing that subscription as described in the <a href="jms-core-mapping.html">JMS-to-core mapping chapter</a>.
+This queue will be created regardless of how <code>auto-create-queues</code> is configured because it is required for <em>normal operation</em>.
+</td>
+</tr>
+</table>
+</div>
<div class="paragraph">
<p>See <a href="address-settings.html#address-settings">the documentation on address settings</a> for more details on these elements.</p>
</div>
@@ -754,4 +768,4 @@ If no <code>_AMQ_ROUTING_TYPE</code> is set then the message will be routed to a
</div>
</div>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/src/components/artemis/documentation/latest/address-settings.html b/src/components/artemis/documentation/latest/address-settings.html
index e581268c6..552e74a49 100644
--- a/src/components/artemis/documentation/latest/address-settings.html
+++ b/src/components/artemis/documentation/latest/address-settings.html
@@ -336,13 +336,31 @@ Default is <code>true</code>.</p>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-automatic queue creation does <em>not</em> work for the core client.
+Automatic queue creation does <em>not</em> work for the core client.
The core API is a low-level API and is not meant to have such automation.
</td>
</tr>
</table>
</div>
</dd>
+</dl>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Automatic queue creation is for queues that <em>would not otherwise be created during normal operation</em>.
+For example, when a remote application creates a consumer on a JMS topic then a queue will be created representing that subscription as described in the <a href="jms-core-mapping.html">JMS-to-core mapping chapter</a>.
+This queue will be created regardless of how <code>auto-create-queues</code> is configured because it is required for <em>normal operation</em>.
+</td>
+</tr>
+</table>
+</div>
+<div class="dlist">
+<dl>
<dt class="hdlist1">auto-delete-queues</dt>
<dd>
<p>Whether or not the broker should automatically delete auto-created queues when they have both 0 consumers and the message count is less than or equal to <code>auto-delete-queues-message-count</code>.
@@ -584,4 +602,4 @@ elements if not explicitly configured. Read more about <a href="duplicate-detect
</div>
</div>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/src/components/artemis/documentation/latest/jms-core-mapping.html b/src/components/artemis/documentation/latest/jms-core-mapping.html
index 3cf093b4c..ad5d90fa6 100644
--- a/src/components/artemis/documentation/latest/jms-core-mapping.html
+++ b/src/components/artemis/documentation/latest/jms-core-mapping.html
@@ -10,39 +10,59 @@
<link rel="stylesheet" href="css/asciidoctor.css">
<link rel="stylesheet" href="css/font-awesome.css">
</head>
-<body class="book">
+<body class="book toc2 toc-left">
<div id="header">
<h1>Mapping JMS Concepts to the Core API</h1>
+<div id="toc" class="toc2">
+<div id="toctitle"><a href="index.html">User Manual for 2.33.0</a></div>
+<ul class="sectlevel1">
+<li><a href="#jms-topic">1. JMS Topic</a></li>
+<li><a href="#jms-queue">2. JMS Queue</a></li>
+</ul>
+</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>This chapter describes how JMS destinations are mapped to Apache ActiveMQ Artemis addresses.</p>
+<p>This chapter describes how JMS destinations are mapped to the Apache ActiveMQ Artemis address model.
+If you haven’t already done so, please read about the <a href="address-model.html">address model</a> as it introduces concepts which are referenced here.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="jms-topic"><a class="anchor" href="#jms-topic"></a><a class="link" href="#jms-topic">1. JMS Topic</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>A JMS topic is implemented as a <a href="address-model.html#address"><strong>address</strong></a> where the name of the address is the same as the name of the JMS topic.</p>
+</div>
+<div class="paragraph">
+<p>A subscription on that JMS topic is represented as a <a href="address-model.html#multicast"><strong>multicast</strong></a> <a href="address-model.html#queue"><strong>queue</strong></a> on the corresponding address. The queue is named according to the whether the subscription is durable and according to the client ID and subscription named provided via the JMS API.</p>
</div>
<div class="paragraph">
-<p>Apache ActiveMQ Artemis core is JMS-agnostic.
-It does not have any concept of a JMS topic.
-A JMS topic is implemented in core as an address with name=(the topic name) and with a MULTICAST routing type with zero or more queues bound to it.
-Each queue bound to that address represents a topic subscription.</p>
+<p>Typically there is just one consumer per queue, but there can be multiple consumers on a queue when using JMS shared topic subscriptions.
+Any messages sent to the JMS topic is therefore routed to every multicast queue bound to the corresponding address and then dispatched to any consumers on those queues (i.e. JMS topic subscriber).
+If there are no queues on the address then the message is simply dropped.</p>
</div>
<div class="paragraph">
-<p>Likewise, a JMS queue is implemented as an address with name=(the JMS queue name) with an ANYCAST routing type associated with it.</p>
+<p>This effectively achieves JMS pub/sub semantics.</p>
</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-While it is possible to configure a JMS topic and queue with the same name, it is not a recommended configuration for use with cross protocol.
-</td>
-</tr>
-</table>
+</div>
+</div>
+<div class="sect1">
+<h2 id="jms-queue"><a class="anchor" href="#jms-queue"></a><a class="link" href="#jms-queue">2. JMS Queue</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Likewise, a JMS queue is implemented as an <a href="address-model.html#address"><strong>address</strong></a> where the name of the address is the same as the name of the JMS queue.</p>
+</div>
+<div class="paragraph">
+<p>However, there will be just one <a href="address-model.html#anycast"><strong>anycast</strong></a> <a href="address-model.html#queue"><strong>queue</strong></a> on the corresponding address. All JMS consumers on this queue will <em>share</em> the messages in the queue. The queue is named the same as the address.</p>
+</div>
+<div class="paragraph">
+<p>This effectively achieves JMS point-to-point semantics.</p>
</div>
</div>
</div>
</div>
</body>
-</html>
\ No newline at end of file
+</html>