Package org.opennms.mock.snmp

Class MockSnmpAgent

  • All Implemented Interfaces:
    Runnable
    public class MockSnmpAgent
extends org.snmp4j.agent.BaseAgent
implements Runnable
    The MockSnmpAgent class extends the SNMP4J BaseAgent class to provide a mock SNMP agent for SNMP-based OpenNMS tests. Large chunks of code were lifted from the org.snmp4j.agent.test.TestAgent class.
    Author:
    Jeff Gehlbach

    • Field Detail

      • allowSetOnMissingOid

        public static boolean allowSetOnMissingOid

    • Constructor Detail

      • MockSnmpAgent

        public MockSnmpAgent​(File confFile,
                     URL moFile)

      • MockSnmpAgent

        public MockSnmpAgent​(File confFile,
                     URL moFile,
                     String bindAddress)
        Creates the mock agent with files to read and store the boot counter, to read and store the agent configuration, and to read the mocked managed objects (MOs), plus a string describing the address and port to bind to.
        Parameters:
        moFile - a MIB dump file describing the managed objects to be mocked. The current implementation expects a Java properties file, which can conveniently be generated using the Net-SNMP utility snmpwalk with the -One option set.

    • Method Detail

      • initMessageDispatcher

        protected void initMessageDispatcher()

        Note that this method can hang if your system entropy is not high enough. Here is a stack trace from a test running on JDK 1.8u40:

         
 Thread [MockSnmpAgent-1657048932] (Suspended)
 owns: SecureRandom  (id=26)
 owns: SecureRandom  (id=27)
 owns: SecurityProtocols  (id=28)
 FileInputStream.readBytes(byte[], int, int) line: not available [native method]
 FileInputStream.read(byte[], int, int) line: 255
 NativeSeedGenerator(SeedGenerator$URLSeedGenerator).getSeedBytes(byte[]) line: 539
 SeedGenerator.generateSeed(byte[]) line: 144
 SecureRandom$SeederHolder.() line: 203 [local variables unavailable]
 SecureRandom.engineNextBytes(byte[]) line: 221
 SecureRandom.nextBytes(byte[]) line: 468
 Salt.() line: 54
 Salt.getInstance() line: 79
 PrivDES.() line: 57
 SecurityProtocols.addDefaultProtocols() line: 155
 MockSnmpAgent.initMessageDispatcher() line: 306
 MockSnmpAgent(BaseAgent).init() line: 145
 MockSnmpAgent.run() line: 380
 Thread.run() line: 745
        Overrides:
        initMessageDispatcher in class org.snmp4j.agent.BaseAgent

      • initSnmpSession

        public void initSnmpSession()
        Overrides:
        initSnmpSession in class org.snmp4j.agent.BaseAgent

      • initConfigMIB

        public void initConfigMIB()
        Overrides:
        initConfigMIB in class org.snmp4j.agent.BaseAgent

      • setupDefaultProxyForwarder

        public void setupDefaultProxyForwarder()
        Overrides:
        setupDefaultProxyForwarder in class org.snmp4j.agent.BaseAgent

      • updateSession

        public void updateSession​(org.snmp4j.Session session)
        Overrides:
        updateSession in class org.snmp4j.agent.BaseAgent

      • run

        public void run()
        Starts the MockSnmpAgent running. Meant to be called from the start method of class Thread, but could also be used to bring up a standalone mock agent.
        Specified by:
        run in interface Runnable
        Overrides:
        run in class org.snmp4j.agent.BaseAgent
        See Also:
        BaseAgent.run()

      • shutDown

        public void shutDown()

      • isRunning

        public boolean isRunning()

      • isStopped

        public boolean isStopped()

      • addCommunities

        protected void addCommunities​(org.snmp4j.agent.mo.snmp.SnmpCommunityMIB communityMIB)
        Specified by:
        addCommunities in class org.snmp4j.agent.BaseAgent

      • addViews

        protected void addViews​(org.snmp4j.agent.mo.snmp.VacmMIB vacm)
        Specified by:
        addViews in class org.snmp4j.agent.BaseAgent

      • addNotificationTargets

        protected void addNotificationTargets​(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB,
                                      org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB)
        Specified by:
        addNotificationTargets in class org.snmp4j.agent.BaseAgent

      • addUsmUser

        protected void addUsmUser​(org.snmp4j.security.USM usm)
        Specified by:
        addUsmUser in class org.snmp4j.agent.BaseAgent

      • initTransportMappings

        protected void initTransportMappings()
                              throws IOException
        Overrides:
        initTransportMappings in class org.snmp4j.agent.BaseAgent
        Throws:
        IOException

      • getPort

        public int getPort()

      • registerSnmpMIBs

        protected void registerSnmpMIBs()
        Overrides:
        registerSnmpMIBs in class org.snmp4j.agent.BaseAgent

      • unregisterSnmpMIBs

        protected void unregisterSnmpMIBs()
        Overrides:
        unregisterSnmpMIBs in class org.snmp4j.agent.BaseAgent

      • registerManagedObjects

        protected void registerManagedObjects()
        Specified by:
        registerManagedObjects in class org.snmp4j.agent.BaseAgent

      • unregisterManagedObjects

        protected void unregisterManagedObjects()
        Specified by:
        unregisterManagedObjects in class org.snmp4j.agent.BaseAgent

      • createMockMOs

        protected List<org.snmp4j.agent.ManagedObject> createMockMOs()

      • updateValue

        public void updateValue​(org.snmp4j.smi.OID oid,
                        org.snmp4j.smi.Variable value)

      • updateValue

        public void updateValue​(String oid,
                        org.snmp4j.smi.Variable value)

      • updateIntValue

        public void updateIntValue​(String oid,
                           int val)

      • updateStringValue

        public void updateStringValue​(String oid,
                              String val)

      • updateCounter32Value

        public void updateCounter32Value​(String oid,
                                 int val)

      • updateCounter64Value

        public void updateCounter64Value​(String oid,
                                 long val)

      • updateValuesFromResource

        public void updateValuesFromResource​(URL moFile)