org.snmp4j.agent.mo.snmp

Class SnmpFrameworkMIB

java.lang.Object

org.snmp4j.agent.mo.snmp.SnmpFrameworkMIB

All Implemented Interfaces:

TCModule, MOGroup

public class SnmpFrameworkMIB
extends Object
implements MOGroup, TCModule

The SnmpFrameworkMIB implements the SNMP-FRAMEWORK-MIB as defined by RFC 3411.

Version:

2.3.2

Author:

Frank Fock

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE_NAME
static String	SNMPADMINSTRING
static String	SNMPENGINEID

Constructor Summary

Constructors

Constructor and Description
SnmpFrameworkMIB(org.snmp4j.security.USM usm, Collection<org.snmp4j.TransportMapping> transportMappings)
SnmpFrameworkMIB(org.snmp4j.security.USM usm, Collection<org.snmp4j.TransportMapping> transportMappings, boolean updateUsmFromMIB)

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the (unique) name of the module definition.
MOScalar	getSnmpEngineBoots()
MOScalar	getSnmpEngineID()
MOScalar	getSnmpEngineMaxMessageSize()
MOScalar	getSnmpEngineTime()
TextualConvention	getTextualConvention(String name) Gets the textual convention for the specified name.
Collection<TextualConvention>	getTextualConventions() Gets a collection of TextualConvention instances in this TCModule.
org.snmp4j.security.USM	getUSM()
boolean	isUpdateUsmFromMIB() Indicates whether changes on the getSnmpEngineID(), getSnmpEngineBoots(), and getSnmpEngineTime() values are propagated to the referenced USM instance.
void	registerMOs(MOServer server, org.snmp4j.smi.OctetString context) Registers the managed objects of this group with the server for the supplied context.
void	unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context) Unregisters the managed objects of this group from the supplied server and from the supplied context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

SNMPADMINSTRING

public static final String SNMPADMINSTRING

See Also:

Constant Field Values

SNMPENGINEID

public static final String SNMPENGINEID

See Also:

Constant Field Values

Constructor Detail

SnmpFrameworkMIB

public SnmpFrameworkMIB(org.snmp4j.security.USM usm,
                        Collection<org.snmp4j.TransportMapping> transportMappings)

SnmpFrameworkMIB

public SnmpFrameworkMIB(org.snmp4j.security.USM usm,
                        Collection<org.snmp4j.TransportMapping> transportMappings,
                        boolean updateUsmFromMIB)

Method Detail

registerMOs

public void registerMOs(MOServer server,
                        org.snmp4j.smi.OctetString context)
                 throws DuplicateRegistrationException

Description copied from interface: MOGroup

Registers the managed objects of this group with the server for the supplied context.

Specified by:

registerMOs in interface MOGroup

Parameters:

server - the MOServer where to register the managed objects.

context - the context to use (may be null if no specific context is selected).

Throws:

DuplicateRegistrationException - if a managed object's scope (i.e. lower bound) is already registered at the server.

unregisterMOs

public void unregisterMOs(MOServer server,
                          org.snmp4j.smi.OctetString context)

Description copied from interface: MOGroup

Unregisters the managed objects of this group from the supplied server and from the supplied context.

Specified by:

unregisterMOs in interface MOGroup

Parameters:

server - the MOServer where to unregister the managed objects.

context - the context to use (may be null if no specific context is selected).

getSnmpEngineBoots

public MOScalar getSnmpEngineBoots()

getSnmpEngineID

public MOScalar getSnmpEngineID()

getSnmpEngineMaxMessageSize

public MOScalar getSnmpEngineMaxMessageSize()

getSnmpEngineTime

public MOScalar getSnmpEngineTime()

getUSM

public org.snmp4j.security.USM getUSM()

isUpdateUsmFromMIB

public boolean isUpdateUsmFromMIB()

Indicates whether changes on the getSnmpEngineID(), getSnmpEngineBoots(), and getSnmpEngineTime() values are propagated to the referenced USM instance. If true, changes of those objects will be applied to the USM.

Returns:

true if changes are propagated.

getName

public String getName()

Description copied from interface: TCModule

Returns the (unique) name of the module definition.

Specified by:

getName in interface TCModule

Returns:

a unique SMI MODULE name (upper case string with hyphens).

getTextualConvention

public TextualConvention getTextualConvention(String name)

Description copied from interface: TCModule

Gets the textual convention for the specified name.

Specified by:

getTextualConvention in interface TCModule

Parameters:

name - the object definition name of the TC MIB definition.

Returns:

a TextualConvention instance.

getTextualConventions

public Collection<TextualConvention> getTextualConventions()

Description copied from interface: TCModule

Gets a collection of TextualConvention instances in this TCModule.

Specified by:

getTextualConventions in interface TCModule

Returns:

a Collection of TextualConvention instances.