[sonyprojector] Allow translation of exception messages that can be d… (

openhab#11392)

* [sonyprojector] Allow translation of exception messages that can be displayed in MainUI

Signed-off-by: Laurent Garnier <lg.hc@free.fr>

bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/SonyProjectorException.java

@@ -13,23 +13,22 @@
 package org.openhab.binding.sonyprojector.internal;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.eclipse.jdt.annotation.Nullable;
 
 /**
  * The {@link SonyProjectorException} class is used for any exception thrown by the binding
  *
  * @author Markus Wehrle - Initial contribution
  */
 @NonNullByDefault
-public class SonyProjectorException extends Exception {
+public class SonyProjectorException extends RuntimeException {
+
     private static final long serialVersionUID = 1L;
 
-    // Parameterless Constructor
-    public SonyProjectorException() {
+    public SonyProjectorException(String message) {
+        super(message);
     }
 
-    // Constructor that accepts a message
-    public SonyProjectorException(@Nullable String message) {
-        super(message);
+    public SonyProjectorException(String message, Throwable cause) {
+        super(message, cause);
     }
 }

bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/SonyProjectorHandlerFactory.java

@@ -22,6 +22,7 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.binding.sonyprojector.internal.handler.SonyProjectorHandler;
+import org.openhab.core.i18n.TranslationProvider;
 import org.openhab.core.io.transport.serial.SerialPortManager;
 import org.openhab.core.thing.Thing;
 import org.openhab.core.thing.ThingTypeUID;
@@ -49,12 +50,15 @@ public class SonyProjectorHandlerFactory extends BaseThingHandlerFactory {
     private final SerialPortManager serialPortManager;
 
     private final SonyProjectorStateDescriptionOptionProvider stateDescriptionProvider;
+    private final TranslationProvider i18nProvider;
 
     @Activate
     public SonyProjectorHandlerFactory(final @Reference SerialPortManager serialPortManager,
-            final @Reference SonyProjectorStateDescriptionOptionProvider stateDescriptionProvider) {
+            final @Reference SonyProjectorStateDescriptionOptionProvider stateDescriptionProvider,
+            final @Reference TranslationProvider i18nProvider) {
         this.serialPortManager = serialPortManager;
         this.stateDescriptionProvider = stateDescriptionProvider;
+        this.i18nProvider = i18nProvider;
     }
 
     @Override
@@ -67,7 +71,7 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
         ThingTypeUID thingTypeUID = thing.getThingTypeUID();
 
         if (SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID)) {
-            return new SonyProjectorHandler(thing, stateDescriptionProvider, serialPortManager);
+            return new SonyProjectorHandler(thing, stateDescriptionProvider, serialPortManager, i18nProvider);
         }
 
         return null;

bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/sdcp/SonyProjectorSdcpConnector.java

@@ -28,6 +28,8 @@
 import org.openhab.binding.sonyprojector.internal.SonyProjectorModel;
 import org.openhab.binding.sonyprojector.internal.communication.SonyProjectorConnector;
 import org.openhab.binding.sonyprojector.internal.communication.SonyProjectorItem;
+import org.openhab.core.i18n.CommunicationException;
+import org.openhab.core.i18n.ConnectionException;
 import org.openhab.core.util.HexUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -114,7 +116,7 @@ public String getCommunity() {
     }
 
     @Override
-    public synchronized void open() throws SonyProjectorException {
+    public synchronized void open() throws ConnectionException {
         if (!connected) {
             logger.debug("Opening SDCP connection IP {} port {}", this.address, this.port);
             try {
@@ -130,8 +132,7 @@ public synchronized void open() throws SonyProjectorException {
 
                 logger.debug("SDCP connection opened");
             } catch (IOException | SecurityException | IllegalArgumentException e) {
-                logger.debug("Opening SDCP connection failed: {}", e.getMessage());
-                throw new SonyProjectorException("Opening SDCP connection failed: " + e.getMessage());
+                throw new ConnectionException("@text/exception.opening-sdcp-connection-failed", e);
             }
         }
     }
@@ -181,28 +182,28 @@ protected byte[] buildMessage(SonyProjectorItem item, boolean getCommand, byte[]
      * @param dataBuffer the buffer into which the data is read.
      * @return the total number of bytes read into the buffer, or -1 if there is no more data because the end of the
      *         stream has been reached.
-     * @throws SonyProjectorException - If the input stream is null, if the first byte cannot be read for any reason
+     * @throws CommunicationException if the input stream is null, if the first byte cannot be read for any reason
      *             other than the end of the file, if the input stream has been closed, or if some other I/O error
      *             occurs.
      */
     @Override
-    protected int readInput(byte[] dataBuffer) throws SonyProjectorException {
+    protected int readInput(byte[] dataBuffer) throws CommunicationException {
         InputStream dataIn = this.dataIn;
         if (dataIn == null) {
-            throw new SonyProjectorException("readInput failed: input stream is null");
+            throw new CommunicationException("readInput failed: input stream is null");
         }
         try {
             return dataIn.read(dataBuffer);
         } catch (SocketTimeoutException e) {
             return 0;
         } catch (IOException e) {
             logger.debug("readInput failed: {}", e.getMessage());
-            throw new SonyProjectorException("readInput failed: " + e.getMessage());
+            throw new CommunicationException("readInput failed", e);
         }
     }
 
     @Override
-    protected synchronized byte[] readResponse() throws SonyProjectorException {
+    protected synchronized byte[] readResponse() throws CommunicationException {
         logger.debug("readResponse (timeout = {} ms)...", READ_TIMEOUT_MS);
         byte[] message = new byte[MSG_MAX_SIZE];
         boolean timeout = false;
@@ -222,53 +223,53 @@ protected synchronized byte[] readResponse() throws SonyProjectorException {
         }
         if ((count < MSG_MIN_SIZE) && timeout) {
             logger.debug("readResponse timeout: only {} bytes read after {} ms", count, READ_TIMEOUT_MS);
-            throw new SonyProjectorException("readResponse failed: timeout");
+            throw new CommunicationException("readResponse failed: timeout");
         }
         logger.debug("readResponse: {}", HexUtils.bytesToHex(message));
         if (count < MSG_MIN_SIZE) {
             logger.debug("readResponse: unexpected response data length: {}", count);
-            throw new SonyProjectorException("Unexpected response data length");
+            throw new CommunicationException("Unexpected response data length");
         }
         return message;
     }
 
     @Override
-    protected void validateResponse(byte[] responseMessage, SonyProjectorItem item) throws SonyProjectorException {
+    protected void validateResponse(byte[] responseMessage, SonyProjectorItem item) throws CommunicationException {
         // Check response size
         if (responseMessage.length < MSG_MIN_SIZE) {
             logger.debug("Unexpected response data length: {}", responseMessage.length);
-            throw new SonyProjectorException("Unexpected response data length");
+            throw new CommunicationException("Unexpected response data length");
         }
 
         // Header should be a sony projector header
         byte[] headerMsg = Arrays.copyOf(responseMessage, HEADER.length);
         if (!Arrays.equals(headerMsg, HEADER)) {
             logger.debug("Unexpected HEADER in response: {} rather than {}", HexUtils.bytesToHex(headerMsg),
                     HexUtils.bytesToHex(HEADER));
-            throw new SonyProjectorException("Unexpected HEADER in response");
+            throw new CommunicationException("Unexpected HEADER in response");
         }
 
         // Community should be the same as used for sending
         byte[] communityResponseMsg = Arrays.copyOfRange(responseMessage, 2, 6);
         if (!Arrays.equals(communityResponseMsg, community.getBytes())) {
             logger.debug("Unexpected community in response: {} rather than {}",
                     HexUtils.bytesToHex(communityResponseMsg), HexUtils.bytesToHex(community.getBytes()));
-            throw new SonyProjectorException("Unexpected community in response");
+            throw new CommunicationException("Unexpected community in response");
         }
 
         // Item number should be the same as used for sending
         byte[] itemResponseMsg = Arrays.copyOfRange(responseMessage, 7, 9);
         if (!Arrays.equals(itemResponseMsg, item.getCode())) {
             logger.debug("Unexpected item number in response: {} rather than {}", HexUtils.bytesToHex(itemResponseMsg),
                     HexUtils.bytesToHex(item.getCode()));
-            throw new SonyProjectorException("Unexpected item number in response");
+            throw new CommunicationException("Unexpected item number in response");
         }
 
         // Check response size
         int dataLength = responseMessage[9] & 0x000000FF;
         if (responseMessage.length < (10 + dataLength)) {
             logger.debug("Unexpected response data length: {}", dataLength);
-            throw new SonyProjectorException("Unexpected response data length");
+            throw new CommunicationException("Unexpected response data length");
         }
 
         // byte 7 is expected to be 1, which indicates that the request was successful
@@ -279,11 +280,11 @@ protected void validateResponse(byte[] responseMessage, SonyProjectorItem item)
                 try {
                     SonyProjectorSdcpError error = SonyProjectorSdcpError.getFromDataCode(errorCode);
                     msg = error.getMessage();
-                } catch (SonyProjectorException e) {
+                } catch (CommunicationException e) {
                 }
             }
             logger.debug("{} received in response", msg);
-            throw new SonyProjectorException(msg + " received in response");
+            throw new CommunicationException(msg + " received in response");
         }
     }
 
@@ -303,7 +304,7 @@ protected byte[] getResponseData(byte[] responseMessage) {
      *
      * @return the model name
      *
-     * @throws SonyProjectorException - In case of any problem
+     * @throws SonyProjectorException in case of any problem
      */
     public String getModelName() throws SonyProjectorException {
         return new String(getSetting(SonyProjectorItem.MODEL_NAME), StandardCharsets.UTF_8);

bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/sdcp/SonyProjectorSdcpError.java

@@ -15,7 +15,7 @@
 import java.util.Arrays;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.openhab.binding.sonyprojector.internal.SonyProjectorException;
+import org.openhab.core.i18n.CommunicationException;
 import org.openhab.core.util.HexUtils;
 
 /**
@@ -89,14 +89,14 @@ public byte[] getDataCode() {
      *
      * @return the error associated to the data code
      *
-     * @throws SonyProjectorException - If no error is associated to the data code
+     * @throws CommunicationException if no error is associated to the data code
      */
-    public static SonyProjectorSdcpError getFromDataCode(byte[] dataCode) throws SonyProjectorException {
+    public static SonyProjectorSdcpError getFromDataCode(byte[] dataCode) throws CommunicationException {
         for (SonyProjectorSdcpError value : SonyProjectorSdcpError.values()) {
             if (Arrays.equals(dataCode, value.getDataCode())) {
                 return value;
             }
         }
-        throw new SonyProjectorException("Unknwon error code: " + HexUtils.bytesToHex(dataCode));
+        throw new CommunicationException("Unknwon error code: " + HexUtils.bytesToHex(dataCode));
     }
 }

bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/sdcp/SonyProjectorSdcpSimuConnector.java

@@ -13,9 +13,10 @@
 package org.openhab.binding.sonyprojector.internal.communication.sdcp;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.openhab.binding.sonyprojector.internal.SonyProjectorException;
 import org.openhab.binding.sonyprojector.internal.SonyProjectorModel;
 import org.openhab.binding.sonyprojector.internal.communication.SonyProjectorItem;
+import org.openhab.core.i18n.CommunicationException;
+import org.openhab.core.i18n.ConnectionException;
 import org.openhab.core.util.HexUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -44,7 +45,7 @@ public SonyProjectorSdcpSimuConnector(SonyProjectorModel model) {
     }
 
     @Override
-    public synchronized void open() throws SonyProjectorException {
+    public synchronized void open() throws ConnectionException {
         if (!connected) {
             connected = true;
             logger.debug("Simulated SDCP connection opened");
@@ -66,7 +67,7 @@ protected byte[] buildMessage(SonyProjectorItem item, boolean getCommand, byte[]
     }
 
     @Override
-    protected synchronized byte[] readResponse() throws SonyProjectorException {
+    protected synchronized byte[] readResponse() throws CommunicationException {
         byte[] message = new byte[34];
         byte[] communityData = getCommunity().getBytes();
         message[0] = HEADER[0];