[huesync][WIP] Hue Play HDMI Sync Box Binding - Initial contribution

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/HueSyncDeviceInfoCapabilities.java

@@ -12,6 +12,8 @@
  */
 package org.openhab.binding.huesync.internal.api.dto;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
 /**
  * HDMI Sync Box Device Information Cababilities DTO
  * 
@@ -21,6 +23,7 @@
  *      "https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/#Resource%20Table">Hue
  *      HDMI Sync Box API</a>
  */
+@NonNullByDefault
 public class HueSyncDeviceInfoCapabilities {
     /** The total number of IR codes configurable */
     public int maxIrCodes;

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/device/HueSyncDetailedDeviceInfo.java

@@ -14,6 +14,7 @@
 
 import java.util.Date;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 
 /**
@@ -26,28 +27,31 @@
  *      "https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/#Resource%20Table">Hue
  *      HDMI Sync Box API</a>
  */
+@NonNullByDefault
 public class HueSyncDetailedDeviceInfo extends HueSyncDeviceInfo {
-    public HueSyncDeteiledDeviceInfoWifi wifi;
-    public HueSyncDetailedDeviceInfoUpdate update;
+    public @Nullable HueSyncDetailedDeviceInfoWifi wifi;
+    public @Nullable HueSyncDetailedDeviceInfoUpdate update;
 
     /** UTC time when last check for update was performed. */
-    public Date lastCheckedUpdate;
+    public @Nullable Date lastCheckedUpdate;
     /**
      * Build number that is available to update to. Item is set to null when there
      * is no update available.
      */
-    public @Nullable Integer updatableBuildNumber;
+    public int updatableBuildNumber;
     /**
      * User readable version of the firmware the device can upgrade to. Item is set
      * to null when there is no update available.
      */
-    public @Nullable String updatableFirmwareVersion;
+    public int updatableFirmwareVersion;
     /**
-     * 1 = regular; 0 = off in powersave, passthrough or sync mode; 2 = dimmed in
-     * powersave or passthrough mode and off in sync mode
+     * 1 = regular;
+     * 0 = off in powersave, passthrough or sync mode;
+     * 2 = dimmed in powersave or passthrough mode and off in sync mode
      */
     public int ledMode;
+
     /** none, doSoftwareRestart, doFirmwareUpdate */
-    public String action;
-    public String pushlink;
+    public @Nullable String action;
+    public @Nullable String pushlink;
 }

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/device/HueSyncDetailedDeviceInfoUpdate.java

@@ -12,6 +12,8 @@
  */
 package org.openhab.binding.huesync.internal.api.dto.device;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
 /**
  * HDMI Sync Box Device Information DTO - Automatic Firmware update
  * 
@@ -21,7 +23,7 @@
  *      "https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/#Resource%20Table">Hue
  *      HDMI Sync Box API</a>
  */
-
+@NonNullByDefault
 public class HueSyncDetailedDeviceInfoUpdate {
     /**
      * Sync Box checks daily for a firmware update. If true, an available update

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/device/HueSyncDeteiledDeviceInfoWifi.java → bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/device/HueSyncDetailedDeviceInfoWifi.java

@@ -12,6 +12,9 @@
  */
 package org.openhab.binding.huesync.internal.api.dto.device;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
 /**
  * HDMI Sync Box Device Information DTO - Wifi connection information
  * 
@@ -21,9 +24,16 @@
  *      "https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/#Resource%20Table">Hue
  *      HDMI Sync Box API</a>
  */
-public class HueSyncDeteiledDeviceInfoWifi {
+@NonNullByDefault
+public class HueSyncDetailedDeviceInfoWifi {
     /** Wifi SSID */
-    public String ssid;
-    /** 0 = not connected; 1 = weak; 2 = fair; 3 = good; 4 = excellent */
+    public @Nullable String ssid;
+    /**
+     * 0 = not connected;
+     * 1 = weak;
+     * 2 = fair;
+     * 3 = good;
+     * 4 = excellent
+     */
     public int strength;
 }

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/device/HueSyncDeviceInfo.java

@@ -12,7 +12,8 @@
  */
 package org.openhab.binding.huesync.internal.api.dto.device;
 
-import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.binding.huesync.internal.api.dto.HueSyncDeviceInfoCapabilities;
 
 /**
@@ -24,17 +25,18 @@
  *      "https://developers.meethue.com/develop/hue-entertainment/hue-hdmi-sync-box-api/#Resource%20Table">Hue
  *      HDMI Sync Box API</a>
  */
+@NonNullByDefault
 public class HueSyncDeviceInfo {
     /** Friendly name of the device */
-    public String name;
+    public @Nullable String name;
     /** Device Type identifier */
-    public String deviceType;
+    public @Nullable String deviceType;
     /**
      * Capitalized hex string of the 6 byte / 12 characters device id without
      * delimiters. Used as unique id on label, certificate common name, hostname
      * etc.
      */
-    public @NonNull String uniqueId = "";
+    public @Nullable String uniqueId;
     /**
      * Increased between firmware versions when api changes. Only apiLevel >= 7 is
      * supported.
@@ -44,17 +46,21 @@ public class HueSyncDeviceInfo {
      * User readable version of the device firmware, starting with decimal major
      * .minor .maintenance format e.g. “1.12.3”
      */
-    public String firmwareVersion;
+    public @Nullable String firmwareVersion;
     /**
      * Build number of the firmware. Unique for every build with newer builds
      * guaranteed a higher number than older.
      */
     public int buildNumber;
+
     public boolean termsAgreed;
+
     /** uninitialized, disconnected, lan, wan */
-    public String wifiState;
-    public String ipAddress;
-    public HueSyncDeviceInfoCapabilities capabilities;
+    public @Nullable String wifiState;
+    public @Nullable String ipAddress;
+
+    public @Nullable HueSyncDeviceInfoCapabilities capabilities;
+
     public boolean beta;
     public boolean overheating;
     public boolean bluetooth;

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/registration/HueSyncRegistration.java

@@ -12,11 +12,15 @@
  */
 package org.openhab.binding.huesync.internal.api.dto.registration;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
 /**
  * 
  * @author Patrik Gfeller - Initial Contribution
  */
+@NonNullByDefault
 public class HueSyncRegistration {
-    public String registrationId;
-    public String accessToken;
+    public @Nullable String registrationId;
+    public @Nullable String accessToken;
 }

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/api/dto/registration/HueSyncRegistrationRequest.java

@@ -12,13 +12,17 @@
  */
 package org.openhab.binding.huesync.internal.api.dto.registration;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
 /**
  * 
  * @author Patrik Gfeller - Initial Contribution
  */
+@NonNullByDefault
 public class HueSyncRegistrationRequest {
     /** User recognizable name of registered application */
-    public String appName;
+    public @Nullable String appName;
     /** User recognizable name of application instance. */
-    public String instanceName;
+    public @Nullable String instanceName;
 }

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/connection/HueSyncConnection.java

@@ -18,7 +18,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
-import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.jetty.client.HttpClient;
@@ -42,19 +41,19 @@
 import org.slf4j.Logger;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
  * Handles the connection to a Hue HDMI Sync Box using the official API.
  * 
  * @author Patrik Gfeller - Initial Contribution
  */
+@NonNullByDefault
 public class HueSyncConnection {
     /**
      * Request format: The Sync Box API can be accessed locally via HTTPS on root
      * level (port 443, /api/v1), resource level /api/v1/<resource> and in some
-     * cases subresource level /api/v1/<resource>/<subresource>.
+     * cases sub-resource level /api/v1/<resource>/<sub-resource>.
      */
     private static final String REQUEST_FORMAT = "https://%s:%s/%s/%s";
     private static final String API = "api/v1";
@@ -69,16 +68,15 @@ private static class ENDPOINTS {
 
     private final Logger logger = HueSyncLogFactory.getLogger(HueSyncConnection.class);
 
-    private @NonNull HttpClient httpClient;
-    private @NonNull String host;
-    private @NonNull Integer port;
+    private HttpClient httpClient;
+    private String host;
+    private Integer port;
 
     private @Nullable String apiAccessToken;
     private @Nullable String registrationId;
 
     private ServiceRegistration<?> tlsProviderService;
 
-    @NonNullByDefault
     public HueSyncConnection(HttpClient httpClient, String host, Integer port, String apiAccessToken,
             String registrationId) throws CertificateException, IOException {
 
@@ -95,59 +93,57 @@ public HueSyncConnection(HttpClient httpClient, String host, Integer port, Strin
         this.httpClient = httpClient;
     }
 
+    @SuppressWarnings("null")
     public @Nullable HueSyncDeviceInfo getDeviceInfo() {
         HueSyncDeviceInfo deviceInfo = null;
 
-        try {
-            ContentResponse response = this.executeGetRequest(ENDPOINTS.DEVICE);
+        ContentResponse response = this.executeGetRequest(ENDPOINTS.DEVICE);
 
-            if (response.getStatus() == HttpStatus.OK_200) {
-                deviceInfo = this.deserialize(response.getContentAsString(), HueSyncDeviceInfo.class);
-            }
-        } catch (InterruptedException | ExecutionException | TimeoutException | JsonProcessingException e) {
-            this.logger.error("{}", e.getMessage());
+        if (this.responseReceived(response)) {
+            deviceInfo = this.deserialize(response.getContentAsString(), HueSyncDeviceInfo.class);
         }
 
         return deviceInfo;
     }
 
+    @SuppressWarnings("null")
     public @Nullable HueSyncDetailedDeviceInfo getDetailedDeviceInfo() {
         if (!this.isRegistered())
             return null;
 
         HueSyncDetailedDeviceInfo deviceInfo = null;
 
-        try {
-            ContentResponse response = this.executeGetRequest(ENDPOINTS.DEVICE);
+        ContentResponse response = this.executeGetRequest(ENDPOINTS.DEVICE);
 
-            if (response.getStatus() == HttpStatus.OK_200) {
-                deviceInfo = this.deserialize(response.getContentAsString(), HueSyncDetailedDeviceInfo.class);
-            }
-        } catch (InterruptedException | ExecutionException | TimeoutException | JsonProcessingException e) {
-            this.logger.error("{}", e.getMessage());
+        if (this.responseReceived(response)) {
+            deviceInfo = this.deserialize(response.getContentAsString(), HueSyncDetailedDeviceInfo.class);
         }
 
         return deviceInfo;
     }
 
-    public @Nullable HueSyncRegistration registerDevice(String id) {
+    public @Nullable HueSyncRegistration registerDevice(@Nullable String id) {
         HueSyncRegistration registration = null;
 
         try {
-            HueSyncRegistrationRequest dto = new HueSyncRegistrationRequest();
+            if (id != null) {
+                HueSyncRegistrationRequest dto = new HueSyncRegistrationRequest();
 
-            dto.appName = HueSyncConstants.APPLICATION_NAME;
-            dto.instanceName = id;
+                dto.appName = HueSyncConstants.APPLICATION_NAME;
+                dto.instanceName = id;
 
-            String json = ObjectMapper.writeValueAsString(dto);
+                String json = ObjectMapper.writeValueAsString(dto);
 
-            ContentResponse response = this.executeRequest(HttpMethod.POST, ENDPOINTS.REGISTRATIONS, json);
+                ContentResponse response = this.executeRequest(HttpMethod.POST, ENDPOINTS.REGISTRATIONS, json);
 
-            if (response.getStatus() == HttpStatus.OK_200) {
-                registration = this.deserialize(response.getContentAsString(), HueSyncRegistration.class);
+                if (this.responseReceived(response)) {
+                    registration = this.deserialize(response.getContentAsString(), HueSyncRegistration.class);
 
-                this.apiAccessToken = registration.accessToken;
-                this.registrationId = registration.registrationId;
+                    if (registration != null) {
+                        this.apiAccessToken = registration.accessToken;
+                        this.registrationId = registration.registrationId;
+                    }
+                }
             }
         } catch (InterruptedException | TimeoutException | ExecutionException | JsonProcessingException e) {
             this.logger.error("{}", e.getMessage());
@@ -182,15 +178,35 @@ public boolean isRegistered() {
 
     // #region - private
 
-    private <T> T deserialize(String json, Class<T> type) throws JsonMappingException, JsonProcessingException {
-        return ObjectMapper.readValue(json, type);
+    private boolean responseReceived(@Nullable ContentResponse response) {
+        if (response != null && response.getStatus() == HttpStatus.OK_200) {
+            return true;
+        } else {
+            // TODO: responseReceived - log error details ...
+            return false;
+        }
+    }
+
+    private @Nullable <T> T deserialize(String json, Class<T> type) {
+        try {
+            return ObjectMapper.readValue(json, type);
+        } catch (JsonProcessingException | NoClassDefFoundError e) {
+            this.logger.error("{}", e.getMessage());
+
+            return null;
+        }
     }
 
-    private ContentResponse executeGetRequest(String endpoint)
-            throws InterruptedException, ExecutionException, TimeoutException {
+    private @Nullable ContentResponse executeGetRequest(String endpoint) {
         String uri = String.format(REQUEST_FORMAT, this.host, this.port, API, endpoint);
 
-        return httpClient.GET(uri);
+        try {
+            return httpClient.GET(uri);
+        } catch (InterruptedException | ExecutionException | TimeoutException e) {
+            this.logger.error("Endpoint: {} - {}", endpoint, e.getMessage());
+
+            return null;
+        }
     }
 
     private ContentResponse executeRequest(HttpMethod method, String endpoint)

bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/exceptions/HueSyncApiException.java

@@ -12,12 +12,14 @@
  */
 package org.openhab.binding.huesync.internal.exceptions;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.slf4j.Logger;
 
 /**
  *
  * @author Patrik Gfeller - Initial contribution
  */
+@NonNullByDefault
 public class HueSyncApiException extends HueSyncException {
     public HueSyncApiException(String message, Logger logger) {
         super(message, logger);