Module org.snmp4j
Package org.snmp4j.cfg

Class EngineBootsCounterFile

java.lang.Object
org.snmp4j.cfg.EngineBootsCounterFile
All Implemented Interfaces:
EngineBootsProvider, EngineIdProvider, SnmpEngineIdProvider
public class EngineBootsCounterFile extends Object implements SnmpEngineIdProvider
The EngineBootsCounterFile is a SnmpEngineIdProvider that stores the boot counter amd the engine ID of an SNMP entity in a file.
Since:
3.5.0
Version:
3.5.0
Author:
Frank Fock

  • Constructor Details

    • EngineBootsCounterFile

      public EngineBootsCounterFile(File bootCounterFile)
      Creates the boot counter by using the specified file.
      Parameters:
      bootCounterFile - a file (does not have to exists yet but must be writable).

  • Method Details

    • updateEngineBoots

      public int updateEngineBoots()
      Returns the current engine boot counter value incremented by one.
      Specified by:
      updateEngineBoots in interface EngineBootsProvider
      Returns:
      the last engine boots counter incremented by one.

    • getLastEngineBoots

      protected int getLastEngineBoots()
      Reads the engine boots counter from the corresponding input stream (file).
      Returns:
      the boots counter value read or zero if it could not be read.

    • setEngineBoots

      protected void setEngineBoots(int engineBoots)

    • getEngineBoots

      public int getEngineBoots()
      Description copied from interface: EngineBootsProvider
      Returns current engine boot counter value.
      Specified by:
      getEngineBoots in interface EngineBootsProvider
      Returns:
      the last engine boots counter.

    • getBootCounterFile

      public File getBootCounterFile()

    • getEngineId

      public OctetString getEngineId(OctetString defaultEngineID)
      Description copied from interface: EngineIdProvider
      Gets the engine ID for the SNMP entity associated with this EngineIdProvider.
      Specified by:
      getEngineId in interface EngineIdProvider
      Parameters:
      defaultEngineID - the engine ID for this entity, if there is no persistently saved engine ID yet.
      Returns:
      the persistently saved engine ID or the reference to the defaultEngineID which is then persistently stored.

    • resetEngineId

      public void resetEngineId(OctetString engineId)
      Description copied from interface: EngineIdProvider
      Sets the persistently stored engine ID to a new value.
      Specified by:
      resetEngineId in interface EngineIdProvider
      Parameters:
      engineId - the new engine ID for this SNMP entity.