[modbus] Export thing handler interface for upcoming bundles (openhab…

…#4077) * [modbus] Export thing handler interface for upcoming bundles Exporting the thing handler interface and the required other interfaces makes it possible to textend this binding by other bundles. Such an use case is when custom handlers are written to specific devices. * [modbus] Renamed internal constants class to ModbusBindingConstantsInternal Signed-off-by: Nagy Attila Gabor <mrbig@sneaker.hu> Signed-off-by: Pascal Larin <plarin@gmail.com>
chaton78 · Jan 1, 2019 · 829193a · 829193a
1 parent 485a57d
commit 829193a
Show file tree

Hide file tree

Showing 12 changed files with 147 additions and 102 deletions.
diff --git a/....modbus.test/src/test/java/org/openhab/binding/modbus/internal/ModbusDataHandlerTest.java b/....modbus.test/src/test/java/org/openhab/binding/modbus/internal/ModbusDataHandlerTest.java
diff --git a/....test/src/test/java/org/openhab/binding/modbus/internal/ModbusPollerThingHandlerTest.java b/....test/src/test/java/org/openhab/binding/modbus/internal/ModbusPollerThingHandlerTest.java
@@ -45,7 +45,7 @@
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.junit.MockitoJUnitRunner;
-import org.openhab.binding.modbus.internal.ModbusBindingConstants;
+import org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal;
 import org.openhab.binding.modbus.internal.handler.ModbusDataThingHandler;
 import org.openhab.binding.modbus.internal.handler.ModbusPollerThingHandler;
 import org.openhab.binding.modbus.internal.handler.ModbusPollerThingHandlerImpl;
@@ -77,13 +77,13 @@ public class ModbusPollerThingHandlerTest {
     private ThingHandlerCallback thingCallback;
 
     public static BridgeBuilder createTcpThingBuilder(String id) {
-        return BridgeBuilder.create(ModbusBindingConstants.THING_TYPE_MODBUS_TCP,
-                new ThingUID(ModbusBindingConstants.THING_TYPE_MODBUS_TCP, id)).withLabel("label for " + id);
+        return BridgeBuilder.create(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_TCP,
+                new ThingUID(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_TCP, id)).withLabel("label for " + id);
     }
 
     public static BridgeBuilder createPollerThingBuilder(String id) {
-        return BridgeBuilder.create(ModbusBindingConstants.THING_TYPE_MODBUS_POLLER,
-                new ThingUID(ModbusBindingConstants.THING_TYPE_MODBUS_POLLER, id)).withLabel("label for " + id);
+        return BridgeBuilder.create(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_POLLER,
+                new ThingUID(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_POLLER, id)).withLabel("label for " + id);
     }
 
     private void registerThingToMockRegistry(Thing thing) {
@@ -168,7 +168,7 @@ public void testInitializeNonPolling()
         pollerConfig.put("refresh", 0L); // 0 -> non polling
         pollerConfig.put("start", 5);
         pollerConfig.put("length", 9);
-        pollerConfig.put("type", ModbusBindingConstants.READ_TYPE_HOLDING_REGISTER);
+        pollerConfig.put("type", ModbusBindingConstantsInternal.READ_TYPE_HOLDING_REGISTER);
         poller = createPollerThingBuilder("poller").withConfiguration(pollerConfig).withBridge(endpoint.getUID())
                 .build();
         registerThingToMockRegistry(poller);

diff --git a/...bus.test/src/test/java/org/openhab/binding/modbus/internal/ModbusTcpThingHandlerTest.java b/...bus.test/src/test/java/org/openhab/binding/modbus/internal/ModbusTcpThingHandlerTest.java
@@ -28,7 +28,7 @@
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.junit.MockitoJUnitRunner;
-import org.openhab.binding.modbus.internal.ModbusBindingConstants;
+import org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal;
 import org.openhab.binding.modbus.internal.handler.ModbusTcpThingHandler;
 import org.openhab.io.transport.modbus.ModbusManager;
 import org.openhab.io.transport.modbus.endpoint.EndpointPoolConfiguration;
@@ -42,8 +42,8 @@ public class ModbusTcpThingHandlerTest {
     private ModbusManager modbusManager;
 
     private static BridgeBuilder createTcpThingBuilder(String id) {
-        return BridgeBuilder.create(ModbusBindingConstants.THING_TYPE_MODBUS_TCP,
-                new ThingUID(ModbusBindingConstants.THING_TYPE_MODBUS_TCP, id));
+        return BridgeBuilder.create(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_TCP,
+                new ThingUID(ModbusBindingConstantsInternal.THING_TYPE_MODBUS_TCP, id));
     }
 
     @SuppressWarnings("null")

diff --git a/addons/binding/org.openhab.binding.modbus/META-INF/MANIFEST.MF b/addons/binding/org.openhab.binding.modbus/META-INF/MANIFEST.MF
@@ -23,4 +23,6 @@ Import-Package: org.apache.commons.lang,
  org.osgi.framework,
  org.slf4j
 Service-Component: OSGI-INF/*.xml
+Export-Package: org.openhab.binding.modbus,
+ org.openhab.binding.modbus.handler
 Bundle-ActivationPolicy: lazy
diff --git a/...enhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java b/...enhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java
@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2010-2018 by the respective copyright holders.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.openhab.binding.modbus;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * The {@link ModbusBinding} class defines some constants
+ * public that might be used from other bundles as well.
+ *
+ * @author Sami Salonen - Initial contribution
+ * @author Nagy Attila Gabor - Split the original ModbusBindingConstants in two
+ */
+@NonNullByDefault
+public class ModbusBindingConstants {
+
+    public static final String BINDING_ID = "modbus";
+
+}
diff --git a/...dler/EndpointNotInitializedException.java → ...dler/EndpointNotInitializedException.java b/...dler/EndpointNotInitializedException.java → ...dler/EndpointNotInitializedException.java
@@ -6,7 +6,7 @@
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  */
-package org.openhab.binding.modbus.internal.handler;
+package org.openhab.binding.modbus.handler;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
 

diff --git a/...l/handler/ModbusEndpointThingHandler.java → ...s/handler/ModbusEndpointThingHandler.java b/...l/handler/ModbusEndpointThingHandler.java → ...s/handler/ModbusEndpointThingHandler.java
@@ -6,7 +6,7 @@
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  */
-package org.openhab.binding.modbus.internal.handler;
+package org.openhab.binding.modbus.handler;
 
 import java.util.function.Supplier;
 

diff --git a/...dbus/internal/ModbusBindingConstants.java → ...ernal/ModbusBindingConstantsInternal.java b/...dbus/internal/ModbusBindingConstants.java → ...ernal/ModbusBindingConstantsInternal.java
@@ -8,6 +8,8 @@
  */
 package org.openhab.binding.modbus.internal;
 
+import static org.openhab.binding.modbus.ModbusBindingConstants.BINDING_ID;
+
 import java.util.HashMap;
 import java.util.Map;
 
@@ -22,9 +24,7 @@
  * @author Sami Salonen - Initial contribution
  */
 @NonNullByDefault
-public class ModbusBindingConstants {
-
-    public static final String BINDING_ID = "modbus";
+public class ModbusBindingConstantsInternal {
 
     // List of all Thing Type UIDs
     public static final ThingTypeUID THING_TYPE_MODBUS_TCP = new ThingTypeUID(BINDING_ID, "tcp");

diff --git a/...inding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusHandlerFactory.java b/...inding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusHandlerFactory.java
@@ -8,7 +8,7 @@
  */
 package org.openhab.binding.modbus.internal;
 
-import static org.openhab.binding.modbus.internal.ModbusBindingConstants.*;
+import static org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal.*;
 
 import java.util.HashSet;
 import java.util.Set;

diff --git a/.../java/org/openhab/binding/modbus/internal/handler/AbstractModbusEndpointThingHandler.java b/.../java/org/openhab/binding/modbus/internal/handler/AbstractModbusEndpointThingHandler.java
@@ -18,6 +18,7 @@
 import org.eclipse.smarthome.core.thing.ThingStatusDetail;
 import org.eclipse.smarthome.core.thing.binding.BaseBridgeHandler;
 import org.eclipse.smarthome.core.types.Command;
+import org.openhab.binding.modbus.handler.ModbusEndpointThingHandler;
 import org.openhab.binding.modbus.internal.ModbusConfigurationException;
 import org.openhab.io.transport.modbus.ModbusManager;
 import org.openhab.io.transport.modbus.ModbusManagerListener;

diff --git a/...bus/src/main/java/org/openhab/binding/modbus/internal/handler/ModbusDataThingHandler.java b/...bus/src/main/java/org/openhab/binding/modbus/internal/handler/ModbusDataThingHandler.java
@@ -8,7 +8,7 @@
  */
 package org.openhab.binding.modbus.internal.handler;
 
-import static org.openhab.binding.modbus.internal.ModbusBindingConstants.*;
+import static org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal.*;
 
 import java.math.BigDecimal;
 import java.util.Collection;
@@ -46,7 +46,9 @@
 import org.eclipse.smarthome.core.types.Command;
 import org.eclipse.smarthome.core.types.RefreshType;
 import org.eclipse.smarthome.core.types.State;
-import org.openhab.binding.modbus.internal.ModbusBindingConstants;
+import org.openhab.binding.modbus.handler.EndpointNotInitializedException;
+import org.openhab.binding.modbus.handler.ModbusEndpointThingHandler;
+import org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal;
 import org.openhab.binding.modbus.internal.ModbusConfigurationException;
 import org.openhab.binding.modbus.internal.Transformation;
 import org.openhab.binding.modbus.internal.config.ModbusDataConfiguration;
@@ -92,19 +94,19 @@ public class ModbusDataThingHandler extends BaseThingHandler implements ModbusRe
     private static final Map<String, List<Class<? extends State>>> CHANNEL_ID_TO_ACCEPTED_TYPES = new HashMap<>();
 
     static {
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_SWITCH,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_SWITCH,
                 new SwitchItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_CONTACT,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_CONTACT,
                 new ContactItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_DATETIME,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_DATETIME,
                 new DateTimeItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_DIMMER,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_DIMMER,
                 new DimmerItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_NUMBER,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_NUMBER,
                 new NumberItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_STRING,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_STRING,
                 new StringItem("").getAcceptedDataTypes());
-        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstants.CHANNEL_ROLLERSHUTTER,
+        CHANNEL_ID_TO_ACCEPTED_TYPES.put(ModbusBindingConstantsInternal.CHANNEL_ROLLERSHUTTER,
                 new RollershutterItem("").getAcceptedDataTypes());
     }
 
@@ -692,7 +694,7 @@ public synchronized void onError(ModbusReadRequestBlueprint request, Exception e
                     error.getMessage(), error);
         }
         Map<@NonNull ChannelUID, @NonNull State> states = new HashMap<>();
-        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstants.CHANNEL_LAST_READ_ERROR),
+        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstantsInternal.CHANNEL_LAST_READ_ERROR),
                 new DateTimeType());
 
         synchronized (this) {
@@ -727,7 +729,7 @@ public synchronized void onError(ModbusWriteRequestBlueprint request, Exception
                     error.getMessage(), error);
         }
         Map<@NonNull ChannelUID, @NonNull State> states = new HashMap<>();
-        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstants.CHANNEL_LAST_WRITE_ERROR),
+        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstantsInternal.CHANNEL_LAST_WRITE_ERROR),
                 new DateTimeType());
 
         synchronized (this) {
@@ -752,7 +754,7 @@ public synchronized void onWriteResponse(ModbusWriteRequestBlueprint request, Mo
         logger.debug("Successful write, matching request {}", request);
         DateTimeType now = new DateTimeType();
         updateStatus(ThingStatus.ONLINE);
-        updateState(ModbusBindingConstants.CHANNEL_LAST_WRITE_SUCCESS, now);
+        updateState(ModbusBindingConstantsInternal.CHANNEL_LAST_WRITE_SUCCESS, now);
     }
 
     /**
@@ -813,7 +815,7 @@ private Map<ChannelUID, State> processUpdatedValue(DecimalType numericState, boo
             }
         });
 
-        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstants.CHANNEL_LAST_READ_SUCCESS),
+        states.put(new ChannelUID(getThing().getUID(), ModbusBindingConstantsInternal.CHANNEL_LAST_READ_SUCCESS),
                 new DateTimeType());
 
         synchronized (this) {

diff --git a/...c/main/java/org/openhab/binding/modbus/internal/handler/ModbusPollerThingHandlerImpl.java b/...c/main/java/org/openhab/binding/modbus/internal/handler/ModbusPollerThingHandlerImpl.java
@@ -29,8 +29,10 @@
 import org.eclipse.smarthome.core.thing.binding.BaseBridgeHandler;
 import org.eclipse.smarthome.core.thing.binding.ThingHandler;
 import org.eclipse.smarthome.core.types.Command;
+import org.openhab.binding.modbus.handler.EndpointNotInitializedException;
+import org.openhab.binding.modbus.handler.ModbusEndpointThingHandler;
 import org.openhab.binding.modbus.internal.AtomicStampedKeyValue;
-import org.openhab.binding.modbus.internal.ModbusBindingConstants;
+import org.openhab.binding.modbus.internal.ModbusBindingConstantsInternal;
 import org.openhab.binding.modbus.internal.config.ModbusPollerConfiguration;
 import org.openhab.io.transport.modbus.BitArray;
 import org.openhab.io.transport.modbus.ModbusManager;
@@ -222,14 +224,14 @@ public void resetCache() {
     private static class ModbusPollerReadRequest extends BasicModbusReadRequestBlueprint {
 
         private static ModbusReadFunctionCode getFunctionCode(@Nullable String type) {
-            if (!ModbusBindingConstants.READ_FUNCTION_CODES.containsKey(type)) {
-                Object[] acceptedTypes = ModbusBindingConstants.READ_FUNCTION_CODES.keySet().toArray();
+            if (!ModbusBindingConstantsInternal.READ_FUNCTION_CODES.containsKey(type)) {
+                Object[] acceptedTypes = ModbusBindingConstantsInternal.READ_FUNCTION_CODES.keySet().toArray();
                 Arrays.sort(acceptedTypes);
                 throw new IllegalArgumentException(
                         String.format("No function code found for type='%s'. Was expecting one of: %s", type,
                                 StringUtils.join(acceptedTypes, ", ")));
             }
-            ModbusReadFunctionCode functionCode = ModbusBindingConstants.READ_FUNCTION_CODES.get(type);
+            ModbusReadFunctionCode functionCode = ModbusBindingConstantsInternal.READ_FUNCTION_CODES.get(type);
             return functionCode;
         }