diff --git a/spring-integration-mqtt/src/api/overview.html b/spring-integration-mqtt/src/api/overview.html new file mode 100644 index 0000000000..fb0198ba99 --- /dev/null +++ b/spring-integration-mqtt/src/api/overview.html @@ -0,0 +1,22 @@ + + +This document is the API specification for Spring Integration +
+
+

+ For further API reference and developer documentation, see the + Spring + Integration reference documentation. + That documentation contains more detailed, developer-targeted + descriptions, with conceptual overviews, definitions of terms, + workarounds, and working code examples. +

+ +

+ If you are interested in commercial training, consultancy, and + support for Spring Integration, please visit + http://www.springsource.com +

+
+ + diff --git a/spring-integration-mqtt/src/dist/changelog.txt b/spring-integration-mqtt/src/dist/changelog.txt new file mode 100644 index 0000000000..672b7ef9dd --- /dev/null +++ b/spring-integration-mqtt/src/dist/changelog.txt @@ -0,0 +1,15 @@ +Spring Integration MqttAdapter Adapter CHANGELOG +========================================= + +For the full detailed changelog, see: +https://.... + + +Changes in version 1.0 GA (insert date here) +https://.... + + +*** GENERAL *** + +Upgraded Spring Framework dependency to ... +... diff --git a/spring-integration-mqtt/src/dist/license.txt b/spring-integration-mqtt/src/dist/license.txt new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/spring-integration-mqtt/src/dist/license.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/spring-integration-mqtt/src/dist/notice.txt b/spring-integration-mqtt/src/dist/notice.txt new file mode 100644 index 0000000000..f62045a212 --- /dev/null +++ b/spring-integration-mqtt/src/dist/notice.txt @@ -0,0 +1,21 @@ + ======================================================================== + == NOTICE file corresponding to section 4 d of the Apache License, == + == Version 2.0, in this case for the Spring Integration distribution. == + ======================================================================== + + This product includes software developed by + the Apache Software Foundation (http://www.apache.org). + + The end-user documentation included with a redistribution, if any, + must include the following acknowledgement: + + "This product includes software developed by the Spring Framework + Project (http://www.springframework.org)." + + Alternatively, this acknowledgement may appear in the software itself, + if and wherever such third-party acknowledgements normally appear. + + The names "Spring", "Spring Framework", and "Spring Integration" must + not be used to endorse or promote products derived from this software + without prior written permission. For written permission, please contact + enquiries@springsource.com. diff --git a/spring-integration-mqtt/src/dist/readme.txt b/spring-integration-mqtt/src/dist/readme.txt new file mode 100644 index 0000000000..de9fd7ed3a --- /dev/null +++ b/spring-integration-mqtt/src/dist/readme.txt @@ -0,0 +1,13 @@ +Spring Integration Mqtt Adapters +----------------------------------- + +To find out what has changed since any earlier releases, see 'changelog.txt'. + +Please consult the documentation located within the 'docs/reference' directory +of this release and also visit the official Spring Integration home at +http://www.springsource.org/spring-integration + +There you will find links to the forum, issue tracker, and several other resources. + +See https://github.com/SpringSource/spring-integration#readme for additional +information including instructions on building from source. diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java new file mode 100644 index 0000000000..55b0717c63 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java @@ -0,0 +1,48 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import org.springframework.beans.factory.support.AbstractBeanDefinition; +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.ParserContext; +import org.springframework.integration.config.xml.AbstractChannelAdapterParser; +import org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter; +import org.w3c.dom.Element; + +/** + * The MqttAdapter Message Driven Channel adapter parser + * + * @author Gary Russell + * @since 1.0 + * + */ +public class MqttMessageDrivenChannelAdapterParser extends AbstractChannelAdapterParser { + + + @Override + protected AbstractBeanDefinition doParse(Element element, ParserContext parserContext, String channelName) { + + BeanDefinitionBuilder builder = BeanDefinitionBuilder + .genericBeanDefinition(MqttPahoMessageDrivenChannelAdapter.class); + + MqttParserUtils.parseCommon(element, builder); + builder.addConstructorArgValue(element.getAttribute("topics")); + builder.addPropertyReference("outputChannel", channelName); + + return builder.getBeanDefinition(); + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java new file mode 100644 index 0000000000..ea99d71e67 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java @@ -0,0 +1,36 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler; + +/** + * The namespace handler for the MqttAdapter namespace + * + * @author Gary Russell + * @since 1.0 + * + */ +public class MqttNamespaceHandler extends AbstractIntegrationNamespaceHandler { + + /* (non-Javadoc) + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + public void init() { + this.registerBeanDefinitionParser("message-driven-channel-adapter", new MqttMessageDrivenChannelAdapterParser()); + this.registerBeanDefinitionParser("outbound-channel-adapter", new MqttOutboundChannelAdapterParser()); + } +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParser.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParser.java new file mode 100644 index 0000000000..e9635c8641 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParser.java @@ -0,0 +1,66 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import org.springframework.beans.factory.support.AbstractBeanDefinition; +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.ParserContext; +import org.springframework.integration.config.xml.AbstractOutboundChannelAdapterParser; +import org.springframework.integration.config.xml.IntegrationNamespaceUtils; +import org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler; +import org.springframework.util.StringUtils; +import org.w3c.dom.Element; + +/** + * The parser for the MqttAdapter Outbound Channel Adapter. + * + * @author Gary Russell + * @since 1.0 + * + */ +public class MqttOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser { + + @Override + protected boolean shouldGenerateId() { + return false; + } + + @Override + protected boolean shouldGenerateIdAsFallback() { + return true; + } + + @Override + protected AbstractBeanDefinition parseConsumer(Element element, ParserContext parserContext) { + + final BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MqttPahoMessageHandler.class); + + MqttParserUtils.parseCommon(element, builder); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "default-topic"); + if (StringUtils.hasText(element.getAttribute("converter")) && + (StringUtils.hasText(element.getAttribute("default-qos")) || + StringUtils.hasText(element.getAttribute("default-retained")))) { + parserContext.getReaderContext().error("If a 'converter' is provided, you cannot provide " + + "'default-qos' or 'default-retained'", element); + } + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "default-qos"); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "default-retained"); + + return builder.getBeanDefinition(); + + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttParserUtils.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttParserUtils.java new file mode 100644 index 0000000000..123cf5fe1d --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttParserUtils.java @@ -0,0 +1,53 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.integration.config.xml.IntegrationNamespaceUtils; +import org.springframework.util.StringUtils; +import org.w3c.dom.Element; + +/** + * Contains various utility methods for parsing Mqtt Adapter + * specific namesspace elements as well as for the generation of the the + * respective {@link BeanDefinition}s. + * + * @author Gary Russell + * @since 1.0 + * + */ +public final class MqttParserUtils { + + /** Prevent instantiation. */ + private MqttParserUtils() { + throw new AssertionError(); + } + + public static void parseCommon(Element element, BeanDefinitionBuilder builder) { + builder.addConstructorArgValue(element.getAttribute("url")); + builder.addConstructorArgValue(element.getAttribute("client-id")); + String clientFactory = element.getAttribute("client-factory"); + if (StringUtils.hasText(clientFactory)) { + builder.addConstructorArgReference(clientFactory); + } + IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "converter"); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "auto-startup"); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "phase"); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "send-timeout"); + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/package-info.java new file mode 100644 index 0000000000..9c047f77eb --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides parser classes to provide Xml namespace support for the MqttAdapter components. + */ +package org.springframework.integration.mqtt.config.xml; diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/DefaultMqttPahoClientFactory.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/DefaultMqttPahoClientFactory.java new file mode 100644 index 0000000000..1eda5d80f6 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/DefaultMqttPahoClientFactory.java @@ -0,0 +1,159 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.core; + +import java.util.Properties; + +import javax.net.SocketFactory; + +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttClientPersistence; +import org.eclipse.paho.client.mqttv3.MqttConnectOptions; +import org.eclipse.paho.client.mqttv3.MqttException; + +/** + * Creates a default {@link MqttClient} and a set of options as configured. + * @author Gary Russell + * @since 1.0 + * + */ +public class DefaultMqttPahoClientFactory implements MqttPahoClientFactory { + + private volatile Boolean cleanSession; + + private volatile Integer connectionTimeout; + + private volatile Integer keepAliveInterval; + + private volatile String password; + + private volatile SocketFactory socketFactory; + + private volatile Properties sslProperties; + + private volatile String userName; + + private volatile MqttClientPersistence persistence; + + private volatile Will will; + + public void setCleanSession(Boolean cleanSession) { + this.cleanSession = cleanSession; + } + + public void setConnectionTimeout(Integer connectionTimeout) { + this.connectionTimeout = connectionTimeout; + } + + public void setKeepAliveInterval(Integer keepAliveInterval) { + this.keepAliveInterval = keepAliveInterval; + } + + public void setPassword(String password) { + this.password = password; + } + + public void setSocketFactory(SocketFactory socketFactory) { + this.socketFactory = socketFactory; + } + + public void setSslProperties(Properties sslProperties) { + this.sslProperties = sslProperties; + } + + public void setUserName(String userName) { + this.userName = userName; + } + + public void setWill(Will will) { + this.will = will; + } + + public void setPersistence(MqttClientPersistence persistence) { + this.persistence = persistence; + } + + @Override + public MqttClient getClientInstance(String url, String clientId) throws MqttException { + return new MqttClient(url, clientId, this.persistence); + } + + @Override + public MqttConnectOptions getConnectionOptions() { + MqttConnectOptions options = new MqttConnectOptions(); + if (this.cleanSession != null) { + options.setCleanSession(this.cleanSession); + } + if (this.connectionTimeout != null) { + options.setConnectionTimeout(this.connectionTimeout); + } + if (this.keepAliveInterval != null) { + options.setKeepAliveInterval(this.keepAliveInterval); + } + if (this.password != null) { + options.setPassword(this.password.toCharArray()); + } + if (this.socketFactory != null) { + options.setSocketFactory(this.socketFactory); + } + if (this.sslProperties != null) { + options.setSSLProperties(this.sslProperties); + } + if (this.userName != null) { + options.setUserName(this.userName); + } + if (this.will != null) { + options.setWill(this.will.getTopic(), this.will.getPayload(), this.will.getQos(), this.will.isRetained()); + } + return options; + } + + public static class Will { + + private final String topic; + + private final byte[] payload; + + private final int qos; + + private final boolean retained; + + public Will(String topic, byte[] payload, int qos, boolean retained) { + this.topic = topic; + this.payload = payload; + this.qos = qos; + this.retained = retained; + } + + protected String getTopic() { + return topic; + } + + protected byte[] getPayload() { + return payload; + } + + protected int getQos() { + return qos; + } + + protected boolean isRetained() { + return retained; + } + + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/MqttPahoClientFactory.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/MqttPahoClientFactory.java new file mode 100644 index 0000000000..d7dcf74155 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/MqttPahoClientFactory.java @@ -0,0 +1,32 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.core; + +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttConnectOptions; +import org.eclipse.paho.client.mqttv3.MqttException; + +/** + * @author Gary Russell + * @since 1.0 + * + */ +public interface MqttPahoClientFactory { + + MqttClient getClientInstance(String url, String clientId) throws MqttException; + + MqttConnectOptions getConnectionOptions(); +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/package-info.java new file mode 100644 index 0000000000..1488613109 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/core/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides core classes of the MqttAdapter module. + */ +package org.springframework.integration.mqtt.core; diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/AbstractMqttMessageDrivenChannelAdapter.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/AbstractMqttMessageDrivenChannelAdapter.java new file mode 100644 index 0000000000..0806980e88 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/AbstractMqttMessageDrivenChannelAdapter.java @@ -0,0 +1,84 @@ +/* + * Copyright 2002-2012 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.inbound; + +import org.springframework.integration.endpoint.MessageProducerSupport; +import org.springframework.integration.mqtt.support.DefaultPahoMessageConverter; +import org.springframework.integration.mqtt.support.MqttMessageConverter; +import org.springframework.util.Assert; + +/** + * Abstract class for MQTT Message-Driven Channel Adapters. + * @author Gary Russell + * @since 1.0 + * + */ +public abstract class AbstractMqttMessageDrivenChannelAdapter extends MessageProducerSupport { + + private final String url; + + private final String clientId; + + private final String[] topic; + + private volatile MqttMessageConverter converter; + + public AbstractMqttMessageDrivenChannelAdapter(String url, String clientId, String... topic) { + Assert.hasText(url, "'url' cannot be null or empty"); + Assert.hasText(clientId, "'clientId' cannot be null or empty"); + Assert.notNull(topic, "'topics' cannot be null"); + Assert.isTrue(topic.length > 0, "'topics' cannot be empty"); + Assert.noNullElements(topic, "'topics' cannot have null elements"); + this.url = url; + this.clientId = clientId; + this.topic = topic; + } + + public void setConverter(MqttMessageConverter converter) { + Assert.notNull(converter, "'converter' cannot be null"); + this.converter = converter; + } + + protected String getUrl() { + return url; + } + + protected String getClientId() { + return clientId; + } + + protected MqttMessageConverter getConverter() { + return converter; + } + + protected String[] getTopic() { + return topic; + } + + @Override + protected void onInit() { + super.onInit(); + if (this.converter == null) { + this.converter = new DefaultPahoMessageConverter(); + } + } + + @Override + public String getComponentType(){ + return "mqtt:inbound-channel-adapter"; + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/MqttPahoMessageDrivenChannelAdapter.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/MqttPahoMessageDrivenChannelAdapter.java new file mode 100644 index 0000000000..36876c96ab --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/MqttPahoMessageDrivenChannelAdapter.java @@ -0,0 +1,156 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.inbound; + +import java.util.concurrent.ScheduledFuture; + +import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken; +import org.eclipse.paho.client.mqttv3.MqttCallback; +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttException; +import org.eclipse.paho.client.mqttv3.MqttMessage; +import org.springframework.integration.Message; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; +import org.springframework.integration.mqtt.core.MqttPahoClientFactory; + +/** + * Eclipse Paho Implementation. + * + * @author Gary Russell + * @since 1.0 + * + */ +public class MqttPahoMessageDrivenChannelAdapter extends AbstractMqttMessageDrivenChannelAdapter + implements MqttCallback { + + private final MqttPahoClientFactory clientFactory; + + private volatile MqttClient client; + + private volatile ScheduledFuture reconnectFuture; + + private volatile boolean connected; + + + public MqttPahoMessageDrivenChannelAdapter(String url, String clientId, MqttPahoClientFactory clientFactory, + String... topic) { + super(url, clientId, topic); + this.clientFactory = clientFactory; + } + + public MqttPahoMessageDrivenChannelAdapter(String url, String clientId, String... topic) { + this(url, clientId, new DefaultMqttPahoClientFactory(), topic); + } + + @Override + protected void doStart() { + super.doStart(); + try { + this.connectAndSubscribe(); + } + catch (Exception e) { + logger.error("Exception while connecting and subscribing, retrying", e); + this.scheduleReconnect(); + } + } + + @Override + protected void doStop() { + super.doStop(); + try { + this.client.unsubscribe(this.getTopic()); + this.client.disconnect(); + this.client.close(); + this.connected = false; + this.client = null; + } + catch (MqttException e) { + logger.error("Exception while unsubscribing and disconnecting", e); + } + } + + private void connectAndSubscribe() throws MqttException { + this.client = this.clientFactory.getClientInstance(this.getUrl(), this.getClientId()); + this.client.connect(this.clientFactory.getConnectionOptions()); + try { + this.client.subscribe(this.getTopic()); + } + catch (MqttException e) { + this.client.disconnect(); + throw e; + } + if (this.client.isConnected()) { + this.client.setCallback(this); + this.connected = true; + if (this.reconnectFuture != null) { + this.cancelReconnect(); + } + if (logger.isDebugEnabled()) { + logger.debug("Connected and subscribed to " + this.getTopic()); + } + } + } + + private synchronized void cancelReconnect() { + if (this.reconnectFuture != null) { + this.reconnectFuture.cancel(false); + this.reconnectFuture = null; + } + } + + private void scheduleReconnect() { + try { + this.reconnectFuture = this.getTaskScheduler().scheduleWithFixedDelay(new Runnable() { + + @Override + public void run() { + try { + if (logger.isDebugEnabled()) { + logger.debug("Attempting reconnect"); + } + if (!connected) { + connectAndSubscribe(); + } + } + catch (MqttException e) { + logger.error("Exception while connecting and subscribing", e); + } + } + }, 10000); + } + catch (Exception e) { + logger.error("Failed to schedule reconnect", e); + } + } + + @Override + public void connectionLost(Throwable cause) { + this.logger.error("Lost connection:" + cause.getMessage() + "; retrying..."); + this.connected = false; + this.scheduleReconnect(); + } + + @Override + public void messageArrived(String topic, MqttMessage mqttMessage) throws Exception { + Message message = this.getConverter().toMessage(topic, mqttMessage); + this.sendMessage(message); + } + + @Override + public void deliveryComplete(IMqttDeliveryToken token) { + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/package-info.java new file mode 100644 index 0000000000..5dc35d5207 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides inbound Spring Integration MqttAdapter components. + */ +package org.springframework.integration.mqtt.inbound; diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java new file mode 100644 index 0000000000..12a4ef29c3 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java @@ -0,0 +1,158 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.outbound; + +import org.springframework.context.SmartLifecycle; +import org.springframework.integration.Message; +import org.springframework.integration.MessageHandlingException; +import org.springframework.integration.handler.AbstractMessageHandler; +import org.springframework.integration.mqtt.support.DefaultPahoMessageConverter; +import org.springframework.integration.mqtt.support.MqttHeaders; +import org.springframework.integration.support.converter.MessageConverter; +import org.springframework.util.Assert; + +/** + * Abstract class for MQTT outbound channel adapters. + * @author Gary Russell + * @since 1.0 + * + */ +public abstract class AbstractMqttMessageHandler extends AbstractMessageHandler implements SmartLifecycle { + + private final String url; + + private final String clientId; + + private volatile String defaultTopic; + + private volatile int defaultQos = 0; + + private volatile boolean defaultRetained = false; + + private volatile MessageConverter converter; + + private boolean running; + + private volatile int phase; + + private volatile boolean autoStartup; + + public AbstractMqttMessageHandler(String url, String clientId) { + Assert.hasText(url, "'url' cannot be null or empty"); + Assert.hasText(clientId, "'clientId' cannot be null or empty"); + this.url = url; + this.clientId = clientId; + } + + public void setDefaultTopic(String defaultTopic) { + this.defaultTopic = defaultTopic; + } + + public void setDefaultQos(int defaultQos) { + this.defaultQos = defaultQos; + } + + public void setDefaultRetained(boolean defaultRetain) { + this.defaultRetained = defaultRetain; + } + + public void setConverter(MessageConverter converter) { + Assert.notNull(converter, "'converter' cannot be null"); + this.converter = converter; + } + + protected String getUrl() { + return url; + } + + protected String getClientId() { + return clientId; + } + + @Override + protected void onInit() throws Exception { + super.onInit(); + if (this.converter == null) { + this.converter = new DefaultPahoMessageConverter(this.defaultQos, this.defaultRetained); + } + } + + @Override + public final void start() { + this.doStart(); + } + + protected abstract void doStart(); + + @Override + public final void stop() { + this.doStop(); + } + + protected abstract void doStop(); + + @Override + public boolean isRunning() { + return this.running; + } + + @Override + public int getPhase() { + return this.phase; + } + + public void setPhase(int phase) { + this.phase = phase; + } + + public void setAutoStartup(boolean autoStartup) { + this.autoStartup = autoStartup; + } + + @Override + public boolean isAutoStartup() { + return this.autoStartup; + } + + @Override + public void stop(Runnable callback) { + this.stop(); + callback.run(); + } + + @Override + protected void handleMessageInternal(Message message) throws Exception { + this.connectIfNeeded(); + String topic = (String) message.getHeaders().get(MqttHeaders.TOPIC); + Object mqttMessage = this.converter.fromMessage(message); + if (topic == null && this.defaultTopic == null) { + throw new MessageHandlingException(message, + "No '" + MqttHeaders.TOPIC + "' header and no default topic defined"); + } + this.publish(topic == null ? this.defaultTopic : topic, mqttMessage); + } + + protected abstract void connectIfNeeded(); + + protected abstract void publish(String topic, Object mqttMessage) throws Exception; + + @Override + public String getComponentType() { + return "mqtt:outbound-channel-adapter"; + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/MqttPahoMessageHandler.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/MqttPahoMessageHandler.java new file mode 100644 index 0000000000..810aae0eb1 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/MqttPahoMessageHandler.java @@ -0,0 +1,117 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.outbound; + +import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken; +import org.eclipse.paho.client.mqttv3.MqttCallback; +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttException; +import org.eclipse.paho.client.mqttv3.MqttMessage; +import org.springframework.integration.MessagingException; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; +import org.springframework.integration.mqtt.core.MqttPahoClientFactory; +import org.springframework.util.Assert; + +/** + * Eclipse Paho implementation. + * @author Gary Russell + * @since 1.0 + * + */ +public class MqttPahoMessageHandler extends AbstractMqttMessageHandler + implements MqttCallback { + + private final MqttPahoClientFactory clientFactory; + + private volatile MqttClient client; + + public MqttPahoMessageHandler(String url, String clientId, MqttPahoClientFactory factory) { + super(url, clientId); + this.clientFactory = factory; + } + + public MqttPahoMessageHandler(String url, String clientId) { + this(url, clientId, new DefaultMqttPahoClientFactory()); + } + + @Override + protected void doStart() { + } + + @Override + protected void doStop() { + try { + if (this.client != null) { + this.client.disconnect(); + this.client.close(); + this.client = null; + } + } + catch (MqttException e) { + logger.error("Failed to disconnect", e); + } + } + + private synchronized void doConnect() throws MqttException { + if (this.client != null && !this.client.isConnected()) { + this.client.close(); + this.client = null; + } + if (this.client == null) { + this.client = this.clientFactory.getClientInstance(this.getUrl(), this.getClientId()); + this.client.connect(this.clientFactory.getConnectionOptions()); + this.client.setCallback(this); + if (logger.isDebugEnabled()) { + logger.debug("Client connected"); + } + } + } + + @Override + protected void connectIfNeeded() { + if (this.client == null || !this.client.isConnected()) { + try { + this.doConnect(); + } + catch (MqttException e) { + throw new MessagingException("Failed to connect", e); + } + } + } + + @Override + protected void publish(String topic, Object mqttMessage) throws Exception { + Assert.isInstanceOf(MqttMessage.class, mqttMessage); + this.client.publish(topic, (MqttMessage) mqttMessage); + } + + @Override + public void connectionLost(Throwable cause) { + logger.error("Lost connection; will attempt reconnect on next request"); + this.client = null; + } + + @Override + public void messageArrived(String topic, MqttMessage message) throws Exception { + + } + + @Override + public void deliveryComplete(IMqttDeliveryToken token) { + + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/package-info.java new file mode 100644 index 0000000000..6b5d4e40b1 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides Spring Integration components for doing outbound operations. + */ +package org.springframework.integration.mqtt.outbound; diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/package-info.java new file mode 100644 index 0000000000..79304d7b4c --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/package-info.java @@ -0,0 +1,4 @@ +/** + * Root package of the MqttAdapter Module. + */ +package org.springframework.integration.mqtt; diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/DefaultPahoMessageConverter.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/DefaultPahoMessageConverter.java new file mode 100644 index 0000000000..20f8137553 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/DefaultPahoMessageConverter.java @@ -0,0 +1,103 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.support; + +import org.eclipse.paho.client.mqttv3.MqttMessage; +import org.springframework.integration.Message; +import org.springframework.integration.support.MessageBuilder; +import org.springframework.integration.support.converter.MessageConversionException; +import org.springframework.util.Assert; + + +/** + * Default implementation allowing most connection options to be configured. + * @author Gary Russell + * @since 1.0 + * + */ +public class DefaultPahoMessageConverter implements MqttMessageConverter { + + private final String charset; + + private final Integer defaultQos; + + private final Boolean defaultRetained; + + public DefaultPahoMessageConverter() { + this (0, false); + } + + public DefaultPahoMessageConverter(int defaultQos, boolean defaultRetain) { + this(defaultQos, defaultRetain, "UTF-8"); + } + + public DefaultPahoMessageConverter(int defaultQos, boolean defaultRetained, String charset) { + this.defaultQos = defaultQos; + this.defaultRetained = defaultRetained; + this.charset = charset; + } + + @Override + @SuppressWarnings("unchecked") + public

Message

toMessage(Object object) { + return (Message

) toMessage(null, object); + } + + public Message toMessage(String topic, Object object) { + Assert.isInstanceOf(MqttMessage.class, object); + MqttMessage message = (MqttMessage) object; + try { + MessageBuilder messageBuilder = MessageBuilder.withPayload(new String(message.getPayload(), this.charset)) + .setHeader(MqttHeaders.QOS, message.getQos()) + .setHeader(MqttHeaders.DUPLICATE, message.isDuplicate()) + .setHeader(MqttHeaders.RETAINED, message.isRetained()); + if (topic != null) { + messageBuilder.setHeader(MqttHeaders.TOPIC, topic); + } + return messageBuilder.build(); + } + catch (Exception e) { + throw new MessageConversionException("failed to convert object to Message", e); + } + } + + @Override + public

Object fromMessage(Message

message) { + Object payload = message.getPayload(); + Assert.isTrue(payload instanceof byte[] || payload instanceof String); + byte[] payloadBytes; + if (payload instanceof String) { + try { + payloadBytes = ((String) payload).getBytes(this.charset); + } + catch (Exception e) { + throw new MessageConversionException("failed to convert Message to object", e); + } + } + else { + payloadBytes = (byte[]) payload; + } + MqttMessage mqttMessage = new MqttMessage(payloadBytes); + Object header = message.getHeaders().get(MqttHeaders.RETAINED); + Assert.isTrue(header == null || header instanceof Boolean, MqttHeaders.RETAINED + " header must be Boolean"); + mqttMessage.setRetained(header == null ? this.defaultRetained : (Boolean) header); + header = message.getHeaders().get(MqttHeaders.QOS); + Assert.isTrue(header == null || header instanceof Integer, MqttHeaders.QOS + " header must be Integer"); + mqttMessage.setQos(header == null ? this.defaultQos : (Integer) header); + return mqttMessage; + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttHeaders.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttHeaders.java new file mode 100644 index 0000000000..b114ad6cf2 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttHeaders.java @@ -0,0 +1,38 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.support; + +/** + * Spring Integration headers. + * @author Gary Russell + * @since 3.0 + * + */ +public class MqttHeaders { + + private static final String prefix = "mqtt_"; + + public static final String QOS = prefix + "qos"; + + public static final String DUPLICATE = prefix + "duplicate"; + + public static final String RETAINED = prefix + "retained"; + + public static final String TOPIC = prefix + "topic"; + private MqttHeaders() { + throw new AssertionError(); + } +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttMessageConverter.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttMessageConverter.java new file mode 100644 index 0000000000..3d13741fd2 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttMessageConverter.java @@ -0,0 +1,31 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.support; + +import org.springframework.integration.Message; +import org.springframework.integration.support.converter.MessageConverter; + +/** + * Extension of {@link MessageConverter} allowing the topic to be added as + * a header. + * @author Gary Russell + * @since 1.0 + * + */ +public interface MqttMessageConverter extends MessageConverter { + + Message toMessage(String topic, Object object); +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java new file mode 100644 index 0000000000..1f69d23cd6 --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java @@ -0,0 +1,33 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.support; + + +/** + * Contains utility methods used by the MqttAdapter components. + * + * @author Gary Russell + * @since 1.0 + * + */ +public final class MqttUtils { + + /** Prevent instantiation. */ + private MqttUtils() { + throw new AssertionError(); + } + +} diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/package-info.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/package-info.java new file mode 100644 index 0000000000..c711af28ae --- /dev/null +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides various support classes used across Spring Integration MqttAdapter Components. + */ +package org.springframework.integration.mqtt.support; diff --git a/spring-integration-mqtt/src/main/resources/META-INF/spring.handlers b/spring-integration-mqtt/src/main/resources/META-INF/spring.handlers new file mode 100644 index 0000000000..fdbf583f7f --- /dev/null +++ b/spring-integration-mqtt/src/main/resources/META-INF/spring.handlers @@ -0,0 +1 @@ +http\://www.springframework.org/schema/integration/mqtt=org.springframework.integration.mqtt.config.xml.MqttNamespaceHandler diff --git a/spring-integration-mqtt/src/main/resources/META-INF/spring.schemas b/spring-integration-mqtt/src/main/resources/META-INF/spring.schemas new file mode 100644 index 0000000000..f4273c569a --- /dev/null +++ b/spring-integration-mqtt/src/main/resources/META-INF/spring.schemas @@ -0,0 +1,2 @@ +http\://www.springframework.org/schema/integration/mqtt/spring-integration-mqtt-1.0.xsd=org/springframework/integration/mqtt/config/xml/spring-integration-mqtt-1.0.xsd +http\://www.springframework.org/schema/integration/mqtt/spring-integration-mqtt.xsd=org/springframework/integration/mqtt/config/xml/spring-integration-mqtt-1.0.xsd diff --git a/spring-integration-mqtt/src/main/resources/META-INF/spring.tooling b/spring-integration-mqtt/src/main/resources/META-INF/spring.tooling new file mode 100644 index 0000000000..a062077f7e --- /dev/null +++ b/spring-integration-mqtt/src/main/resources/META-INF/spring.tooling @@ -0,0 +1,4 @@ +# Tooling related information for the integration MqttAdapter namespace +http\://www.springframework.org/schema/integration/mqttadapter@name=integration MqttAdapter Namespace +http\://www.springframework.org/schema/integration/mqttadapter@prefix=int-mqttadapter +http\://www.springframework.org/schema/integration/mqttadapter@icon=org/springframework/integration/config/xml/spring-integration-mqttadapter.gif diff --git a/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqtt-1.0.xsd b/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqtt-1.0.xsd new file mode 100644 index 0000000000..ecf59a9254 --- /dev/null +++ b/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqtt-1.0.xsd @@ -0,0 +1,200 @@ + + + + + + + + + + + + + + + The definition for the Spring Integration MqttAdapter + Inbound Channel Adapter. + + + + + + + + + + + + + + + + + Specifies one or more (comma-delimited) topics on which to listen for messages. + + + + + + + + + + + + + + + + Defines an outbound Channel Adapter. + + + + + + + + + + + + Channel from which messages will be output. + When a message is sent to this channel it will + cause the query + to be executed. + + + + + + + + + + + Specifies the order for invocation when this endpoint is connected as a + subscriber to a SubscribableChannel. + + + + + + + Specifies the default topic to which messages will be sent. Required if an + outbound message does not have an 'mqtt_topic' header. + + + + + + + Specifies the default quality of service. Default 0. + + + + + + + Specifies the default value of the 'retained' flag. Default false. + + + + + + + + + + + Identifies the underlying Spring bean definition, which is an + instance of either 'EventDrivenConsumer' or 'PollingConsumer', + depending on whether the component's input channel is a + 'SubscribableChannel' or 'PollableChannel'. + + + + + + + Flag to indicate that the component should start automatically + on startup (default true). + + + + + + + + + + Flag to indicate the phase in which the component should start automatically + on startup. See SmartLifecycle. + + + + + + + + + + MQTT broker URL. + + + + + + + MQTT client ID. + + + + + + + to/from + a paho MqttMessage. Default is DefaultMqttMessageConverter. + ]]> + + + + + + + + + + + + + + + + + + + diff --git a/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqttadapter.gif b/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqttadapter.gif new file mode 100644 index 0000000000..41b369fece Binary files /dev/null and b/spring-integration-mqtt/src/main/resources/org/springframework/integration/mqtt/config/xml/spring-integration-mqttadapter.gif differ diff --git a/spring-integration-mqtt/src/reference/docbook/SIAdapterLowerPrefix.xml b/spring-integration-mqtt/src/reference/docbook/SIAdapterLowerPrefix.xml new file mode 100644 index 0000000000..151e09dbed --- /dev/null +++ b/spring-integration-mqtt/src/reference/docbook/SIAdapterLowerPrefix.xml @@ -0,0 +1,73 @@ + + + MqttAdapter Adapter + + The Spring Integration MqttAdapter Adapter provides... + + + + Outbound Channel adapter + + + Outbound Gateway + + + Inbound Channel Adapter + + + +

+ Java Implementation + Each of the provided components will use the + org.springframework.integration.mqtt.core.MqttAdapterExecutor + class... + +
+
+ Common Configuration Attributes + + Certain configuration parameters are shared amongst all MqttAdapter + components and are described below: + + + auto-startup + + Lifecycle attribute signaling if this component should + be started during Application Context startup. + Defaults to true. + Optional. + + + id + + Identifies the underlying Spring bean definition, which + is an instance of either EventDrivenConsumer + or PollingConsumer. + Optional. + + +
+ +
+ Outbound Channel Adapter + + The MqttAdapter Outbound channel adapter allows you to... + +
+
+ Outbound Gateway + + Outbound gateways are similar to outbound channel adapters except that it can also be used to + get a result on the reply channel after performing + the given... + +
+
+ Inbound Channel Adapter + + An inbound channel adapter is used to execute... + +
+ + diff --git a/spring-integration-mqtt/src/reference/docbook/history.xml b/spring-integration-mqtt/src/reference/docbook/history.xml new file mode 100644 index 0000000000..549be2153b --- /dev/null +++ b/spring-integration-mqtt/src/reference/docbook/history.xml @@ -0,0 +1,8 @@ + + + Change History + + + diff --git a/spring-integration-mqtt/src/reference/docbook/images/logo.png b/spring-integration-mqtt/src/reference/docbook/images/logo.png new file mode 100644 index 0000000000..8c71c13a0e Binary files /dev/null and b/spring-integration-mqtt/src/reference/docbook/images/logo.png differ diff --git a/spring-integration-mqtt/src/reference/docbook/index.xml b/spring-integration-mqtt/src/reference/docbook/index.xml new file mode 100644 index 0000000000..d3fd4e8cf4 --- /dev/null +++ b/spring-integration-mqtt/src/reference/docbook/index.xml @@ -0,0 +1,68 @@ + + + + Spring Integration MqttAdapter Adapter + MqttAdapter Adapter ${version} + Spring Integration + ${version} + + + + + + + + + + + + + + Gary Russell + + + © SpringSource Inc., 2012 + + + + + + + What's new? + + + For those who are already familiar with Spring Integration, this + chapter + provides a brief overview of the new features of version 2.2. If you are + interested in the changes and features, that were introduced in + earlier + versions, please take a look at chapter: + + + + + + + + + + Integration Adapters + + This section covers the various Channel Adapters and Messaging + Gateways provided + by Spring Integration to support Message-based communication with + external systems. + + + + + + Appendices + + Advanced Topics and Additional Resources + + + + diff --git a/spring-integration-mqtt/src/reference/docbook/resources.xml b/spring-integration-mqtt/src/reference/docbook/resources.xml new file mode 100644 index 0000000000..109faa9b53 --- /dev/null +++ b/spring-integration-mqtt/src/reference/docbook/resources.xml @@ -0,0 +1,17 @@ + + + Additional Resources + +
+ Spring Integration Home + + The definitive source of information about Spring Integration is the + Spring Integration Home at + http://www.springsource.org. That site serves as a hub of + information and is the best place to find up-to-date announcements about the project as well as links to + articles, blogs, and new sample applications. + +
+ +
diff --git a/spring-integration-mqtt/src/reference/docbook/whats-new.xml b/spring-integration-mqtt/src/reference/docbook/whats-new.xml new file mode 100644 index 0000000000..f037937961 --- /dev/null +++ b/spring-integration-mqtt/src/reference/docbook/whats-new.xml @@ -0,0 +1,11 @@ + + + What's new? + + This chapter provides an overview of the new features and improvements + that have been added to the MqttAdapter Adapter: + + + diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BackTobackAdapterTests.java b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BackTobackAdapterTests.java new file mode 100644 index 0000000000..60e44f3673 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BackTobackAdapterTests.java @@ -0,0 +1,94 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; + +import org.junit.Rule; +import org.junit.Test; +import org.springframework.integration.Message; +import org.springframework.integration.channel.QueueChannel; +import org.springframework.integration.message.GenericMessage; +import org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter; +import org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler; +import org.springframework.integration.mqtt.support.MqttHeaders; +import org.springframework.integration.support.MessageBuilder; +import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; + +/** + * @author Gary Russell + * @since 3.0 + * + */ +public class BackTobackAdapterTests { + + @Rule + public final BrokerRunning brokerRunning = BrokerRunning.isRunning(1883); + + @Test + public void testSingleTopic() { + MqttPahoMessageHandler adapter = new MqttPahoMessageHandler("tcp://localhost:1883", "si-test-out"); + adapter.setDefaultTopic("mqtt-foo"); + adapter.afterPropertiesSet(); + adapter.start(); + MqttPahoMessageDrivenChannelAdapter inbound = new MqttPahoMessageDrivenChannelAdapter("tcp://localhost:1883", "si-test-in", "mqtt-foo"); + QueueChannel outputChannel = new QueueChannel(); + inbound.setOutputChannel(outputChannel); + ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler(); + taskScheduler.initialize(); + inbound.setTaskScheduler(taskScheduler); + inbound.afterPropertiesSet(); + inbound.start(); + adapter.handleMessage(new GenericMessage("foo")); + adapter.stop(); + Message out = outputChannel.receive(1000); + assertNotNull(out); + inbound.stop(); + assertEquals("foo", out.getPayload()); + assertEquals("mqtt-foo", out.getHeaders().get(MqttHeaders.TOPIC)); + } + + @Test + public void testTwoTopics() { + MqttPahoMessageHandler adapter = new MqttPahoMessageHandler("tcp://localhost:1883", "si-test-out"); + adapter.setDefaultTopic("mqtt-foo"); + adapter.afterPropertiesSet(); + adapter.start(); + MqttPahoMessageDrivenChannelAdapter inbound = new MqttPahoMessageDrivenChannelAdapter("tcp://localhost:1883", "si-test-in", "mqtt-foo", "mqtt-bar"); + QueueChannel outputChannel = new QueueChannel(); + inbound.setOutputChannel(outputChannel); + ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler(); + taskScheduler.initialize(); + inbound.setTaskScheduler(taskScheduler); + inbound.afterPropertiesSet(); + inbound.start(); + adapter.handleMessage(new GenericMessage("foo")); + Message message = MessageBuilder.withPayload("bar").setHeader(MqttHeaders.TOPIC, "mqtt-bar").build(); + adapter.handleMessage(message); + adapter.stop(); + Message out = outputChannel.receive(1000); + assertNotNull(out); + inbound.stop(); + assertEquals("foo", out.getPayload()); + assertEquals("mqtt-foo", out.getHeaders().get(MqttHeaders.TOPIC)); + out = outputChannel.receive(1000); + assertNotNull(out); + inbound.stop(); + assertEquals("bar", out.getPayload()); + assertEquals("mqtt-bar", out.getHeaders().get(MqttHeaders.TOPIC)); } + +} diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BrokerRunning.java b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BrokerRunning.java new file mode 100644 index 0000000000..f7c57268a0 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/BrokerRunning.java @@ -0,0 +1,82 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt; + +import static org.junit.Assume.assumeNoException; +import static org.junit.Assume.assumeTrue; + +import java.util.HashMap; +import java.util.Map; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttException; +import org.junit.rules.TestWatcher; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; + +/** + * @author Gary Russell + * @since 3.0 + * + */ +public class BrokerRunning extends TestWatcher { + + private static Log logger = LogFactory.getLog(BrokerRunning.class); + + // Static so that we only test once on failure: speeds up test suite + private static Map brokerOnline = new HashMap(); + + private final int port; + + private BrokerRunning(int port) { + this.port = port; + brokerOnline.put(port, true); + } + + @Override + public Statement apply(Statement base, Description description) { + assumeTrue(brokerOnline.get(port)); + String url = "tcp://localhost:" + port; + MqttClient client = null; + try { + client = new DefaultMqttPahoClientFactory().getClientInstance(url, "junit-" + System.currentTimeMillis()); + client.connect(); + } + catch (MqttException e) { + logger.warn("Tests not running because no broker on " + url + ":", e); + assumeNoException(e); + } + finally { + if (client != null) { + try { + client.close(); + } + catch (MqttException e) { + } + } + } + return super.apply(base, description); + } + + + + public static BrokerRunning isRunning(int port) { + return new BrokerRunning(port); + } +} diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/MqttAdapterTests.java b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/MqttAdapterTests.java new file mode 100644 index 0000000000..bdce33fe61 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/MqttAdapterTests.java @@ -0,0 +1,237 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.anyString; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.Properties; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +import javax.net.SocketFactory; + +import org.eclipse.paho.client.mqttv3.MqttCallback; +import org.eclipse.paho.client.mqttv3.MqttClient; +import org.eclipse.paho.client.mqttv3.MqttConnectOptions; +import org.eclipse.paho.client.mqttv3.MqttMessage; +import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence; +import org.junit.Test; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; +import org.springframework.integration.Message; +import org.springframework.integration.channel.QueueChannel; +import org.springframework.integration.message.GenericMessage; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory.Will; +import org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter; +import org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler; +import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; + +/** + * @author Gary Russell + * @since 3.0 + * + */ +public class MqttAdapterTests { + + @Test + public void testPahoConnectOptions() { + DefaultMqttPahoClientFactory factory = new DefaultMqttPahoClientFactory(); + factory.setCleanSession(false); + factory.setConnectionTimeout(23); + factory.setKeepAliveInterval(45); + factory.setPassword("pass"); + SocketFactory socketFactory = mock(SocketFactory.class); + factory.setSocketFactory(socketFactory); + Properties props = new Properties(); + factory.setSslProperties(props); + factory.setUserName("user"); + Will will = new Will("foo", "bar".getBytes(), 2, true); + factory.setWill(will); + + MqttConnectOptions options = factory.getConnectionOptions(); + + assertEquals(23, options.getConnectionTimeout()); + assertEquals(45, options.getKeepAliveInterval()); + assertEquals("pass", new String(options.getPassword())); + assertSame(socketFactory, options.getSocketFactory()); + assertSame(props, options.getSSLProperties()); + assertEquals("user", options.getUserName()); + assertEquals("foo", options.getWillDestination()); + assertEquals("bar", new String(options.getWillMessage().getPayload())); + assertEquals(2, options.getWillMessage().getQos()); + + } + + @Test + public void testOutboundOptionsApplied() throws Exception { + DefaultMqttPahoClientFactory factory = new DefaultMqttPahoClientFactory(); + factory.setCleanSession(false); + factory.setConnectionTimeout(23); + factory.setKeepAliveInterval(45); + factory.setPassword("pass"); + MemoryPersistence persistence = new MemoryPersistence(); + factory.setPersistence(persistence); + final SocketFactory socketFactory = mock(SocketFactory.class); + factory.setSocketFactory(socketFactory); + final Properties props = new Properties(); + factory.setSslProperties(props); + factory.setUserName("user"); + Will will = new Will("foo", "bar".getBytes(), 2, true); + factory.setWill(will); + + factory = spy(factory); + final MqttClient client = mock(MqttClient.class); + doAnswer(new Answer() { + + @Override + public MqttClient answer(InvocationOnMock invocation) throws Throwable { + return client; + } + }).when(factory).getClientInstance(anyString(), anyString()); + + MqttPahoMessageHandler handler = new MqttPahoMessageHandler("foo", "bar", factory); + handler.setDefaultTopic("mqtt-foo"); + handler.afterPropertiesSet(); + handler.start(); + final AtomicBoolean connectCalled = new AtomicBoolean(); + doAnswer(new Answer(){ + + @Override + public Object answer(InvocationOnMock invocation) throws Throwable { + MqttConnectOptions options = (MqttConnectOptions) invocation.getArguments()[0]; + assertEquals(23, options.getConnectionTimeout()); + assertEquals(45, options.getKeepAliveInterval()); + assertEquals("pass", new String(options.getPassword())); + assertSame(socketFactory, options.getSocketFactory()); + assertSame(props, options.getSSLProperties()); + assertEquals("user", options.getUserName()); + assertEquals("foo", options.getWillDestination()); + assertEquals("bar", new String(options.getWillMessage().getPayload())); + assertEquals(2, options.getWillMessage().getQos()); + connectCalled.set(true); + return null; + } + }).when(client).connect(any(MqttConnectOptions.class)); + final AtomicBoolean publishCalled = new AtomicBoolean(); + doAnswer(new Answer() { + + @Override + public Object answer(InvocationOnMock invocation) throws Throwable { + assertEquals("mqtt-foo", invocation.getArguments()[0]); + MqttMessage message = (MqttMessage) invocation.getArguments()[1]; + assertEquals("Hello, world!", new String(message.getPayload())); + publishCalled.set(true); + return null; + } + }).when(client).publish(anyString(), any(MqttMessage.class)); + + handler.handleMessage(new GenericMessage("Hello, world!")); + + verify(client, times(1)).connect(any(MqttConnectOptions.class)); + assertTrue(connectCalled.get()); + } + + @Test + public void testInboundOptionsApplied() throws Exception { + DefaultMqttPahoClientFactory factory = new DefaultMqttPahoClientFactory(); + factory.setCleanSession(false); + factory.setConnectionTimeout(23); + factory.setKeepAliveInterval(45); + factory.setPassword("pass"); + MemoryPersistence persistence = new MemoryPersistence(); + factory.setPersistence(persistence); + final SocketFactory socketFactory = mock(SocketFactory.class); + factory.setSocketFactory(socketFactory); + final Properties props = new Properties(); + factory.setSslProperties(props); + factory.setUserName("user"); + Will will = new Will("foo", "bar".getBytes(), 2, true); + factory.setWill(will); + + factory = spy(factory); + final MqttClient client = mock(MqttClient.class); + doAnswer(new Answer() { + + @Override + public MqttClient answer(InvocationOnMock invocation) throws Throwable { + return client; + } + }).when(factory).getClientInstance(anyString(), anyString()); + + final AtomicBoolean connectCalled = new AtomicBoolean(); + doAnswer(new Answer() { + + @Override + public Object answer(InvocationOnMock invocation) throws Throwable { + MqttConnectOptions options = (MqttConnectOptions) invocation.getArguments()[0]; + assertEquals(23, options.getConnectionTimeout()); + assertEquals(45, options.getKeepAliveInterval()); + assertEquals("pass", new String(options.getPassword())); + assertSame(socketFactory, options.getSocketFactory()); + assertSame(props, options.getSSLProperties()); + assertEquals("user", options.getUserName()); + assertEquals("foo", options.getWillDestination()); + assertEquals("bar", new String(options.getWillMessage().getPayload())); + assertEquals(2, options.getWillMessage().getQos()); + connectCalled.set(true); + return null; + } + }).when(client).connect(any(MqttConnectOptions.class)); + + final AtomicReference callback = new AtomicReference(); + doAnswer(new Answer() { + + @Override + public Object answer(InvocationOnMock invocation) throws Throwable { + callback.set((MqttCallback) invocation.getArguments()[0]); + return null; + } + }).when(client).setCallback(any(MqttCallback.class)); + + when(client.isConnected()).thenReturn(true); + + MqttPahoMessageDrivenChannelAdapter adapter = new MqttPahoMessageDrivenChannelAdapter("foo", "bar", factory, "baz"); + QueueChannel outputChannel = new QueueChannel(); + adapter.setOutputChannel(outputChannel); + ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler(); + taskScheduler.initialize(); + adapter.setTaskScheduler(taskScheduler); + adapter.afterPropertiesSet(); + adapter.start(); + + verify(client, times(1)).connect(any(MqttConnectOptions.class)); + assertTrue(connectCalled.get()); + + MqttMessage message = new MqttMessage("qux".getBytes()); + callback.get().messageArrived("baz", message); + Message outMessage = outputChannel.receive(0); + assertNotNull(outMessage); + assertEquals("qux", outMessage.getPayload()); + } + +} diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests-context.xml b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests-context.xml new file mode 100644 index 0000000000..94162509f2 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests-context.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests.java b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests.java new file mode 100644 index 0000000000..ec895639d8 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParserTests.java @@ -0,0 +1,84 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertSame; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.integration.MessageChannel; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; +import org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter; +import org.springframework.integration.mqtt.support.MqttMessageConverter; +import org.springframework.integration.test.util.TestUtils; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * @author Gary Russell + * @since 3.0 + * + */ +@ContextConfiguration +@RunWith(SpringJUnit4ClassRunner.class) +public class MqttMessageDrivenChannelAdapterParserTests { + + @Autowired + private MqttPahoMessageDrivenChannelAdapter oneTopicAdapter; + + @Autowired + private MqttPahoMessageDrivenChannelAdapter twoTopicsAdapter; + + @Autowired + private MessageChannel out; + + @Autowired + private MqttMessageConverter converter; + + @Autowired + private DefaultMqttPahoClientFactory clientFactory; + + @Test + public void testOneTopic() { + assertEquals("tcp://localhost:1883", TestUtils.getPropertyValue(oneTopicAdapter, "url")); + assertFalse(TestUtils.getPropertyValue(oneTopicAdapter, "autoStartup", Boolean.class)); + assertEquals(25, TestUtils.getPropertyValue(oneTopicAdapter, "phase")); + assertEquals("foo", TestUtils.getPropertyValue(oneTopicAdapter, "clientId")); + assertEquals("bar", TestUtils.getPropertyValue(oneTopicAdapter, "topic", String[].class)[0]); + assertSame(converter, TestUtils.getPropertyValue(oneTopicAdapter, "converter")); + assertEquals(123L, TestUtils.getPropertyValue(oneTopicAdapter, "messagingTemplate.sendTimeout")); + assertSame(out, TestUtils.getPropertyValue(oneTopicAdapter, "outputChannel")); + assertSame(clientFactory, TestUtils.getPropertyValue(oneTopicAdapter, "clientFactory")); + } + + @Test + public void testTwoTopics() { + assertEquals("tcp://localhost:1883", TestUtils.getPropertyValue(oneTopicAdapter, "url")); + assertFalse(TestUtils.getPropertyValue(twoTopicsAdapter, "autoStartup", Boolean.class)); + assertEquals(25, TestUtils.getPropertyValue(twoTopicsAdapter, "phase")); + assertEquals("foo", TestUtils.getPropertyValue(twoTopicsAdapter, "clientId")); + assertEquals("bar", TestUtils.getPropertyValue(twoTopicsAdapter, "topic", String[].class)[0]); + assertEquals("baz", TestUtils.getPropertyValue(twoTopicsAdapter, "topic", String[].class)[1]); + assertSame(converter, TestUtils.getPropertyValue(twoTopicsAdapter, "converter")); + assertEquals(123L, TestUtils.getPropertyValue(twoTopicsAdapter, "messagingTemplate.sendTimeout")); + assertSame(out, TestUtils.getPropertyValue(twoTopicsAdapter, "outputChannel")); + assertSame(clientFactory, TestUtils.getPropertyValue(twoTopicsAdapter, "clientFactory")); + } + +} diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests-context.xml b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests-context.xml new file mode 100644 index 0000000000..203066d0d8 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests-context.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + diff --git a/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests.java b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests.java new file mode 100644 index 0000000000..be2552f465 --- /dev/null +++ b/spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/config/xml/MqttOutboundChannelAdapterParserTests.java @@ -0,0 +1,84 @@ +/* + * Copyright 2002-2013 the original author or authors. + * + * Licensed 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.springframework.integration.mqtt.config.xml; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory; +import org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler; +import org.springframework.integration.mqtt.support.DefaultPahoMessageConverter; +import org.springframework.integration.mqtt.support.MqttMessageConverter; +import org.springframework.integration.support.converter.MessageConverter; +import org.springframework.integration.test.util.TestUtils; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * @author Gary Russell + * @since 3.0 + * + */ +@ContextConfiguration +@RunWith(SpringJUnit4ClassRunner.class) +public class MqttOutboundChannelAdapterParserTests { + + @Autowired @Qualifier("withConverter.handler") + private MqttPahoMessageHandler withConverterHandler; + + @Autowired @Qualifier("withDefaultConverter.handler") + private MqttPahoMessageHandler withDefaultConverterHandler; + + @Autowired + private MqttMessageConverter converter; + + @Autowired + private DefaultMqttPahoClientFactory clientFactory; + + @Test + public void testWithConverter() { + assertEquals("tcp://localhost:1883", TestUtils.getPropertyValue(withConverterHandler, "url")); + assertFalse(TestUtils.getPropertyValue(withConverterHandler, "autoStartup", Boolean.class)); + assertEquals(25, TestUtils.getPropertyValue(withConverterHandler, "phase")); + assertEquals("foo", TestUtils.getPropertyValue(withConverterHandler, "clientId")); + assertEquals("bar", TestUtils.getPropertyValue(withConverterHandler, "defaultTopic")); + assertSame(converter, TestUtils.getPropertyValue(withConverterHandler, "converter")); + assertSame(clientFactory, TestUtils.getPropertyValue(withConverterHandler, "clientFactory")); + } + + @Test + public void testWithDefaultConverter() { + assertEquals("tcp://localhost:1883", TestUtils.getPropertyValue(withDefaultConverterHandler, "url")); + assertFalse(TestUtils.getPropertyValue(withDefaultConverterHandler, "autoStartup", Boolean.class)); + assertEquals(25, TestUtils.getPropertyValue(withDefaultConverterHandler, "phase")); + assertEquals("foo", TestUtils.getPropertyValue(withDefaultConverterHandler, "clientId")); + assertEquals("bar", TestUtils.getPropertyValue(withDefaultConverterHandler, "defaultTopic")); + assertEquals(1, TestUtils.getPropertyValue(withDefaultConverterHandler, "defaultQos")); + assertTrue(TestUtils.getPropertyValue(withDefaultConverterHandler, "defaultRetained", Boolean.class)); + MessageConverter defaultConverter = TestUtils.getPropertyValue(withDefaultConverterHandler, "converter", MessageConverter.class); + assertTrue(defaultConverter instanceof DefaultPahoMessageConverter); + assertEquals(1, TestUtils.getPropertyValue(defaultConverter, "defaultQos")); + assertTrue(TestUtils.getPropertyValue(defaultConverter, "defaultRetained", Boolean.class)); + assertSame(clientFactory, TestUtils.getPropertyValue(withDefaultConverterHandler, "clientFactory")); + } + +} diff --git a/spring-integration-mqtt/src/test/resources/log4j.properties b/spring-integration-mqtt/src/test/resources/log4j.properties new file mode 100644 index 0000000000..69750fc24e --- /dev/null +++ b/spring-integration-mqtt/src/test/resources/log4j.properties @@ -0,0 +1,8 @@ +log4j.rootCategory=WARN, stdout + +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern=%d{HH:mm:ss.SSS} %-5p [%t][%c] %m%n + +log4j.category.org.springframework.integration=WARN +log4j.category.org.springframework.integration.mqtt=INFO