Add MSP configuration parser for Hayward OmniLogic local binding

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/BackyardConfig.java

@@ -0,0 +1,83 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+
+/**
+ * Representation of the Backyard element within the MSP configuration.
+ */
+@NonNullByDefault
+@XStreamAlias("Backyard")
+public class BackyardConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamImplicit(itemFieldName = "BodyOfWater")
+    private final List<BodyOfWaterConfig> bodiesOfWater = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "Pump")
+    private final List<PumpConfig> pumps = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "Filter")
+    private final List<FilterConfig> filters = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "Heater")
+    private final List<HeaterConfig> heaters = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "VirtualHeater")
+    private final List<VirtualHeaterConfig> virtualHeaters = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "Chlorinator")
+    private final List<ChlorinatorConfig> chlorinators = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "ColorLogic-Light")
+    private final List<ColorLogicLightConfig> colorLogicLights = new ArrayList<>();
+
+    @XStreamImplicit(itemFieldName = "Relay")
+    private final List<RelayConfig> relays = new ArrayList<>();
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public List<BodyOfWaterConfig> getBodiesOfWater() {
+        return bodiesOfWater;
+    }
+
+    public List<PumpConfig> getPumps() {
+        return pumps;
+    }
+
+    public List<FilterConfig> getFilters() {
+        return filters;
+    }
+
+    public List<HeaterConfig> getHeaters() {
+        return heaters;
+    }
+
+    public List<VirtualHeaterConfig> getVirtualHeaters() {
+        return virtualHeaters;
+    }
+
+    public List<ChlorinatorConfig> getChlorinators() {
+        return chlorinators;
+    }
+
+    public List<ColorLogicLightConfig> getColorLogicLights() {
+        return colorLogicLights;
+    }
+
+    public List<RelayConfig> getRelays() {
+        return relays;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/BodyOfWaterConfig.java

@@ -0,0 +1,23 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a BodyOfWater element.
+ */
+@NonNullByDefault
+@XStreamAlias("BodyOfWater")
+public class BodyOfWaterConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/ChlorinatorConfig.java

@@ -0,0 +1,23 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a Chlorinator element.
+ */
+@NonNullByDefault
+@XStreamAlias("Chlorinator")
+public class ChlorinatorConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/ColorLogicLightConfig.java

@@ -0,0 +1,23 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a ColorLogic light element.
+ */
+@NonNullByDefault
+@XStreamAlias("ColorLogic-Light")
+public class ColorLogicLightConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/ConfigParser.java

@@ -0,0 +1,29 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+import com.thoughtworks.xstream.XStream;
+import com.thoughtworks.xstream.io.xml.StaxDriver;
+import com.thoughtworks.xstream.security.AnyTypePermission;
+
+/**
+ * Utility for parsing MSP configuration XML using XStream.
+ */
+@NonNullByDefault
+public final class ConfigParser {
+    private static final XStream XSTREAM = new XStream(new StaxDriver());
+
+    static {
+        XSTREAM.ignoreUnknownElements();
+        XSTREAM.addPermission(AnyTypePermission.ANY);
+        XSTREAM.processAnnotations(MspConfig.class);
+    }
+
+    private ConfigParser() {
+    }
+
+    public static MspConfig parse(String xml) {
+        return (MspConfig) XSTREAM.fromXML(xml);
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/FilterConfig.java

@@ -0,0 +1,31 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a Filter element.
+ */
+@NonNullByDefault
+@XStreamAlias("Filter")
+public class FilterConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamAsAttribute
+    @XStreamAlias("pumpId")
+    private @Nullable String pumpId;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public @Nullable String getPumpId() {
+        return pumpId;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/HeaterConfig.java

@@ -0,0 +1,30 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a Heater element.
+ */
+@NonNullByDefault
+@XStreamAlias("Heater")
+public class HeaterConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamAsAttribute
+    private @Nullable String type;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public @Nullable String getType() {
+        return type;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/MspConfig.java

@@ -0,0 +1,24 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+
+/**
+ * Representation of the MSP configuration root element.
+ */
+@NonNullByDefault
+@XStreamAlias("MspConfig")
+public class MspConfig {
+    @XStreamImplicit(itemFieldName = "System")
+    private final List<SystemConfig> systems = new ArrayList<>();
+
+    public List<SystemConfig> getSystems() {
+        return systems;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/PumpConfig.java

@@ -0,0 +1,30 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a Pump element.
+ */
+@NonNullByDefault
+@XStreamAlias("Pump")
+public class PumpConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamAsAttribute
+    private @Nullable String name;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public @Nullable String getName() {
+        return name;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/RelayConfig.java

@@ -0,0 +1,30 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a Relay element.
+ */
+@NonNullByDefault
+@XStreamAlias("Relay")
+public class RelayConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamAsAttribute
+    private @Nullable String name;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public @Nullable String getName() {
+        return name;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/SystemConfig.java

@@ -0,0 +1,34 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+
+/**
+ * Representation of the System element within the MSP configuration.
+ */
+@NonNullByDefault
+@XStreamAlias("System")
+public class SystemConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    @XStreamImplicit(itemFieldName = "Backyard")
+    private final List<BackyardConfig> backyards = new ArrayList<>();
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+
+    public List<BackyardConfig> getBackyards() {
+        return backyards;
+    }
+}
+

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/config/VirtualHeaterConfig.java

@@ -0,0 +1,23 @@
+package org.openhab.binding.haywardomnilogiclocal.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
+
+/**
+ * Representation of a VirtualHeater element.
+ */
+@NonNullByDefault
+@XStreamAlias("VirtualHeater")
+public class VirtualHeaterConfig {
+    @XStreamAsAttribute
+    @XStreamAlias("systemId")
+    private @Nullable String systemId;
+
+    public @Nullable String getSystemId() {
+        return systemId;
+    }
+}
+