com.sun.management.snmp
Interface SnmpOidDatabase

All Superinterfaces:

SnmpOidTable

All Known Implementing Classes:

SnmpOidDatabaseSupport

public interface SnmpOidDatabase
extends SnmpOidTable

Defines the minimal functionality that should be provided by a class containing a set of SnmpOidTable objects containing metadata definitions for MIB variables. Each SnmpOidTable should contain information on variables of one MIB. The SnmpOidDatabase is a "repository" of SnmpOidTable. It extends the SnmpOidTable interface in order to provide resolution of the MIB variables.

Since:

Java DMK 5.1

See Also:

SnmpOidTable

Method Summary

void	add(SnmpOidTable table) Adds an SnmpOidTable object in this SnmpOidDatabase.
Vector	getAllEntries() Returns a list that can be used to traverse all the entries of the SnmpOidTable objects of this SnmpOidDatabase.
void	remove(SnmpOidTable table) Removes an SnmpOidTable object from this SnmpOidDatabase.
void	removeAll() Removes all the SnmpOidTable objects from this SnmpOidDatabase.
SnmpOidRecord	resolveVarName(String name) Searches for a MIB variable given its logical name and returns an SnmpOidRecord object containing information on the variable.
SnmpOidRecord	resolveVarOid(String oid) Searches for a MIB variable given its OID and returns an SnmpOidRecord object containing information on the variable.

Method Detail

add

void add(SnmpOidTable table)

Adds an SnmpOidTable object in this SnmpOidDatabase.

Parameters:

table - The table to add.

remove

void remove(SnmpOidTable table)
            throws SnmpStatusException

Removes an SnmpOidTable object from this SnmpOidDatabase.

Parameters:

table - The table to be removed.

Throws:

SnmpStatusException

removeAll

void removeAll()

Removes all the SnmpOidTable objects from this SnmpOidDatabase.

resolveVarName

SnmpOidRecord resolveVarName(String name)
                             throws SnmpStatusException

Searches for a MIB variable given its logical name and returns an SnmpOidRecord object containing information on the variable.

Specified by:

resolveVarName in interface SnmpOidTable

Parameters:

name - The name of the MIB variable.

Returns:

The SnmpOidRecord object containing information on the variable.

Throws:

SnmpStatusException - If the variable is not found.

resolveVarOid

SnmpOidRecord resolveVarOid(String oid)
                            throws SnmpStatusException

Searches for a MIB variable given its OID and returns an SnmpOidRecord object containing information on the variable.

Specified by:

resolveVarOid in interface SnmpOidTable

Parameters:

oid - The OID of the MIB variable.

Returns:

The SnmpOidRecord object containing information on the variable.

Throws:

SnmpStatusException - If the variable is not found.

getAllEntries

Vector getAllEntries()

Returns a list that can be used to traverse all the entries of the SnmpOidTable objects of this SnmpOidDatabase.

Specified by:

getAllEntries in interface SnmpOidTable

Returns:

A vector of SnmpOidTable objects containing all the elements of this SnmpOidDatabase.