SNMP driver implementation in progress

Author: dariol83

eu.dariolucia.reatmetric.driver.snmp.util/Documentation.adoc

@@ -16,8 +16,8 @@ snmp module registration for each endpoint that requires such driver.
     <name>Test System</name>
     <log-property-file>$HOME\Reatmetric\reatmetric_test\log.properties</log-property-file>
     <definitions-location>$HOME\Reatmetric\reatmetric_test\processing</definitions-location>
-    <driver name="Equipment 1 SNMP Driver" type="eu.dariolucia.reatmetric.driver.snmp.SnmpDriver"
-    configuration="$HOME\Reatmetric\reatmetric_test\snmp1"/>
+    <driver name="SNMP Driver" type="eu.dariolucia.reatmetric.driver.snmp.SnmpDriver"
+    configuration="$HOME\Reatmetric\reatmetric_test\snmp"/>
 </ns1:core>
 ----
 
@@ -30,3 +30,5 @@ eu.dariolucia.reatmetric.driver.snmp.configuration. It is an XML file named _con
 namespace definition _http://dariolucia.eu/reatmetric/driver/snmp_.
 
 To be written
+
+===== Device Configuration File

eu.dariolucia.reatmetric.driver.snmp.util/src/main/java/eu/dariolucia/reatmetric/driver/snmp/util/BasicComputerDriverGenerator.java

@@ -72,6 +72,8 @@ protected SnmpTransportConnector(String driverName, SnmpDevice device, IRawDataB
         this.rawDataBroker = rawDataBroker;
         this.processingModel = processingModel;
         this.deviceTimer = new Timer("SNMP Device " + getName() + " Timer Service", true);
+        // Initialise
+        this.device.getDeviceConfiguration().initialise(device.getPath(), this.processingModel);
         // Build the target
         this.target = new CommunityTarget<>();
         Address targetAddress = GenericAddress.parse(device.getConnectionString());

eu.dariolucia.reatmetric.driver.snmp/Documentation.adoc

@@ -38,13 +38,13 @@ public class OidEntry {
     private String path;
 
     @XmlAttribute(name = "type", required = true)
-    private ValueTypeEnum type;
+    private OidEntryType type;
 
     public OidEntry() {
         // Nothing
     }
 
-    public OidEntry(String oid, String path, ValueTypeEnum type) {
+    public OidEntry(String oid, String path, OidEntryType type) {
         this.oid = oid;
         this.path = path;
         this.type = type;
@@ -70,11 +70,11 @@ public void setPath(String path) {
         this.path = path;
     }
 
-    public ValueTypeEnum getType() {
+    public OidEntryType getType() {
         return type;
     }
 
-    public void setType(ValueTypeEnum type) {
+    public void setType(OidEntryType type) {
         this.type = type;
     }
 
@@ -96,16 +96,21 @@ public int getExternalId() {
 
     public Object extractValue(Variable variable) {
         switch (type) {
-            case ENUMERATED: return extractInt(variable);
-            case SIGNED_INTEGER:
-            case UNSIGNED_INTEGER: return extractLong(variable);
-            case OCTET_STRING: return extractByteArray(variable);
-            case CHARACTER_STRING: return extractString(variable);
-            case REAL: return extractReal(variable);
+            case INTEGER: return extractInt(variable);
+            case LONG: return extractLong(variable);
+            case BYTE_ARRAY: return extractByteArray(variable);
+            case STRING: return extractString(variable);
+            case DOUBLE: return extractReal(variable);
+            case OID: return extractOidLastValue(variable);
             default: return null;
         }
     }
 
+    private Object extractOidLastValue(Variable variable) {
+        String typeString = variable.toString();
+        return Integer.parseInt(typeString.substring(typeString.lastIndexOf('.') + 1));
+    }
+
     private Object extractReal(Variable variable) {
         if (variable instanceof OctetString) {
             String itemValue = variable.toString();

eu.dariolucia.reatmetric.driver.snmp/src/main/java/eu/dariolucia/reatmetric/driver/snmp/SnmpTransportConnector.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c)  2024 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * 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
+ *
+ *           http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 eu.dariolucia.reatmetric.driver.snmp.configuration;
+
+import eu.dariolucia.reatmetric.api.value.ValueTypeEnum;
+
+public enum OidEntryType {
+    STRING,
+    INTEGER,
+    OID,
+    LONG,
+    DOUBLE,
+    BYTE_ARRAY;
+
+    public ValueTypeEnum toValueTypeEnum() {
+        switch (this) {
+            case OID: return ValueTypeEnum.ENUMERATED;
+            case STRING: return ValueTypeEnum.CHARACTER_STRING;
+            case BYTE_ARRAY: return ValueTypeEnum.OCTET_STRING;
+            case INTEGER: return ValueTypeEnum.ENUMERATED;
+            case LONG: return ValueTypeEnum.SIGNED_INTEGER;
+            case DOUBLE: return ValueTypeEnum.REAL;
+            default: throw new IllegalStateException("Type " + this + " cannot be mapped to ValueTypeEnum");
+        }
+    }
+}

eu.dariolucia.reatmetric.driver.snmp/src/main/java/eu/dariolucia/reatmetric/driver/snmp/configuration/OidEntry.java

@@ -21,16 +21,14 @@
 import jakarta.xml.bind.JAXBContext;
 import jakarta.xml.bind.JAXBException;
 import jakarta.xml.bind.Unmarshaller;
-import jakarta.xml.bind.annotation.XmlAccessType;
-import jakarta.xml.bind.annotation.XmlAccessorType;
-import jakarta.xml.bind.annotation.XmlAttribute;
-import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.*;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.LinkedList;
 import java.util.List;
 
+@XmlRootElement(name = "snmp-configuration", namespace = "http://dariolucia.eu/reatmetric/driver/snmp")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class SnmpConfiguration {
 

eu.dariolucia.reatmetric.driver.snmp/src/main/java/eu/dariolucia/reatmetric/driver/snmp/configuration/OidEntryType.java

@@ -16,14 +16,19 @@
 
 package eu.dariolucia.reatmetric.driver.snmp.configuration;
 
-import eu.dariolucia.reatmetric.api.common.exceptions.ReatmetricException;
+import eu.dariolucia.reatmetric.api.processing.IProcessingModel;
 import jakarta.xml.bind.JAXBContext;
 import jakarta.xml.bind.JAXBException;
+import jakarta.xml.bind.Marshaller;
 import jakarta.xml.bind.Unmarshaller;
-import jakarta.xml.bind.annotation.*;
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlRootElement;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -35,10 +40,19 @@ public static SnmpDeviceConfiguration load(InputStream is) throws IOException {
         try {
             JAXBContext jc = JAXBContext.newInstance(SnmpDeviceConfiguration.class);
             Unmarshaller u = jc.createUnmarshaller();
-            SnmpDeviceConfiguration sc = (SnmpDeviceConfiguration) u.unmarshal(is);
-            sc.initialise();
-            return sc;
-        } catch (JAXBException | ReatmetricException e) {
+            return (SnmpDeviceConfiguration) u.unmarshal(is);
+        } catch (JAXBException e) {
+            throw new IOException(e);
+        }
+    }
+
+    public static void save(SnmpDeviceConfiguration d, OutputStream out) throws IOException {
+        try {
+            JAXBContext context = JAXBContext.newInstance(SnmpDeviceConfiguration.class);
+            Marshaller marshaller = context.createMarshaller();
+            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
+            marshaller.marshal(d, out);
+        } catch (JAXBException e) {
             throw new IOException(e);
         }
     }
@@ -54,7 +68,7 @@ public void setGroupConfigurationList(List<GroupConfiguration> groupConfiguratio
         this.groupConfigurationList = groupConfigurationList;
     }
 
-    private void initialise() throws ReatmetricException {
-        //
+    public void initialise(String prefix, IProcessingModel theModel) {
+        this.groupConfigurationList.forEach(gc -> gc.initialise(prefix, theModel));
     }
 }