INTEXT-64 MQTT Adapters

spring-integration-mqtt/README.md

@@ -0,0 +1,76 @@
+Spring Integration Mqtt Adapters
+=================================================
+
+`inbound` and `outbound` channel adapters are provided for Mqtt. The current implementation uses the [Eclipse Paho][] client.
+
+Example configurations...
+
+	<int-mqtt:message-driven-channel-adapter id="twoTopicsAdapter"
+		client-id="foo"
+		url="tcp://localhost:1883"
+		topics="bar, baz"
+		channel="out" />
+
+	<int-mqtt:outbound-channel-adapter id="withDefaultConverter"
+			client-id="foo"
+			url="tcp://localhost:1883"
+			default-qos="1"
+			default-retained="true"
+			default-topic="bar"
+			channel="target" />
+
+
+Spring integration messages sent to the outbound adapter can have headers `mqtt_topic, mqtt_qos, mqtt_retained` which will override the defaults configured on the adapter.
+
+Inbound messages will have headers 
+
+    mqtt_topic       - the topic from which the message was received
+    mqtt_duplicate   - true if the message is a duplicate
+    mqtt_qos         - the quality of service
+
+
+
+Both adapters use a `MqttPahoClientFactory` to get a client instance; the same factory also provides connection options from configured properties (such as user/password). The client factory bean (`DefaultMqttPahoClientFactory`) is provided to the adapter using the `client-factory` attribute. When not provided, a default factory instance is used.
+
+
+Currently tested with the RabbitMQ MQTT plugin.
+
+
+##Note:
+
+Currently, the Paho java client is not mavenized; there is an [open paho bug][] to resolve this. In the meantime, you can manually add the jar to your maven repo:
+
+    mvn install:install-file -DgroupId=org.eclipse.paho -DartifactId=MQTT-Java -Dversion=3.0 -Dpackaging=jar -Dfile=/path/to/org.eclipse.paho.client.mqttv3.jar 
+
+
+
+Check out the [Spring Integration forums][] and the [spring-integration][spring-integration tag] tag
+on [Stack Overflow][]. [Commercial support][] is available, too.
+
+## Related GitHub projects
+
+* [Spring Integration][]
+* [Spring Integration Samples][]
+* [Spring Integration Templates][]
+* [Spring Integration Dsl Groovy][]
+* [Spring Integration Dsl Scala][]
+* [Spring Integration Pattern Catalog][]
+
+For more information, please also don't forget to visit the [Spring Integration][] website.
+
+## Eclipse Paho
+
+* [Eclipse Paho][]
+
+[Spring Integration]: https://github.com/SpringSource/spring-integration
+[Commercial support]: http://springsource.com/support/springsupport
+[Spring Integration forums]: http://forum.springsource.org/forumdisplay.php?42-Integration
+[spring-integration tag]: http://stackoverflow.com/questions/tagged/spring-integration
+[Spring Integration Samples]: https://github.com/SpringSource/spring-integration-samples
+[Spring Integration Templates]: https://github.com/SpringSource/spring-integration-templates/tree/master/si-sts-templates
+[Spring Integration Dsl Groovy]: https://github.com/SpringSource/spring-integration-dsl-groovy
+[Spring Integration Dsl Scala]: https://github.com/SpringSource/spring-integration-dsl-scala
+[Spring Integration Pattern Catalog]: https://github.com/SpringSource/spring-integration-pattern-catalog
+[Stack Overflow]: http://stackoverflow.com/faq
+[Eclipse Paho]: http://www.eclipse.org/paho/
+[open paho bug]: https://bugs.eclipse.org/bugs/show_bug.cgi?id=382471

spring-integration-mqtt/build.gradle

@@ -0,0 +1,266 @@
+description = 'Spring Integration Mqtt Adapter'
+
+buildscript {
+	repositories {
+		maven { url 'https://repo.springsource.org/plugins-snapshot' }
+	}
+	dependencies {
+		classpath 'org.springframework.build.gradle:docbook-reference-plugin:0.1.5'
+	}
+}
+
+apply plugin: 'java'
+apply from:   "${rootProject.projectDir}/publish-maven.gradle"
+apply plugin: 'eclipse'
+apply plugin: 'idea'
+
+group = 'org.springframework.integration.mqtt'
+
+repositories {
+	maven { url 'http://repo.springsource.org/libs-snapshot' }
+	maven { url 'http://repo.springsource.org/plugins-release' }
+	mavenLocal()
+}
+
+sourceCompatibility=1.6
+targetCompatibility=1.6
+
+ext {
+	junitVersion = '4.10'
+	log4jVersion = '1.2.12'
+	mockitoVersion = '1.9.0'
+	springVersion = '3.1.3.RELEASE'
+	springIntegrationVersion = '3.0.0.BUILD-SNAPSHOT'
+
+	idPrefix = 'mqttadapter'
+}
+
+eclipse {
+	project {
+		natures += 'org.springframework.ide.eclipse.core.springnature'
+	}
+}
+
+sourceSets {
+	test {
+		resources {
+			srcDirs = ['src/test/resources', 'src/test/java']
+		}
+	}
+}
+
+// See http://www.gradle.org/docs/current/userguide/dependency_management.html#sub:configurations
+// and http://www.gradle.org/docs/current/dsl/org.gradle.api.artifacts.ConfigurationContainer.html
+configurations {
+	jacoco //Configuration Group used by Sonar to provide Code Coverage using JaCoCo
+}
+
+dependencies {
+	compile     "org.springframework.integration:spring-integration-core:$springIntegrationVersion"
+	compile		"org.eclipse.paho:MQTT-Java:3.0"
+	testCompile "org.springframework.integration:spring-integration-test:$springIntegrationVersion"
+	testCompile "junit:junit-dep:$junitVersion"
+	testCompile "log4j:log4j:$log4jVersion"
+	testCompile "org.mockito:mockito-all:$mockitoVersion"
+	testCompile "org.springframework:spring-test:$springVersion"
+	jacoco group: "org.jacoco", name: "org.jacoco.agent", version: "0.5.6.201201232323", classifier: "runtime"
+}
+
+
+// enable all compiler warnings; individual projects may customize further
+ext.xLintArg = '-Xlint:all'
+[compileJava, compileTestJava]*.options*.compilerArgs = [xLintArg]
+
+test {
+	// suppress all console output during testing unless running `gradle -i`
+	logging.captureStandardOutput(LogLevel.INFO)
+	jvmArgs "-javaagent:${configurations.jacoco.asPath}=destfile=${buildDir}/jacoco.exec,includes=*"
+}
+
+task sourcesJar(type: Jar) {
+	classifier = 'sources'
+	from sourceSets.main.allJava
+}
+
+task javadocJar(type: Jar) {
+	classifier = 'javadoc'
+	from javadoc
+}
+
+artifacts {
+	archives sourcesJar
+	archives javadocJar
+}
+
+apply plugin: 'docbook-reference'
+
+reference {
+	sourceDir = file('src/reference/docbook')
+}
+
+apply plugin: 'sonar'
+
+sonar {
+
+	if (rootProject.hasProperty('sonarHostUrl')) {
+		server.url = rootProject.sonarHostUrl
+	}
+
+	database {
+		if (rootProject.hasProperty('sonarJdbcUrl')) {
+			url = rootProject.sonarJdbcUrl
+		}
+		if (rootProject.hasProperty('sonarJdbcDriver')) {
+			driverClassName = rootProject.sonarJdbcDriver
+		}
+		if (rootProject.hasProperty('sonarJdbcUsername')) {
+			username = rootProject.sonarJdbcUsername
+		}
+		if (rootProject.hasProperty('sonarJdbcPassword')) {
+			password = rootProject.sonarJdbcPassword
+		}
+	}
+
+	project {
+		dynamicAnalysis  = "reuseReports"
+		withProjectProperties { props ->
+			props["sonar.core.codeCoveragePlugin"] = "jacoco"
+			props["sonar.jacoco.reportPath"]       = "${buildDir.name}/jacoco.exec"
+		}
+	}
+
+	logger.info("Sonar parameters used: server.url='${server.url}'; database.url='${database.url}'; database.driverClassName='${database.driverClassName}'; database.username='${database.username}'")
+}
+
+task api(type: Javadoc) {
+	group = 'Documentation'
+	description = 'Generates the Javadoc API documentation.'
+	title = "${rootProject.description} ${version} API"
+	options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
+	options.author = true
+	options.header = rootProject.description
+	options.overview = 'src/api/overview.html'
+
+	source = sourceSets.main.allJava
+	classpath = project.sourceSets.main.compileClasspath
+	destinationDir = new File(buildDir, "api")
+}
+
+task schemaZip(type: Zip) {
+	group = 'Distribution'
+	classifier = 'schema'
+	description = "Builds -${classifier} archive containing all " +
+		"XSDs for deployment at static.springframework.org/schema."
+
+	def Properties schemas = new Properties();
+	def shortName = idPrefix.replaceFirst("${idPrefix}-", '')
+
+	project.sourceSets.main.resources.find {
+		it.path.endsWith('META-INF/spring.schemas')
+	}?.withInputStream { schemas.load(it) }
+
+	for (def key : schemas.keySet()) {
+		File xsdFile = project.sourceSets.main.resources.find {
+			it.path.endsWith(schemas.get(key))
+		}
+		assert xsdFile != null
+		into ("integration/${shortName}") {
+			from xsdFile.path
+		}
+	}
+
+}
+
+task docsZip(type: Zip) {
+	group = 'Distribution'
+	classifier = 'docs'
+	description = "Builds -${classifier} archive containing api and reference " +
+			"for deployment at static.springframework.org/spring-integration/docs."
+
+	from('src/dist') {
+		include 'changelog.txt'
+	}
+
+	from (api) {
+		into 'api'
+	}
+
+	from (reference) {
+		into 'reference'
+	}
+}
+
+task distZip(type: Zip, dependsOn: [docsZip, schemaZip]) {
+	group = 'Distribution'
+	classifier = 'dist'
+	description = "Builds -${classifier} archive, containing all jars and docs, " +
+		"suitable for community download page."
+
+	ext.baseDir = "${project.name}-${project.version}";
+
+	from('src/dist') {
+		include 'readme.txt'
+		include 'license.txt'
+		include 'notice.txt'
+		into "${baseDir}"
+	}
+
+	from(zipTree(docsZip.archivePath)) {
+		into "${baseDir}/docs"
+	}
+
+	from(zipTree(schemaZip.archivePath)) {
+		into "${baseDir}/schema"
+	}
+
+	into ("${baseDir}/libs") {
+		from project.jar
+		from project.sourcesJar
+		from project.javadocJar
+	}
+}
+
+// Create an optional "with dependencies" distribution.
+// Not published by default; only for use when building from source.
+task depsZip(type: Zip, dependsOn: distZip) { zipTask ->
+	group = 'Distribution'
+	classifier = 'dist-with-deps'
+	description = "Builds -${classifier} archive, containing everything " +
+		"in the -${distZip.classifier} archive plus all dependencies."
+
+	from zipTree(distZip.archivePath)
+
+	gradle.taskGraph.whenReady { taskGraph ->
+		if (taskGraph.hasTask(":${zipTask.name}")) {
+			def projectName = rootProject.name
+			def artifacts = new HashSet()
+
+			rootProject.configurations.runtime.resolvedConfiguration.resolvedArtifacts.each { artifact ->
+				def dependency = artifact.moduleVersion.id
+				if (!projectName.equals(dependency.name)) {
+					artifacts << artifact.file
+				}
+			}
+
+			zipTask.from(artifacts) {
+				into "${distZip.baseDir}/deps"
+			}
+		}
+	}
+}
+
+artifacts {
+	archives distZip
+	archives docsZip
+	archives schemaZip
+}
+
+task dist(dependsOn: assemble) {
+	group = 'Distribution'
+	description = 'Builds -dist, -docs and -schema distribution archives.'
+}
+
+task wrapper(type: Wrapper) {
+	description = 'Generates gradlew[.bat] scripts'
+	gradleVersion = '1.3'
+}

spring-integration-mqtt/gradle.properties

@@ -0,0 +1 @@
+version=1.0.0.BUILD-SNAPSHOT

spring-integration-mqtt/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Wed Sep 05 13:34:36 EDT 2012
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=http\://services.gradle.org/distributions/gradle-1.1-bin.zip