HZN-1009: Add support for the WmiCollector on Minion.

Author: Jesse White

container/features/src/main/resources/features-minion.xml

@@ -110,6 +110,7 @@
       <bundle>mvn:org.opennms.features/org.opennms.features.jdbc-collector/${project.version}</bundle>
       <bundle>mvn:org.opennms.protocols/org.opennms.protocols.nsclient/${project.version}</bundle>
       <feature>opennms-vmware</feature>
+      <feature>wmi-integration</feature>
     </feature>
 
     <feature name="minion-shell-collection" description="Minion :: Shell :: Collection" version="${project.version}">

opennms-config-model/src/main/java/org/opennms/netmgt/config/wmi/WmiAgentConfig.java

@@ -33,6 +33,13 @@
 import java.util.Map;
 import java.util.Objects;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
+
+import org.opennms.core.network.InetAddressXmlAdapter;
 import org.opennms.netmgt.snmp.InetAddrUtils;
 
 /**
@@ -41,6 +48,8 @@
  * @author ranger
  * @version $Id: $
  */
+@XmlRootElement(name = "wmi-agent-config")
+@XmlAccessorType(XmlAccessType.NONE)
 public class WmiAgentConfig {
 
     /** Constant <code>DEFAULT_TIMEOUT=3000</code> */
@@ -53,23 +62,26 @@ public class WmiAgentConfig {
     public static final String DEFAULT_USERNAME="Administrator";
     /** Constant <code>DEFAULT_DOMAIN="WORKGROUP"</code> */
     public static final String DEFAULT_DOMAIN="WORKGROUP";
-    
+
+    @XmlAttribute(name = "address")
+    @XmlJavaTypeAdapter(InetAddressXmlAdapter.class)
     private InetAddress m_Address;
+
+    @XmlAttribute(name = "timeout")
     private int m_Timeout;
+
+    @XmlAttribute(name = "retries")
     private int m_Retries;
+
+    @XmlAttribute(name = "username")
     private String m_Username;
+
+    @XmlAttribute(name = "domain")
     private String m_Domain;
+
+    @XmlAttribute(name = "password")
     private String m_Password;
-    
-    
-	String user = "";
-	String pass = "";
-	String domain = "";
-	String matchType = "all";
-	String compVal = "";
-	String compOp = "NOOP";
-	String wmiClass = "";
-	String wmiObject = "";
+
     /**
      * <p>Constructor for WmiAgentConfig.</p>
      */

opennms-config-model/src/test/java/org/opennms/netmgt/config/wmi/WmiAgentConfigTest.java

@@ -30,10 +30,33 @@
 
 import static org.junit.Assert.assertEquals;
 
+import java.util.Arrays;
+import java.util.Collection;
+
 import org.junit.Test;
+import org.junit.runners.Parameterized.Parameters;
+import org.opennms.core.test.xml.XmlTestNoCastor;
 import org.opennms.core.utils.InetAddressUtils;
+import org.opennms.netmgt.snmp.InetAddrUtils;
+
+public class WmiAgentConfigTest extends XmlTestNoCastor<WmiAgentConfig> {
+
+    public WmiAgentConfigTest(WmiAgentConfig sampleObject, Object sampleXml) {
+        super(sampleObject, sampleXml, null);
+    }
+
+    @Parameters
+    public static Collection<Object[]> data() {
+        WmiAgentConfig agentConfig = new WmiAgentConfig();
+        agentConfig.setAddress(InetAddrUtils.addr("127.0.0.1"));
 
-public class WmiAgentConfigTest {
+        return Arrays.asList(new Object[][] {
+            {
+                agentConfig,
+                "<wmi-agent-config address=\"127.0.0.1\" timeout=\"3000\" retries=\"1\"/>"
+            }
+        });
+    }
 
     @Test
     public void canConvertToAndFromMap() {

opennms-doc/guide-admin/src/asciidoc/index.adoc

@@ -147,6 +147,7 @@ include::text/performance-data-collection/collectors/nsclient.adoc[]
 include::text/performance-data-collection/collectors/tca.adoc[]
 include::text/performance-data-collection/collectors/vmware-cim.adoc[]
 include::text/performance-data-collection/collectors/vmware.adoc[]
+include::text/performance-data-collection/collectors/wmi.adoc[]
 
 [[ga-performance-mgmt-shell]]
 === Shell Commands

opennms-doc/guide-admin/src/asciidoc/text/performance-data-collection/collectors/wmi.adoc

@@ -0,0 +1,24 @@
+
+// Allow GitHub image rendering
+:imagesdir: ../../../images
+
+==== WmiCollector
+
+The _WmiCollector_ collects peformance metrics from _Windows_ systems using Windows Management Instrumentation (WMI).
+
+===== Collector Facts
+
+[options="autowidth"]
+|===
+| Class Name          | `org.opennms.netmgt.collectd.WmiCollector`
+| Package             | core
+| Supported on Minion | `Yes`
+|===
+
+===== Collector Parameters
+
+.Collector specific parameters for the WmiCollector
+[options="header, autowidth"]
+|===
+| Parameter              | Description                              | Required | Default value
+| `collection`           | The name of the _WMI Collection_ to use  | required |

opennms-wmi/pom.xml

@@ -20,6 +20,8 @@
             <Bundle-RequiredExecutionEnvironment>JavaSE-1.8</Bundle-RequiredExecutionEnvironment>
             <Bundle-SymbolicName>${project.groupId}.${project.artifactId}</Bundle-SymbolicName>
             <Bundle-Version>${project.version}</Bundle-Version>
+            <!-- Don't export any packages, expose services only. -->
+            <Export-Package></Export-Package>
           </instructions>
         </configuration>
       </plugin>
@@ -63,6 +65,11 @@
       <groupId>org.opennms</groupId>
       <artifactId>opennms-provision-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.opennms.features.collection</groupId>
+      <artifactId>org.opennms.features.collection.test-api</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <repositories>