From 2f0149c7598ed8c3adc2c0e5b0315fa07756dd4b Mon Sep 17 00:00:00 2001 From: Pat Fox Date: Sun, 15 Apr 2018 21:22:26 +0200 Subject: [PATCH] ARTEMIS-1809 adding example of mapping ActiveMQ 5.x Virtual Topic consumers --- docs/user-manual/en/examples.md | 3 +- .../en/protocols-interoperability.md | 4 +- examples/protocols/openwire/pom.xml | 2 + .../openwire/virtual-topic-mapping/pom.xml | 133 ++++++++++++++++++ .../openwire/virtual-topic-mapping/readme.md | 27 ++++ .../example/VirtualTopicMappingExample.java | 76 ++++++++++ .../resources/activemq/server0/broker.xml | 70 +++++++++ 7 files changed, 313 insertions(+), 2 deletions(-) create mode 100644 examples/protocols/openwire/virtual-topic-mapping/pom.xml create mode 100644 examples/protocols/openwire/virtual-topic-mapping/readme.md create mode 100644 examples/protocols/openwire/virtual-topic-mapping/src/main/java/org/apache/activemq/artemis/jms/example/VirtualTopicMappingExample.java create mode 100644 examples/protocols/openwire/virtual-topic-mapping/src/main/resources/activemq/server0/broker.xml diff --git a/docs/user-manual/en/examples.md b/docs/user-manual/en/examples.md index 1780eaa601..251eeaa0c1 100644 --- a/docs/user-manual/en/examples.md +++ b/docs/user-manual/en/examples.md @@ -641,7 +641,8 @@ OpenWire The `Openwire` example shows how to configure an Apache ActiveMQ Artemis server to communicate with an Apache ActiveMQ Artemis JMS client that uses open-wire protocol. -You will find the queue example for open wire, and the chat example. +You will find the queue example for open wire, and the chat example. The virtual-topic-mapping examples shows how to +map the ActiveMQ 5.x Virtual Topic naming convention to work with the Artemis Address model. Paging ------ diff --git a/docs/user-manual/en/protocols-interoperability.md b/docs/user-manual/en/protocols-interoperability.md index 8ce73c4d7d..7904e45e23 100644 --- a/docs/user-manual/en/protocols-interoperability.md +++ b/docs/user-manual/en/protocols-interoperability.md @@ -230,7 +230,9 @@ In an acceptor url it would be: This will translate ```Consumer.A.VirtualTopic.Orders``` into a FQQN of ```VirtualTopic.Orders::Consumer.A``` using the int component ```2``` of the configuration to identify the consumer queue as the first two paths of the destination. -```virtualTopicConsumerWildcards``` is multi valued using a ```,``` separator. +```virtualTopicConsumerWildcards``` is multi valued using a ```,``` separator. + +Please see Virtual Topic Mapping example contained in the OpenWire [examples](examples.md). ## MQTT diff --git a/examples/protocols/openwire/pom.xml b/examples/protocols/openwire/pom.xml index e4d2486e2a..b96a1f653d 100644 --- a/examples/protocols/openwire/pom.xml +++ b/examples/protocols/openwire/pom.xml @@ -44,6 +44,7 @@ under the License. queue message-listener message-recovery + virtual-topic-mapping @@ -55,6 +56,7 @@ under the License. queue message-listener message-recovery + virtual-topic-mapping diff --git a/examples/protocols/openwire/virtual-topic-mapping/pom.xml b/examples/protocols/openwire/virtual-topic-mapping/pom.xml new file mode 100644 index 0000000000..22ea7fafc5 --- /dev/null +++ b/examples/protocols/openwire/virtual-topic-mapping/pom.xml @@ -0,0 +1,133 @@ + + + + + 4.0.0 + + + org.apache.activemq.examples.openwire + openwire-examples + 2.6.0-SNAPSHOT + + + virtual-topic-mapping + jar + ActiveMQ Artemis OpenWire Virtual Topic Mapping Example + + + ${project.basedir}/../../../.. + + + + + org.apache.geronimo.specs + geronimo-jms_1.1_spec + 1.1 + + + org.apache.activemq + activemq-client + ${activemq5-version} + + + org.slf4j + slf4j-nop + + + + + + + org.apache.activemq + artemis-maven-plugin + + + create + + create + + + ${noServer} + + + + start + + cli + + + true + ${noServer} + tcp://localhost:61616 + + run + + + + + runClient + + runClient + + + org.apache.activemq.artemis.jms.example.VirtualTopicMappingExample + + + + stop + + cli + + + ${noServer} + + stop + + + + + + + org.apache.activemq.examples.openwire + virtual-topic-mapping + ${project.version} + + + + + org.apache.maven.plugins + maven-clean-plugin + + + + + + release + + + + com.vladsch.flexmark + markdown-page-generator-plugin + + + + + + \ No newline at end of file diff --git a/examples/protocols/openwire/virtual-topic-mapping/readme.md b/examples/protocols/openwire/virtual-topic-mapping/readme.md new file mode 100644 index 0000000000..e96724d798 --- /dev/null +++ b/examples/protocols/openwire/virtual-topic-mapping/readme.md @@ -0,0 +1,27 @@ +# OpenWire Virtual Topic Mapping Example + +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. + +Using ActiveMQ 5.x virtual topics, messages that are sent to a virtual topic can be consumed from a set of backing queues. +This is similar to using an Artemis Address with a multicast binding and consuming from directly from the underlying +queue using a FQQN (Fully Qualified Queue Name). + +In ActiveMQ 5.x the relation between the virtual topic and its backing queues is established by following a naming convention. +For more details on Virtual Topics please see http://activemq.apache.org/virtual-destinations.html + +This example shows you how to map a virtual topic naming convention (from ActiveMQ 5.x) to use the Artemis Address model . +The Artemis broker is configured to recognise the Virtual Topic Naming convention, using `virtualTopicConsumerWildcards` +acceptor parameter and the consumer will be mapped internally to consume from the appropriate FQQN rather than the specified +Address. + +The example sends a message to a topic (using openwire protocol) and an openwire consumer listens on the backing queue +using the ActiveMQ 5.x virtual topic naming convention. Due to the acceptor url parameter `virtualTopicConsumerWildcards`, +(see below), Artemis maps the consumer consuming from `Consumer.A.VirtualTopic.Orders` to actually consume from +FQQN of `VirtualTopic.Orders::Consumer.A` + + +```xml +tcp://0.0.0.0:61616?virtualTopicConsumerWildcards=Consumer.*.%3E%3B2 +``` + diff --git a/examples/protocols/openwire/virtual-topic-mapping/src/main/java/org/apache/activemq/artemis/jms/example/VirtualTopicMappingExample.java b/examples/protocols/openwire/virtual-topic-mapping/src/main/java/org/apache/activemq/artemis/jms/example/VirtualTopicMappingExample.java new file mode 100644 index 0000000000..0d0e2714dd --- /dev/null +++ b/examples/protocols/openwire/virtual-topic-mapping/src/main/java/org/apache/activemq/artemis/jms/example/VirtualTopicMappingExample.java @@ -0,0 +1,76 @@ +/* + * 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. + */ +package org.apache.activemq.artemis.jms.example; + +import javax.jms.Connection; +import javax.jms.ConnectionFactory; +import javax.jms.MessageConsumer; +import javax.jms.MessageProducer; +import javax.jms.Queue; +import javax.jms.Session; +import javax.jms.TextMessage; +import javax.jms.Topic; + +import org.apache.activemq.ActiveMQConnectionFactory; + +/** + * The example sends a message to a topic (using openwire protocol) and an openwire consumer listens on the backing queue + * using the ActiveMQ 5.x virtual topic naming convention. Due to the acceptor parameter virtualTopicConsumerWildcards + * Artemis maps the consumer consuming from "Consumer.A.VirtualTopic.Orders" to actually consume from + * FQQN "VirtualTopic.Orders::Consumer.A" + */ +public class VirtualTopicMappingExample { + + public static void main(final String[] args) throws Exception { + Connection connection = null; + try { + + ConnectionFactory cf = new ActiveMQConnectionFactory(); + + connection = cf.createConnection(); + Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE); + + //create consumer on queue that is used by the Virtual Topic + Queue queue = session.createQueue("Consumer.A.VirtualTopic.Orders"); + MessageConsumer messageConsumer = session.createConsumer(queue); + connection.start(); + + + //send message to virtual topic + Topic topic = session.createTopic("VirtualTopic.Orders"); + MessageProducer producer = session.createProducer(topic); + TextMessage message = session.createTextMessage("This is a text message"); + producer.send(message); + + System.out.println("Sent message with ID: " + message.getJMSMessageID() + " to Topic: " + topic.getTopicName()); + + //consume the message from the backing queue + TextMessage messageReceived = (TextMessage) messageConsumer.receive(5000); + + if (messageReceived != null) { + System.out.println("Received message with ID: " + messageReceived.getJMSMessageID() + " from Queue: " + queue.getQueueName()); + } else { + //unexpected outcome + throw new RuntimeException("EXAMPLE FAILED - No message received from Queue: " + queue.getQueueName()); + } + } finally { + if (connection != null) { + connection.close(); + } + } + } +} diff --git a/examples/protocols/openwire/virtual-topic-mapping/src/main/resources/activemq/server0/broker.xml b/examples/protocols/openwire/virtual-topic-mapping/src/main/resources/activemq/server0/broker.xml new file mode 100644 index 0000000000..b35671074d --- /dev/null +++ b/examples/protocols/openwire/virtual-topic-mapping/src/main/resources/activemq/server0/broker.xml @@ -0,0 +1,70 @@ + + + + + + + + VirtualTopicMappingExample + + ./data/paging + + ./data/bindings + + ./data/journal + + ./data/large-messages + + + + tcp://0.0.0.0:61616?virtualTopicConsumerWildcards=Consumer.*.%3E%3B2 + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +