This is an automated email from the ASF dual-hosted git repository. robbie pushed a commit to branch development in repository https://gitbox.apache.org/repos/asf/artemis-examples.git
commit 1949943d8ad4f759cfde2633fb3f290ae219b3ba Author: Robbie Gemmell <[email protected]> AuthorDate: Fri Dec 19 17:01:56 2025 +0000 ARTEMIS-5807: more readme updates --- examples/features/clustered/symmetric-cluster/readme.md | 4 ++-- examples/features/standard/client-kickoff/readme.md | 4 ++-- examples/features/standard/message-group/readme.md | 2 +- examples/features/standard/message-group2/readme.md | 2 +- examples/features/standard/reattach-node/readme.md | 4 ++-- examples/features/standard/static-selector/readme.md | 4 ++-- examples/features/standard/topic-selector2/readme.md | 4 ++-- .../sub-modules/inter-broker-bridge/artemis-jms-bridge/readme.md | 2 +- examples/protocols/amqp/proton-clustered-cpp/readme.md | 6 +++--- examples/protocols/amqp/proton-cpp/readme.md | 6 +++--- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/examples/features/clustered/symmetric-cluster/readme.md b/examples/features/clustered/symmetric-cluster/readme.md index cb65f581..bf664042 100644 --- a/examples/features/clustered/symmetric-cluster/readme.md +++ b/examples/features/clustered/symmetric-cluster/readme.md @@ -14,7 +14,7 @@ With a symmetric cluster, the cluster is homogeneous, i.e. each node is configur By connecting node in such a way, we can, from a JMS point of view, give the impression of distributed JMS queues and topics. -The configuration used in this example is very similar to the configuration used by ActiveMQ when installed as a clustered profile in JBoss Application Server. +The configuration used in this example is very similar to the configuration used by Apache Artemis when installed as a clustered profile in JBoss Application Server. To set up Apache Artemis to form a symmetric cluster we simply need to mark each broker as `clustered` and we need to define a `cluster-connection` in `broker.xml`. @@ -37,4 +37,4 @@ In this example we create a symmetric cluster of six live nodes. In this example will we will demonstrate this by deploying a JMS topic and Queue on all nodes of the cluster , sending messages to the queue and topic from different nodes, and verifying messages are received correctly by consumers on different nodes. -For more information on configuring Apache Artemis clustering in general, please see the clustering section of the user manual. \ No newline at end of file +For more information on configuring Apache Artemis clustering in general, please see the clustering section of the user manual. diff --git a/examples/features/standard/client-kickoff/readme.md b/examples/features/standard/client-kickoff/readme.md index a7880a4b..d6eae578 100644 --- a/examples/features/standard/client-kickoff/readme.md +++ b/examples/features/standard/client-kickoff/readme.md @@ -4,6 +4,6 @@ If you have not already done so, [prepare the broker distribution](../../../../R To run the example, simply type **mvn verify** from this directory, or **mvn -PnoServer verify** if you want to start and create the broker manually. -This example shows how to kick off a client connected to ActiveMQ using [JMX](http://www.oracle.com/technetwork/java/javase/tech/javamanagement-140525.html) +This example shows how to kick off a client connected to Apache Artemis using [JMX](http://www.oracle.com/technetwork/java/javase/tech/javamanagement-140525.html) -The example will connect to Apache Artemis. Using JMX, we will list the remote addresses connected to the broker and close the corresponding connections. The client will be kicked off from Apache Artemis receiving an exception that its JMS connection was interrupted. \ No newline at end of file +The example will connect to Apache Artemis. Using JMX, we will list the remote addresses connected to the broker and close the corresponding connections. The client will be kicked off from Apache Artemis receiving an exception that its JMS connection was interrupted. diff --git a/examples/features/standard/message-group/readme.md b/examples/features/standard/message-group/readme.md index 8e48ed90..04459d6b 100644 --- a/examples/features/standard/message-group/readme.md +++ b/examples/features/standard/message-group/readme.md @@ -13,4 +13,4 @@ Message groups are sets of messages that has the following characteristics: You can make any message belong to a message group by setting its 'JMSXGroupID' string property to the group id. In this example we create a message group 'Group-0'. And make such a message group of 10 messages. It also create two consumers on the queue where the 10 'Group-0' group messages are to be sent. You can see that with message grouping enabled, all the 10 messages will be received by the first consumer. The second consumer will receive none. -Alternatively, ActiveMQ's connection factories can be configured to _auto group_ messages. By setting `autoGroup=true` in the client's URL a random unique id will be picked to create a message group. _Every messages_ sent by a producer created from this connection factory will automatically be part of this message group. \ No newline at end of file +Alternatively, Artemis connection factories can be configured to _auto group_ messages. By setting `autoGroup=true` in the client's URL a random unique id will be picked to create a message group. _Every messages_ sent by a producer created from this connection factory will automatically be part of this message group. diff --git a/examples/features/standard/message-group2/readme.md b/examples/features/standard/message-group2/readme.md index fb0a8c9f..03b2e2de 100644 --- a/examples/features/standard/message-group2/readme.md +++ b/examples/features/standard/message-group2/readme.md @@ -13,4 +13,4 @@ Message groups are sets of messages that has the following characteristics: You can make any message belong to a message group by setting a 'group-id' on the connection factory. All producers created via this connection factory will set that group id on its messages. In this example we set the group id 'Group-0'on a connection factory and send messages via 2 different producers and check that only 1 consumer receives them. -Alternatively, ActiveMQ's connection factories can be configured to _auto group_ messages. By setting `autoGroup=true` in the client's URL a random unique id will be picked to create a message group. _Every messages_ sent by a producer created from this connection factory will automatically be part of this message group. \ No newline at end of file +Alternatively, Artemis connection factories can be configured to _auto group_ messages. By setting `autoGroup=true` in the client's URL a random unique id will be picked to create a message group. _Every messages_ sent by a producer created from this connection factory will automatically be part of this message group. diff --git a/examples/features/standard/reattach-node/readme.md b/examples/features/standard/reattach-node/readme.md index 15305640..b872ae89 100644 --- a/examples/features/standard/reattach-node/readme.md +++ b/examples/features/standard/reattach-node/readme.md @@ -6,7 +6,7 @@ To run the example, simply type **mvn verify** from this directory, or **mvn -Pn This example demonstrates how Apache Artemis connections can be configured to be resilient to temporary network failures. -In the case of a network failure being detected, either as a result of a failure to read/write to the connection, or the failure of a pong to arrive back from the broker in good time after a ping is sent, instead of failing the connection immediately and notifying any user ExceptionListener objects, ActiveMQ can be configured to automatically retry the connection, and reattach to the broker when it becomes available again across the network. +In the case of a network failure being detected, either as a result of a failure to read/write to the connection, or the failure of a pong to arrive back from the broker in good time after a ping is sent, instead of failing the connection immediately and notifying any user ExceptionListener objects, Artemis can be configured to automatically retry the connection, and reattach to the broker when it becomes available again across the network. When the client reattaches to the broker it will be able to resume using its sessions and connections where it left off @@ -18,4 +18,4 @@ We then wait a few seconds, then restart the acceptor. The client reattaches and The JMS Connection Factory is configured to reattach automatically by specifying the various reconnect related attributes in the connection URL in `jndi.properties`. -For more details on how to configure this and for clustering in general please consult the Apache Artemis user manual. \ No newline at end of file +For more details on how to configure this and for clustering in general please consult the Apache Artemis user manual. diff --git a/examples/features/standard/static-selector/readme.md b/examples/features/standard/static-selector/readme.md index f4d8a5a8..9362b3a1 100644 --- a/examples/features/standard/static-selector/readme.md +++ b/examples/features/standard/static-selector/readme.md @@ -6,8 +6,8 @@ To run the example, simply type **mvn verify** from this directory, or **mvn -Pn This example shows you how to configure a Apache Artemis queue with static message selectors (filters). -Static message selectors are ActiveMQ's extension to message selectors as defined in JMS spec 1.1. Rather than specifying the selector in the application code, static message selectors are defined in one of ActiveMQ's configuration files, broker.xml, as an element called `filter` inside each queue definition, like +Static message selectors are an Artemis extension to message selectors as defined in JMS spec 1.1. Rather than specifying the selector in the application code, static message selectors are defined in one of the Artemis configuration files, broker.xml, as an element called `filter` inside each queue definition. Once configured the queue `selectorQueue` only delivers messages that are selected against the filter, i.e., only the messages whose `color` properties are of `red` values can be received by its consumers. Those that don't match the filter will be dropped by the queue and therefore will never be delivered to any of its consumers. -In the example code, five messages with different `color` property values are sent to queue `selectorQueue`. One consumer is created to receive messages from the queue. Of the five sent messages, two are of `red` color properties, one is `blue`, one is `green` and one has not the `color` property at all. The result is that the consumer only gets the two `red` messages. \ No newline at end of file +In the example code, five messages with different `color` property values are sent to queue `selectorQueue`. One consumer is created to receive messages from the queue. Of the five sent messages, two are of `red` color properties, one is `blue`, one is `green` and one has not the `color` property at all. The result is that the consumer only gets the two `red` messages. diff --git a/examples/features/standard/topic-selector2/readme.md b/examples/features/standard/topic-selector2/readme.md index bbf55261..3e1280e5 100644 --- a/examples/features/standard/topic-selector2/readme.md +++ b/examples/features/standard/topic-selector2/readme.md @@ -6,6 +6,6 @@ To run the example, simply type **mvn verify** from this directory, or **mvn -Pn This example shows you how to selectively consume messages using message selectors with topic consumers. -Message selectors are strings with special syntax that can be used in creating consumers. Message consumers that are thus created only receive messages that match its selector. On message delivering, the ActiveMQ Server evaluates the corresponding message headers of the messages against each selector, if any, and then delivers the 'matched' messages to its consumer. Please consult the JMS 1.1 specification for full details. +Message selectors are strings with special syntax that can be used in creating consumers. Message consumers that are thus created only receive messages that match its selector. During message delivery, the Artemis server evaluates the corresponding message headers of the messages against each selector, if any, and then delivers the 'matched' messages to its consumer. Please consult the JMS 1.1 specification for full details. -In this example, three message consumers are created on a topic. The first consumer is created with selector `'color=red'`, it only receives messages that have a 'color' string property of 'red' value; the second is created with selector `'color=green'`, it only receives messages who have a 'color' string property of 'green' value; and the third without a selector, which means it receives all messages. To illustrate, three messages with different 'color' property values are created and sent. \ No newline at end of file +In this example, three message consumers are created on a topic. The first consumer is created with selector `'color=red'`, it only receives messages that have a 'color' string property of 'red' value; the second is created with selector `'color=green'`, it only receives messages who have a 'color' string property of 'green' value; and the third without a selector, which means it receives all messages. To illustrate, three messages with different 'color' property values are created and sent. diff --git a/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge/readme.md b/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge/readme.md index a561054e..19ae86fc 100644 --- a/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge/readme.md +++ b/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge/readme.md @@ -1,4 +1,4 @@ -# Artemis to 5.x JMS Bridge +# Apache Artemis to ActiveMQ 5.x JMS Bridge This is an example of using the JMS bridge shipped with the Artemis broker to bridge to a 5.x broker. diff --git a/examples/protocols/amqp/proton-clustered-cpp/readme.md b/examples/protocols/amqp/proton-clustered-cpp/readme.md index 30616b96..38589527 100644 --- a/examples/protocols/amqp/proton-clustered-cpp/readme.md +++ b/examples/protocols/amqp/proton-clustered-cpp/readme.md @@ -2,7 +2,7 @@ Apache Artemis is a multi protocol broker. It will inspect the initial handshake of clients to determine what protocol to use. -All you need to do is to connect a client into activemq's configured port and you should be able connect. +All you need to do is to connect a client into Artemis configured port supporting AMQP. To run this example simply run the command **mvn verify -Pexample**, execute the compile.sh script and start the executable called ./hello @@ -23,10 +23,10 @@ You don't need to do anything special to configure the Apache Artemis broker to Just for the sake of documentation though we are setting the port of Apache Artemis on this example as 5672 which is the port qpid have by default. -This is totally optional and you don't need to follow this convention. You can use any port you chose including ActiveMQ's 61616 default port +This is totally optional and you don't need to follow this convention. You can use any port you chose including Artemis 61616 default port. <acceptor name="proton-acceptor">tcp://localhost:5672</acceptor> ## Example step-by-step -We are using qpid cpp client on this example. There are several libraries you may chose from for AMQP. We have ellect one that we consider simple enough for users. \ No newline at end of file +We are using qpid cpp client on this example. There are several libraries you may chose from for AMQP. We have ellect one that we consider simple enough for users. diff --git a/examples/protocols/amqp/proton-cpp/readme.md b/examples/protocols/amqp/proton-cpp/readme.md index 3da5f8d9..114b1e1b 100644 --- a/examples/protocols/amqp/proton-cpp/readme.md +++ b/examples/protocols/amqp/proton-cpp/readme.md @@ -2,7 +2,7 @@ Apache Artemis is a multi protocol broker. It will inspect the initial handshake of clients to determine what protocol to use. -All you need to do is to connect a client into ActiveMQ's configured port and you should be able connect. +All you need to do is to connect a client into Artemis configured port supporting AMQP. To run this example simply run the command **mvn verify -Pexample**, execute the compile.sh script and start the executable called ./hello @@ -23,7 +23,7 @@ You don't need to do anything special to configure the Apache Artemis broker to Just for the sake of documentation though we are setting the port of Apache Artemis on this example as 5672 which is the port qpid have by default. -This is totally optional and you don't need to follow this convention. You can use any port you chose including ActiveMQ's 61616 default port: +This is totally optional and you don't need to follow this convention. You can use any port you chose including Artemis 61616 default port: <acceptor name="proton-acceptor">tcp://localhost:5672</acceptor> @@ -77,4 +77,4 @@ Consult the [qpid documentation](http://qpid.apache.org/releases/qpid-0.30/progr 20. close the connection - connection.close(); \ No newline at end of file + connection.close(); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
