org.soulwing.snmp

Interface Mib

public interface Mib

A façade for a MIB implementation.

This interface defines methods for the essential aspects of a MIB commonly used in writing SNMP management applications.

Author:

Carl Harris

Method Summary

Methods

Modifier and Type	Method and Description
Mib	addDirectory(File directory) Adds a directory to the MIB file search path.
MibTrapV1Support	getV1TrapSupport() Gets the SNMPv1 TRAP support provider.
Mib	load(File file) Loads a MIB module from given file.
Mib	load(String moduleName) Loads a named MIB module.
Mib	load(URL location) Loads a MIB module from given location.
String	nameToOid(String name) Converts an object name to the corresponding object identifier.
Formatter	newFormatter(String oid) Gets a new Formatter appropriate for the object type represented by the given object identifier
IndexExtractor	newIndexExtractor(String oid) Gets a new IndexExtractor appropriate for the table column object represented by the given object identifier.
String	oidToInstanceName(String oid) Converts an object identifier string to the corresponding instance-qualified object name.
String	oidToObjectName(String oid) Converts an object identifier string to the corresponding MIB object name.
Mib	removeDirectory(File directory) Removes a directory from the MIB file search path.
int	syntaxForObject(String oid) Gets the SMI syntax indicator for the given object identifier.

Method Detail

nameToOid

String nameToOid(String name)

Converts an object name to the corresponding object identifier.

If the name is suffixed by an instance identifier, the instance identifier is appended to the returned object identifier. For example, given the name "sysName.0", this method returns 1.3.6.1.2.1.1.5.0, the OID for the singleton instance of the "sysName" object.

When searching the MIB for the given name, all currently loaded MIB modules are searched, in the reverse of the order in which they were loaded. The specified name may be optionally prefixed by a MIB module name followed by the '!' character (e.g. "RFC1213-MIB!sysName.0") in order to constrain the search to a specific MIB module.

Parameters:

name - name to convert

Returns:

object identifier string

Throws:

NameNotFoundException - if name cannot be resolved to an object identifier

oidToInstanceName

String oidToInstanceName(String oid)

Converts an object identifier string to the corresponding instance-qualified object name.

This method is the logical inverse of nameToOid(String). It returns the object name, suffixed by the object instance identifier. For example, given the 1.3.6.1.2.1.1.5.0 (the OID for the singleton instance of the "sysName" object), this method returns "sysName.0"

Parameters:

oid - the object identifier to convert

Returns:

object name. If the identifier refers to an object instance, the returned name is suffixed by the instance identifier. If the identifier does not correspond to a known name, the return value is oid.

oidToObjectName

String oidToObjectName(String oid)

Converts an object identifier string to the corresponding MIB object name.

This method simply determines the MIB name associated with the given object identifier (ignoring any instance identifier). For example, given 1.3.6.1.2.1.1.5.0 (the OID for the singleton instance of the "sysName" object), this method returns "sysName"

Parameters:

oid - the object identifier to convert

Returns:

name that corresponds to the given OID. If the identifier does not correspond to a known name, the return value is oid.

syntaxForObject

int syntaxForObject(String oid)

Gets the SMI syntax indicator for the given object identifier.

Parameters:

oid - OID of an OBJECT-TYPE (or a subordinate)

Returns:

syntax indicator

Throws:

IllegalArgumentException - if oid does not refer to an an OBJECT-TYPE or subordinate

newFormatter

Formatter newFormatter(String oid)

Gets a new Formatter appropriate for the object type represented by the given object identifier

Parameters:

oid - object identifier

Returns:

formatter object (never null)

newIndexExtractor

IndexExtractor newIndexExtractor(String oid)

Gets a new IndexExtractor appropriate for the table column object represented by the given object identifier.

Parameters:

oid - identifier of a table column object

Returns:

index extractor (never null)

Throws:

IllegalArgumentException - if the oid does not represent a (known) table column

getV1TrapSupport

MibTrapV1Support getV1TrapSupport()
                                  throws MibException

Gets the SNMPv1 TRAP support provider.

Returns:

trap support provider

Throws:

MibException

addDirectory

Mib addDirectory(File directory)

Adds a directory to the MIB file search path.

Parameters:

directory - the directory to add

Returns:

this MIB

removeDirectory

Mib removeDirectory(File directory)

Removes a directory from the MIB file search path.

Parameters:

directory - the directory to remove

Returns:

this MIB

load

Mib load(String moduleName)
         throws ModuleParseException,
                IOException

Loads a named MIB module.

Parameters:

moduleName - name of the MIB module to load

Returns:

this MIB

Throws:

ModuleParseException - if the specified MIB module cannot be parsed

IOException

load

Mib load(URL location)
         throws ModuleParseException,
                IOException

Loads a MIB module from given location.

Parameters:

location - location of the MIB module

Returns:

this MIB

Throws:

ModuleParseException - if the resource at location cannot be parsed as a MIB

ModuleParseException - if the specified MIB module cannot be parsed

IOException

load

Mib load(File file)
         throws ModuleParseException,
                IOException

Loads a MIB module from given file.

Parameters:

file - file to load

Returns:

this MIB

Throws:

ModuleParseException - if the specified MIB module cannot be parsed

IOException