activemq-artemis/examples/jms/clustered-durable-subscription/readme.html

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<html>
  <head>
    <title>ActiveMQ Artemis JMS Durable Subscription Example</title>
    <link rel="stylesheet" type="text/css" href="../common/common.css" />
    <link rel="stylesheet" type="text/css" href="../common/prettify.css" />
    <script type="text/javascript" src="../common/prettify.js"></script>
  </head>
  <body onload="prettyPrint()">
     <h1>JMS Durable Subscription Example</h1>

     <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre>

     <p>This example demonstrates a clustered JMS durable subscription.
     Normally durable subscriptions exist on a single node and can only have one subscriber at any one time,
     however, with ActiveMQ Artemis it's possible to create durable subscription instances with the same name and client-id
     on different nodes of the cluster, and consume from them simultaneously.
     This allows the work of processing messages from a durable subscription to be spread across the cluster in
     a similar way to how JMS Queues can be load balanced across the cluster
     </p>
     <p>In this example we first configure the two nodes to form a cluster, then we then create a durable subscriber
     with the same name and client-id on both nodes, and we create a producer on only one of the nodes.</p>
     <p>We then send some messages via the producer, and we verify that the messages are round robin'd between
     the two subscription instances. Note that each durable subscription instance with the same name and client-id
     <b>does not</b> receive its own copy of the messages. This is because the instances on different nodes form a
     single "logical" durable subscription, in the same way multiple JMS Queue instances on different nodes
     form a single "local" JMS Queue</p>
     <p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use
     JNDI, these could be instantiated directly.
     <p>Here's the relevant snippet from the server configuration, which tells the server to form a cluster between the two nodes
     and to load balance the messages between the nodes.</p>
     <p>The cli create method will define this section by default if you use --clustered as a parameter</p>
     <pre class="prettyprint">
     <code>&lt;cluster-connection name="my-cluster"&gt;
        &lt;address&gt;jms&lt;/address&gt;
        &lt;retry-interval&gt;500&lt;/retry-interval&gt;
        &lt;use-duplicate-detection&gt;true&lt;/use-duplicate-detection&gt;
        &lt;message-load-balancing&gt;STRICT&lt;/message-load-balancing&gt;
        &lt;max-hops&gt;1&lt;/max-hops&gt;
        &lt;discovery-group-ref discovery-group-name="my-discovery-group"/&gt;
     &lt;/cluster-connection&gt;
     </code>
     </pre>
     <p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering
     section of the user manual.</p>

   </body>
</html>
ACTIVEMQ6-43(reopened) : Replace License Headers on codebase - added missing license headers found by maven rat plugin. most of them added automatically via apache-rat a few manually added - added apache-rat maven plugin to the build cycle 2015-01-05 07:45:36 -05:00			`<!--`
			`Licensed to the Apache Software Foundation (ASF) under one`
			`or more contributor license agreements. See the NOTICE file`
			`distributed with this work for additional information`
			`regarding copyright ownership. The ASF licenses this file`
			`to you under the Apache License, Version 2.0 (the`
			`"License"); you may not use this file except in compliance`
			`with the License. You may obtain a copy of the License at`

			`http://www.apache.org/licenses/LICENSE-2.0`

			`Unless required by applicable law or agreed to in writing,`
			`software distributed under the License is distributed on an`
			`"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY`
			`KIND, either express or implied. See the License for the`
			`specific language governing permissions and limitations`
			`under the License.`
			`-->`

ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<html>`
			`<head>`
Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`<title>ActiveMQ Artemis JMS Durable Subscription Example</title>`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<link rel="stylesheet" type="text/css" href="../common/common.css" />`
			`<link rel="stylesheet" type="text/css" href="../common/prettify.css" />`
			`<script type="text/javascript" src="../common/prettify.js"></script>`
			`</head>`
			`<body onload="prettyPrint()">`
			`<h1>JMS Durable Subscription Example</h1>`

ARTEMIS-180 removing -Pexample and some other improvements around the examples 2015-08-05 15:33:20 -04:00			`<pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre>`

ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<p>This example demonstrates a clustered JMS durable subscription.`
			`Normally durable subscriptions exist on a single node and can only have one subscriber at any one time,`
Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`however, with ActiveMQ Artemis it's possible to create durable subscription instances with the same name and client-id`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`on different nodes of the cluster, and consume from them simultaneously.`
			`This allows the work of processing messages from a durable subscription to be spread across the cluster in`
			`a similar way to how JMS Queues can be load balanced across the cluster`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`</p>`
			`<p>In this example we first configure the two nodes to form a cluster, then we then create a durable subscriber`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`with the same name and client-id on both nodes, and we create a producer on only one of the nodes.</p>`
			`<p>We then send some messages via the producer, and we verify that the messages are round robin'd between`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`the two subscription instances. Note that each durable subscription instance with the same name and client-id`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<b>does not</b> receive its own copy of the messages. This is because the instances on different nodes form a`
			`single "logical" durable subscription, in the same way multiple JMS Queue instances on different nodes`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`form a single "local" JMS Queue</p>`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<p>This example uses JNDI to lookup the JMS Queue and ConnectionFactory objects. If you prefer not to use`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`JNDI, these could be instantiated directly.`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<p>Here's the relevant snippet from the server configuration, which tells the server to form a cluster between the two nodes`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`and to load balance the messages between the nodes.</p>`
ARTEMIS-180 removing -Pexample and some other improvements around the examples 2015-08-05 15:33:20 -04:00			`<p>The cli create method will define this section by default if you use --clustered as a parameter</p>`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<pre class="prettyprint">`
			`<code><cluster-connection name="my-cluster">`
			`<address>jms</address>`
			`<retry-interval>500</retry-interval>`
			`<use-duplicate-detection>true</use-duplicate-detection>`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`<message-load-balancing>STRICT</message-load-balancing>`
ACTIVEMQ6-1 - Initial HornetQ Donation Commit https://issues.apache.org/jira/browse/ACTIVEMQ6-1 This is the initial donation of the HornetQ codebase as per document http://incubator.apache.org/ip-clearance/hornetq.html 2014-10-31 06:20:28 -04:00			`<max-hops>1</max-hops>`
			`<discovery-group-ref discovery-group-name="my-discovery-group"/>`
			`</cluster-connection>`
			`</code>`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`</pre>`
Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`<p>For more information on ActiveMQ Artemis load balancing, and clustering in general, please see the clustering`
ARTEMIS-19 allow disabling of message load-balancing 2015-05-29 17:55:32 -04:00			`section of the user manual.</p>`

ARTEMIS-180 removing -Pexample and some other improvements around the examples 2015-08-05 15:33:20 -04:00			`</body>`
ACTIVEMQ6-43(reopened) : Replace License Headers on codebase - added missing license headers found by maven rat plugin. most of them added automatically via apache-rat a few manually added - added apache-rat maven plugin to the build cycle 2015-01-05 07:45:36 -05:00			`</html>`