public interface

SnmpEngine

com.sun.jmx.snmp.SnmpEngine

Class Overview

This engine is conformant with the RFC 2571. It is the main object within an SNMP entity (agent, manager...). To an engine is associated an SnmpEngineId. Engine instantiation is based on a factory SnmpEngineFactory. When an SnmpEngine is created, a User based Security Model (USM) is initialized. The security configuration is located in a text file. The text file is read when the engine is created.

Note that the engine is not used when the agent is SNMPv1/SNMPv2 only.

The USM configuration text file is remotely updatable using the USM Mib.

User that are configured in the Usm text file are nonVolatile.

Usm Mib userEntry supported storage type values are : volatile or nonVolatile only. Other values are rejected and a wrongValue is returned)

  • volatile means that user entry is not flushed in security file
  • nonVolatile means that user entry is flushed in security file
  • If a nonVolatile row is set to be volatile, it will be not flushed in the file
  • If a volatile row created from the UsmMib is set to nonVolatile, it will be flushed in the file (if the file exist and is writable otherwise an inconsistentValue is returned)

This API is a Sun Microsystems internal API and is subject to change without notice.

Summary

Public Methods
abstract int getEngineBoots()
Gets the engine boot number.
abstract SnmpEngineId getEngineId()
Gets the engine Id.
abstract int getEngineTime()
Gets the engine time in seconds.
abstract SnmpUsmKeyHandler getUsmKeyHandler()
Gets the Usm key handler.

Public Methods

public abstract int getEngineBoots ()

Gets the engine boot number. This is the number of time this engine has rebooted. Each time an SnmpEngine is instantiated, it will read this value in its Lcd, and store back the value incremented by one.

Returns
  • The engine's number of reboot.

public abstract SnmpEngineId getEngineId ()

Gets the engine Id. This is unique for each engine.

Returns
  • The engine Id object.

public abstract int getEngineTime ()

Gets the engine time in seconds. This is the time from the last reboot.

Returns
  • The time from the last reboot.

public abstract SnmpUsmKeyHandler getUsmKeyHandler ()

Gets the Usm key handler.

Returns
  • The key handler.