Package uk.co.westhawk.snmp.stack

Class DefaultUsmAgent

java.lang.Object
uk.co.westhawk.snmp.stack.DefaultUsmAgent
All Implemented Interfaces:
UsmAgent
public class DefaultUsmAgent extends Object implements UsmAgent
This implementation of UsmAgent tries to discover the parameters by doing the default USM discovery process on localhost.

Note that it is not guaranteed that the agent will allow discovery by itself. Also, if the SNMP agent reboots while the stack is running, it will not pick up the new boots and time.

Users are advised and encouraged to provide a better, more accurate implementation of UsmAgent.

See SNMP-USER-BASED-SM-MIB.

Version:
$Revision: 3.10 $ $Date: 2009/03/05 15:51:42 $
Author:
Birgit Arkesteijn
See Also:

  • Field Details

    • LOCAL_HOST

      public static final String LOCAL_HOST
      The default name of the local host, localhost.
      See Also:

    • LOCAL_PORT

      public static final int LOCAL_PORT
      The default port number of the local host, 161.
      See Also:

  • Constructor Details

    • DefaultUsmAgent

      public DefaultUsmAgent()

  • Method Details

    • getSnmpEngineId

      public String getSnmpEngineId()
      Returns the authoritative SNMP Engine ID. If the discovery failed, null will be returned.
      Specified by:
      getSnmpEngineId in interface UsmAgent
      Returns:
      The Engine ID
      See Also:

    • getSnmpEngineBoots

      public int getSnmpEngineBoots()
      Returns the authoritative Engine Boots. If the discovery failed, 1 will be returned.
      Specified by:
      getSnmpEngineBoots in interface UsmAgent
      Returns:
      The Engine Boots

    • getSnmpEngineTime

      public int getSnmpEngineTime()
      Returns the authoritative Engine Time. If the discovery failed, 1 will be returned.
      Specified by:
      getSnmpEngineTime in interface UsmAgent
      Returns:
      The Engine Time

    • setSnmpContext

      public void setSnmpContext(SnmpContextv3Basis c)
      Sets the SNMP context. It will do a discovery if needed.
      Specified by:
      setSnmpContext in interface UsmAgent

    • setAgentName

      public void setAgentName(String host) throws UnknownHostException
      Sets my own hostname, i.e. the name of the agent or authoritative engine. By default localhost is used. Sets the hostaddress as well, using java.net.InetAddress.
      Throws:
      UnknownHostException - Thrown when java.net.InetAddress cannot resolve the name
      See Also:

    • setAgentPort

      public void setAgentPort(int p)
      Sets my own port number, i.e. the port number of the agent or authoritative engine. By default 161 is used.
      See Also:

    • getUsmStatsUnknownEngineIDs

      public long getUsmStatsUnknownEngineIDs()
      Description copied from interface: UsmAgent
      Returns the value of the usmStatsUnknownEngineIDs counter. The stack needs this when responding to a discovery request.
      Specified by:
      getUsmStatsUnknownEngineIDs in interface UsmAgent
      Since:
      4_14

    • getUsmStatsNotInTimeWindows

      public long getUsmStatsNotInTimeWindows()
      Description copied from interface: UsmAgent
      Returns the value of the usmStatsNotInTimeWindows counter. The stack needs this when responding to a discovery request.
      Specified by:
      getUsmStatsNotInTimeWindows in interface UsmAgent
      Since:
      4_14