Cleanup - SStill W.I.P

Signed-off-by: Jem Day <[email protected]>

Author: JemDay

bindings/mqtt/core/src/main/java/io/cloudevents/mqtt/core/BaseMqttBinaryMessageReader.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.core;
 
 import io.cloudevents.SpecVersion;
@@ -25,9 +41,10 @@ public abstract class BaseMqttBinaryMessageReader extends BaseGenericBinaryMessa
 
     /**
      * Initialise the binary message reader.
-     * @param version The CloudEvent message version.
+     *
+     * @param version     The CloudEvent message version.
      * @param contentType The assigned media content type.
-     * @param payload The raw data payload from the MQTT message.
+     * @param payload     The raw data payload from the MQTT message.
      */
     protected BaseMqttBinaryMessageReader(final SpecVersion version, final String contentType, final byte[] payload) {
         super(version, payload != null && payload.length > 0 ? BytesCloudEventData.wrap(payload) : null);
@@ -82,6 +99,7 @@ protected String toCloudEventsValue(Object value) {
 
     /**
      * Visit each MQTT user-property and invoke the supplied function.
+     *
      * @param fn The function to invoke for each MQTT User property.
      */
     protected abstract void forEachUserProperty(BiConsumer<String, Object> fn);

bindings/mqtt/core/src/main/java/io/cloudevents/mqtt/core/MqttUtils.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.core;
 
 import io.cloudevents.core.format.EventFormat;
@@ -8,24 +24,26 @@
  */
 public class MqttUtils {
 
-    private MqttUtils() {}
+    private static final String DEFAULT_FORMAT = "application/cloudevents+json";
 
-    private  static final String DEFAULT_FORMAT = "application/cloudevents+json";
+    private MqttUtils() {
+    }
 
     /**
      * Obtain the {@link EventFormat} to use when working with MQTT V3
      * messages.
      *
      * @return An event format.
      */
-    public static EventFormat getDefaultEventFormat () {
+    public static EventFormat getDefaultEventFormat() {
 
         return EventFormatProvider.getInstance().resolveFormat(DEFAULT_FORMAT);
 
     }
 
     /**
      * Get the default content type to assume for MQTT messages.
+     *
      * @return A Content-Type
      */
     public static final String getDefaultContentType() {

bindings/mqtt/hivemq/src/main/java/io/cloudevents/mqtt/hivemq/BinaryMessageReader.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish;

bindings/mqtt/hivemq/src/main/java/io/cloudevents/mqtt/hivemq/MqttMessageFactory.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.datatypes.MqttUtf8String;
@@ -20,7 +36,6 @@
  * A factory to obtain:
  * - {@link MessageReader} instances to read CloudEvents from MQTT messages.
  * - {@link MessageWriter} instances to write CloudEvents into MQTT messages.
- *
  */
 public class MqttMessageFactory {
 
@@ -74,7 +89,7 @@ public static MessageWriter createWriter(Mqtt5PublishBuilder.Complete builder) {
 
     /**
      * Create a {@link MessageWriter} for an MQTT V3 Message.
-     *
+     * <p>
      * Only supports structured messages.
      *
      * @param builder {@link Mqtt3PublishBuilder.Complete}
@@ -89,6 +104,7 @@ public static MessageWriter createWriter(Mqtt3PublishBuilder.Complete builder) {
 
     /**
      * Find the value of the CloudEvent 'specversion' in the MQTT V5 User Properties.
+     *
      * @param message An MQTT message.
      * @return spec version attribute content.
      */

bindings/mqtt/hivemq/src/main/java/io/cloudevents/mqtt/hivemq/V3MessageWriter.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3PublishBuilder;
@@ -20,21 +36,21 @@ class V3MessageWriter implements MessageWriter<CloudEventWriter<Mqtt3PublishBuil
     @Override
     public CloudEventWriter<Mqtt3PublishBuilder> create(SpecVersion version) throws CloudEventRWException {
         // No-Op
-        return null;
+        throw CloudEventRWException.newOther("Internal Error");
     }
 
     @Override
     public Mqtt3PublishBuilder setEvent(EventFormat format, byte[] value) throws CloudEventRWException {
         // No-Op
-        return null;
+        throw CloudEventRWException.newOther("Internal Error");
     }
 
     @Override
     public Mqtt3PublishBuilder writeStructured(CloudEvent event, String format) {
-        EventFormat eventFormat = EventFormatProvider.getInstance().resolveFormat(format);
+        final EventFormat eventFormat = EventFormatProvider.getInstance().resolveFormat(format);
 
         if (eventFormat != null) {
-            return writeStructured(event, EventFormatProvider.getInstance().resolveFormat(format));
+            return writeStructured(event, eventFormat);
         } else {
             throw CloudEventRWException.newOther("Unsupported Format: " + format);
         }

bindings/mqtt/hivemq/src/main/java/io/cloudevents/mqtt/hivemq/V5MessageWriter.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5PublishBuilder;

bindings/mqtt/hivemq/src/main/java/io/cloudevents/mqtt/hivemq/package-info.java

@@ -1,14 +1,13 @@
 /**
  * This module implements the MQTT binding specification using the
  * HiveMQ MQTT client library.
- *
+ * <p>
  * Use the {@link io.cloudevents.mqtt.hivemq.MqttMessageFactory} to obtain
  * CloudEvent reader and writer instances.
- *
+ * <p>
  * Both V3 and V5 versions of MQTT are supported.
  *
  * @since 2.5.0
- *
  */
 
 package io.cloudevents.mqtt.hivemq;

bindings/mqtt/hivemq/src/test/java/io/cloudevents/mqtt/hivemq/MqttMessageFactoryTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3Publish;

bindings/mqtt/hivemq/src/test/java/io/cloudevents/mqtt/hivemq/V3MessageWriterTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3Publish;

bindings/mqtt/hivemq/src/test/java/io/cloudevents/mqtt/hivemq/V3RoundTripTests.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3Publish;

bindings/mqtt/hivemq/src/test/java/io/cloudevents/mqtt/hivemq/V5MessageWriterTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt5.datatypes.Mqtt5UserProperty;

bindings/mqtt/hivemq/src/test/java/io/cloudevents/mqtt/hivemq/V5RoundTripTests.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.hivemq;
 
 import com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish;

bindings/mqtt/paho/src/main/java/io/cloudevents/mqtt/paho/BinaryMessageReader.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.paho;
 
 import io.cloudevents.SpecVersion;

bindings/mqtt/paho/src/main/java/io/cloudevents/mqtt/paho/PahoMessageUtils.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2018-Present The CloudEvents Authors
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.cloudevents.mqtt.paho;
 
 import org.eclipse.paho.mqttv5.common.MqttMessage;