Repository: activemq-artemis Updated Branches: refs/heads/master 07597ba95 -> 6cacdd9e3
ARTEMIS-607 Added an example/verification for calling an interceptor when using MQTT protocol Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/20c67baa Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/20c67baa Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/20c67baa Branch: refs/heads/master Commit: 20c67baa5af1391e8b58257190e25f59a5d9717a Parents: 07597ba Author: Otavio Rodolfo Piske <[email protected]> Authored: Mon Mar 20 16:55:55 2017 +0100 Committer: Martyn Taylor <[email protected]> Committed: Thu Mar 30 10:15:50 2017 +0100 ---------------------------------------------------------------------- .../standard/interceptor-client-mqtt/pom.xml | 120 +++++++++++++ .../interceptor-client-mqtt/readme.html | 71 ++++++++ .../mqtt/example/InterceptorExample.java | 62 +++++++ .../mqtt/example/SimpleMQTTInterceptor.java | 60 +++++++ .../main/resources/activemq/server0/broker.xml | 176 +++++++++++++++++++ examples/features/standard/pom.xml | 2 + 6 files changed, 491 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/interceptor-client-mqtt/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-mqtt/pom.xml b/examples/features/standard/interceptor-client-mqtt/pom.xml new file mode 100644 index 0000000..2e92dfc --- /dev/null +++ b/examples/features/standard/interceptor-client-mqtt/pom.xml @@ -0,0 +1,120 @@ +<?xml version='1.0'?> +<!-- +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. +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.activemq.examples.broker</groupId> + <artifactId>jms-examples</artifactId> + <version>2.1.0-SNAPSHOT</version> + </parent> + + <artifactId>interceptor-client-mqtt</artifactId> + <packaging>jar</packaging> + <name>ActiveMQ Artemis MQTT Interceptor Example</name> + + <properties> + <activemq.basedir>${project.basedir}/../../../..</activemq.basedir> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-mqtt-protocol</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>org.fusesource.mqtt-client</groupId> + <artifactId>mqtt-client</artifactId> + </dependency> + + <dependency> + <groupId>io.netty</groupId> + <artifactId>netty-all</artifactId> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.activemq</groupId> + <artifactId>artemis-maven-plugin</artifactId> + <executions> + <execution> + <id>create</id> + <goals> + <goal>create</goal> + </goals> + <configuration> + <libList><arg>org.apache.activemq.examples.broker:interceptor-client-mqtt:${project.version}</arg></libList> + <ignore>${noServer}</ignore> + <configuration>${basedir}/target/classes/activemq/server0</configuration> + </configuration> + </execution> + <execution> + <id>start</id> + <goals> + <goal>cli</goal> + </goals> + <configuration> + <ignore>${noServer}</ignore> + <spawn>true</spawn> + <testURI>tcp://localhost:61616</testURI> + <args> + <param>run</param> + </args> + </configuration> + </execution> + <execution> + <id>runClient</id> + <goals> + <goal>runClient</goal> + </goals> + <configuration> + <clientClass>org.apache.activemq.artemis.mqtt.example.InterceptorExample</clientClass> + </configuration> + </execution> + <execution> + <id>stop</id> + <goals> + <goal>cli</goal> + </goals> + <configuration> + <ignore>${noServer}</ignore> + <args> + <param>stop</param> + </args> + </configuration> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.apache.activemq.examples.broker</groupId> + <artifactId>interceptor-client-mqtt</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> + +</project> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/interceptor-client-mqtt/readme.html ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-mqtt/readme.html b/examples/features/standard/interceptor-client-mqtt/readme.html new file mode 100644 index 0000000..7c49ca6 --- /dev/null +++ b/examples/features/standard/interceptor-client-mqtt/readme.html @@ -0,0 +1,71 @@ +<!-- +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 Interceptor 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>MQTT Interceptor 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 shows you how to implement and configure a simple incoming, server-side MQTT interceptor with ActiveMQ Artemis.</p> + + <p>ActiveMQ Artemis allows an application to use an interceptor to hook into the messaging system. All that needs to do is to implement the + Interceptor interface, as defined below: </p> + <pre class="prettyprint"> + <code> + public interface Interceptor + { + boolean intercept(final MqttMessage mqttMessage, RemotingConnection connection); + } + </code> + </pre> + <p>Once you have your own interceptor class, add it to the broker.xml, as follows:</p> + <pre class="prettyprint"> + <code> + <configuration> + ... + <remoting-incoming-interceptors> + <class-name>org.apache.activemq.artemis.mqtt.example.SimpleMQTTInterceptor</class-name> + </remoting-incoming-interceptors> + ... + </configuration> + </code> + </pre> + + <p>With interceptor, you can handle various events in message processing. In this example, a simple interceptor, SimpleMQTTInterceptor, is implemented and configured. + When the example is running, the interceptor will modify the payload of a sample MQTT message.</p> + + <p>With our interceptor we always return <code>true</code> from the <code>intercept</code> method. If we were + to return <code>false</code> that signifies that no more interceptors are to run or the target + is not to be called. Return <code>false</code> to abort processing of the packet.</p> + </body> +</html> + + + + + + http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/InterceptorExample.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/InterceptorExample.java b/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/InterceptorExample.java new file mode 100644 index 0000000..5926553 --- /dev/null +++ b/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/InterceptorExample.java @@ -0,0 +1,62 @@ +/* + * 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.mqtt.example; + +import java.nio.charset.StandardCharsets; +import java.util.concurrent.TimeUnit; + +import org.fusesource.mqtt.client.BlockingConnection; +import org.fusesource.mqtt.client.MQTT; +import org.fusesource.mqtt.client.Message; +import org.fusesource.mqtt.client.QoS; +import org.fusesource.mqtt.client.Topic; + +/** + * A simple example that shows how to implement and use interceptors with ActiveMQ Artemis with the MQTT protocol. + */ +public class InterceptorExample { + public static void main(final String[] args) throws Exception { + + System.out.println("Connecting to Artemis using MQTT"); + MQTT mqtt = new MQTT(); + mqtt.setHost("tcp://localhost:1883"); + + BlockingConnection connection = mqtt.blockingConnection(); + connection.connect(); + + System.out.println("Connected to Artemis"); + + // Subscribe to a topic + Topic[] topics = {new Topic("mqtt/example/interceptor", QoS.AT_LEAST_ONCE)}; + connection.subscribe(topics); + System.out.println("Subscribed to topics."); + + // Publish message + String payload1 = "This is message 1"; + + connection.publish("mqtt/example/interceptor", payload1.getBytes(), QoS.AT_LEAST_ONCE, false); + + System.out.println("Sent message"); + + // Receive the sent message + Message message1 = connection.receive(5, TimeUnit.SECONDS); + + String messagePayload = new String(message1.getPayload(), StandardCharsets.UTF_8); + + System.out.println("Received message: " + messagePayload); + } +} http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/SimpleMQTTInterceptor.java ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/SimpleMQTTInterceptor.java b/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/SimpleMQTTInterceptor.java new file mode 100644 index 0000000..677328c --- /dev/null +++ b/examples/features/standard/interceptor-client-mqtt/src/main/java/org/apache/activemq/artemis/mqtt/example/SimpleMQTTInterceptor.java @@ -0,0 +1,60 @@ +/* + * 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.mqtt.example; + +import java.nio.charset.Charset; + +import io.netty.handler.codec.mqtt.MqttPublishMessage; +import org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor; + + +import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; + +import io.netty.handler.codec.mqtt.MqttMessage; + + +/** + * A simple Interceptor implementation + */ +public class SimpleMQTTInterceptor implements MQTTInterceptor { + + @Override + public boolean intercept(final MqttMessage mqttMessage, RemotingConnection connection) { + System.out.println("MQTT Interceptor gets called "); + + + if (mqttMessage instanceof MqttPublishMessage) { + MqttPublishMessage message = (MqttPublishMessage) mqttMessage; + + + String originalMessage = message.payload().toString(Charset.forName("UTF-8")); + System.out.println("Original message: " + originalMessage); + + // The new message content must not be bigger that the original content. + String modifiedMessage = "Modified message "; + + message.payload().setBytes(0, modifiedMessage.getBytes()); + } + + + // We return true which means "call next interceptor" (if there is one) or target. + // If we returned false, it means "abort call" - no more interceptors would be called and neither would + // the target + return true; + } + +} http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/interceptor-client-mqtt/src/main/resources/activemq/server0/broker.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/interceptor-client-mqtt/src/main/resources/activemq/server0/broker.xml b/examples/features/standard/interceptor-client-mqtt/src/main/resources/activemq/server0/broker.xml new file mode 100644 index 0000000..f93a404 --- /dev/null +++ b/examples/features/standard/interceptor-client-mqtt/src/main/resources/activemq/server0/broker.xml @@ -0,0 +1,176 @@ +<?xml version='1.0'?> +<!-- +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. +--> + +<configuration xmlns="urn:activemq" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd"> + + <core xmlns="urn:activemq:core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="urn:activemq:core "> + + <name>0.0.0.0</name> + + <persistence-enabled>true</persistence-enabled> + + <!-- this could be ASYNCIO or NIO + --> + <journal-type>ASYNCIO</journal-type> + + <paging-directory>./data/paging</paging-directory> + + <remoting-incoming-interceptors> + <class-name>org.apache.activemq.artemis.mqtt.example.SimpleMQTTInterceptor</class-name> + </remoting-incoming-interceptors> + + <bindings-directory>./data/bindings</bindings-directory> + + <journal-directory>./data/journal</journal-directory> + + <large-messages-directory>./data/large-messages</large-messages-directory> + + <journal-datasync>true</journal-datasync> + + <journal-min-files>2</journal-min-files> + + <journal-pool-files>-1</journal-pool-files> + + <!-- + You can specify the NIC you want to use to verify if the network + <network-check-NIC>theNickName</network-check-NIC> + --> + + <!-- + Use this to use an HTTP server to validate the network + <network-check-URL-list>http://www.apache.org</network-check-URL-list> --> + + <!-- <network-check-period>10000</network-check-period> --> + <!-- <network-check-timeout>1000</network-check-timeout> --> + + <!-- this is a comma separated list, no spaces, just DNS or IPs + it should accept IPV6 + + Warning: Make sure you understand your network topology as this is meant to validate if your network is valid. + Using IPs that could eventually disappear or be partially visible may defeat the purpose. + You can use a list of multiple IPs, and if any successful ping will make the server OK to continue running --> + <!-- <network-check-list>10.0.0.1</network-check-list> --> + + <!-- use this to customize the ping used for ipv4 addresses --> + <!-- <network-check-ping-command>ping -c 1 -t %d %s</network-check-ping-command> --> + + <!-- use this to customize the ping used for ipv6 addresses --> + <!-- <network-check-ping6-command>ping6 -c 1 %2$s</network-check-ping6-command> --> + + + + + <!-- how often we are looking for how many bytes are being used on the disk in ms --> + <disk-scan-period>5000</disk-scan-period> + + <!-- once the disk hits this limit the system will block, or close the connection in certain protocols + that won't support flow control. --> + <max-disk-usage>90</max-disk-usage> + + <!-- the system will enter into page mode once you hit this limit. + This is an estimate in bytes of how much the messages are using in memory --> + <global-max-size>100Mb</global-max-size> + + <acceptors> + <!-- Acceptor for every supported protocol --> + <acceptor name="artemis">tcp://0.0.0.0:61616?tcpSendBufferSize=1048576;tcpReceiveBufferSize=1048576;protocols=CORE,AMQP,STOMP,HORNETQ,MQTT,OPENWIRE</acceptor> + + + <!-- AMQP Acceptor. Listens on default AMQP port for AMQP traffic.--> + <acceptor name="amqp">tcp://0.0.0.0:5672?protocols=AMQP</acceptor> + + <!-- STOMP Acceptor. --> + <acceptor name="stomp">tcp://0.0.0.0:61613?protocols=STOMP</acceptor> + + <!-- HornetQ Compatibility Acceptor. Enables HornetQ Core and STOMP for legacy HornetQ clients. --> + <acceptor name="hornetq">tcp://0.0.0.0:5445?protocols=HORNETQ,STOMP</acceptor> + + <!-- MQTT Acceptor --> + <acceptor name="mqtt">tcp://0.0.0.0:1883?protocols=MQTT</acceptor> + + </acceptors> + + + <security-settings> + <security-setting match="#"> + <permission type="createNonDurableQueue" roles="guest"/> + <permission type="deleteNonDurableQueue" roles="guest"/> + <permission type="createDurableQueue" roles="guest"/> + <permission type="deleteDurableQueue" roles="guest"/> + <permission type="createAddress" roles="guest"/> + <permission type="deleteAddress" roles="guest"/> + <permission type="consume" roles="guest"/> + <permission type="browse" roles="guest"/> + <permission type="send" roles="guest"/> + <!-- we need this otherwise ./artemis data imp wouldn't work --> + <permission type="manage" roles="guest"/> + </security-setting> + </security-settings> + + <address-settings> + <!-- if you define auto-create on certain queues, management has to be auto-create --> + <address-setting match="activemq.management#"> + <dead-letter-address>DLQ</dead-letter-address> + <expiry-address>ExpiryQueue</expiry-address> + <redelivery-delay>0</redelivery-delay> + <!-- with -1 only the global-max-size is in use for limiting --> + <max-size-bytes>-1</max-size-bytes> + <message-counter-history-day-limit>10</message-counter-history-day-limit> + <address-full-policy>PAGE</address-full-policy> + <auto-create-queues>true</auto-create-queues> + <auto-create-addresses>true</auto-create-addresses> + <auto-create-jms-queues>true</auto-create-jms-queues> + <auto-create-jms-topics>true</auto-create-jms-topics> + </address-setting> + <!--default for catch all--> + <address-setting match="#"> + <dead-letter-address>DLQ</dead-letter-address> + <expiry-address>ExpiryQueue</expiry-address> + <redelivery-delay>0</redelivery-delay> + <!-- with -1 only the global-max-size is in use for limiting --> + <max-size-bytes>-1</max-size-bytes> + <message-counter-history-day-limit>10</message-counter-history-day-limit> + <address-full-policy>PAGE</address-full-policy> + <auto-create-queues>true</auto-create-queues> + <auto-create-addresses>true</auto-create-addresses> + <auto-create-jms-queues>true</auto-create-jms-queues> + <auto-create-jms-topics>true</auto-create-jms-topics> + </address-setting> + </address-settings> + + <addresses> + <address name="DLQ"> + <anycast> + <queue name="DLQ" /> + </anycast> + </address> + <address name="ExpiryQueue"> + <anycast> + <queue name="ExpiryQueue" /> + </anycast> + </address> + + </addresses> + + </core> +</configuration> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/20c67baa/examples/features/standard/pom.xml ---------------------------------------------------------------------- diff --git a/examples/features/standard/pom.xml b/examples/features/standard/pom.xml index 1fe7123..4adb26b 100644 --- a/examples/features/standard/pom.xml +++ b/examples/features/standard/pom.xml @@ -56,6 +56,7 @@ under the License. <module>http-transport</module> <module>interceptor</module> <module>interceptor-client</module> + <module>interceptor-client-mqtt</module> <module>instantiate-connection-factory</module> <module>jms-auto-closeable</module> <module>jms-bridge</module> @@ -118,6 +119,7 @@ under the License. <module>http-transport</module> <module>interceptor</module> <module>interceptor-client</module> + <module>interceptor-client-mqtt</module> <module>jms-auto-closeable</module> <module>instantiate-connection-factory</module> <module>jms-bridge</module>
