Cleanup (#3)

* added license header
fixed fail on javadoc task

* change from CR

* Uniform readme

* Update gradle to 6.6.1

Author: DC2-DanielKrueger

README.adoc

@@ -1,22 +1,23 @@
-:hivemq-kafka-docs-link: https://www.hivemq.com/docs/kafka/latest/enterprise-extension-for-kafka/kafka.html
-:hivemq-kafka-customization-docs-link: https://www.hivemq.com/docs/kafka/latest/enterprise-extension-for-kafka/kafka.html#customization
-:hivemq-blog-tools: http://www.hivemq.com/mqtt-toolbox
+:hivemq-link: https://www.hivemq.com
+:hivemq-kafka-docs: {hivemq-link}/docs/kafka/latest/enterprise-extension-for-kafka/kafka.html
+:hivemq-kafka-customization-docs: {hivemq-link}/docs/kafka/latest/enterprise-extension-for-kafka/kafka-customization.html
+:hivemq-blog-tools: {hivemq-link}/mqtt-toolbox/
 :hivemq-support: https://community.hivemq.com/c/hivemq-extension-sdk/kafka-customization/14
 
 = HiveMQ Kafka Extension Hello World Customization
 
-*Type*: Demonstration Customization
+*Customization Type*: Demonstration
 
 *Version*: 4.5.0
 
-*License*: Apache License Version 2.0
+*License*: Apache License 2.0
 
 == Purpose
 
 This Hello World customizations uses a Mqtt-to-Kafka transformer which forwards MQTT PUBLISHES to a Kafka cluster.
 It maps the MQTT topic structure to a matching Kafka topic structure and preserves MQTT 4 user properties as Kafka record headers.
 
-We strongly recommend reading the {hivemq-kafka-docs-link}[HiveMQ Enterprise Extension for Kafka Documentation]
+We strongly recommend reading the {hivemq-kafka-docs}[HiveMQ Enterprise Extension for Kafka Documentation]
 to grasp the core concepts of HiveMQ Kafka customization development.
 
 == Installation
@@ -36,13 +37,13 @@ Connect with an {hivemq-blog-tools}[MQTT client] of your choice.
 Publish a MQTT message to the topic _transform/customization_.
 Monitor your Kafka cluster for a record from topic _transform.customization_.
 
-== Next steps
+== Next Steps
 
 Awesome, you got your first HiveMQ Kafka customization working.
 
-Now read the {hivemq-kafka-customization-docs-link}[HiveMQ Kafka Extension Customization Documentation] to see what customizations can do.
+Now read the {hivemq-kafka-customization-docs}[HiveMQ Kafka Extension Customization Documentation] to see what customizations can do.
 
-== Need help?
+== Need Help?
 
 If you encounter any problems, we are happy to help.
 The best place to get in contact is our {hivemq-support}[community forum].

build.gradle.kts

@@ -97,6 +97,7 @@ tasks.withType<Jar>().configureEach {
 
 tasks.javadoc {
     title = "${metadata.readableName} ${project.version} API"
+    isFailOnError = false
 }
 
 /* ******************** checks ******************** */

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -130,7 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath

gradlew

@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -54,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -64,29 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell

gradlew.bat

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2020-present HiveMQ GmbH
+ *
+ * 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 com.hivemq.extensions.kafka.customizations.helloworld;
 
 import com.codahale.metrics.Counter;

src/main/java/com/hivemq/extensions/kafka/customizations/helloworld/KafkaToMqttHelloWorldTransformer.java

@@ -35,7 +35,7 @@ private KafkaTopicUtil() {}
      *
      * @param mqttTopic a single or multilevel MQTT topic
      * @return a single or multilevel Kafka topic
-     * @see <a href=" https://stackoverflow.com/questions/37062904/what-are-apache-kafka-topic-name-limitations">What
+     * @see <a href="https://stackoverflow.com/questions/37062904/what-are-apache-kafka-topic-name-limitations">What
      *         are Apache Kafka topic name limitations?</a>
      */
     public static @NotNull String mqttToKafkaTopic(final @NotNull String mqttTopic) {

src/main/java/com/hivemq/extensions/kafka/customizations/helloworld/KafkaTopicUtil.java

@@ -1,4 +1,21 @@
 <?xml version="1.0" encoding="UTF-8" ?>
+<!--
+
+    Copyright 2020-present HiveMQ GmbH
+
+    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.
+
+-->
 <kafka-configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                      xsi:noNamespaceSchemaLocation="kafka-extension.xsd">
 

src/main/resources/kafka-configuration.xml

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2020-present HiveMQ GmbH
+ *
+ * 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 com.hivemq.extensions.kafka.customizations.helloworld;
 
 import com.hivemq.extension.sdk.api.packets.general.UserProperties;