org.opennms.netmgt.capsd.snmp

Class IfTable

java.lang.Object

org.opennms.netmgt.snmp.CollectionTracker

org.opennms.netmgt.snmp.AggregateTracker

org.opennms.netmgt.capsd.snmp.SnmpTable<IfTableEntry>

org.opennms.netmgt.capsd.snmp.IfTable

All Implemented Interfaces:

Iterable<IfTableEntry>, Collection<IfTableEntry>, Collectable

public final class IfTable
extends SnmpTable<IfTableEntry>

The IfTable uses a SnmpSession to collect the entries in the remote agent's interface table. It implements the SnmpHandler to receive notifications and handle errors associated with the data collection. Data is collected using a series of GETNEXT PDU request to walk multiple parts of the interface table at once. The number of SNMP packets should not exceed the number of interface + 1, assuming no lost packets or error conditions occur.

Addition by Jon Whetzel

IfTable has an extra class variable for the SNMP version setting. If this is set for SNMPv2, then a GETBULK command will be used for retrieving the necessary data. Otherwise, the method will resort to its previous implementation with GETNEXT commands.

Author:

Sowmya , Weave , OpenNMS

See Also:

RFC1213

Constructor Summary

Constructors

Constructor and Description
IfTable(InetAddress address) Constructs an IfTable object that is used to collect the interface elements from the remote agent.

Method Summary

Methods

Modifier and Type	Method and Description
protected IfTableEntry	createTableEntry(SnmpObjId base, SnmpInstId inst, Object val) createTableEntry
int	getAdminStatus(int ifIndex) getAdminStatus
IfTableEntry	getEntry(int ifIndex) getEntry
String	getIfDescr(int ifIndex) getIfDescr
Long	getIfSpeed(int ifIndex) getIfSpeed
int	getIfType(int ifIndex) getIfType
int	getOperStatus(int ifIndex) getOperStatus
String	getPhysAddr(int ifIndex) getPhysAddr

Methods inherited from class org.opennms.netmgt.capsd.snmp.SnmpTable

add, addAll, clear, contains, containsAll, getEntries, isEmpty, iterator, remove, removeAll, reportFatalErr, reportGenErr, reportNonFatalErr, reportNoSuchNameErr, retainAll, size, storeResult, toArray, toArray

Methods inherited from class org.opennms.netmgt.snmp.AggregateTracker

buildNextPdu, isFinished, setFailed, setMaxRepetitions, setMaxRetries, setTimedOut

Methods inherited from class org.opennms.netmgt.snmp.CollectionTracker

failed, getCollectionTracker, getParent, reportTooBigErr, setFinished, setParent, timedOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

IfTable

public IfTable(InetAddress address)

Constructs an IfTable object that is used to collect the interface elements from the remote agent. Once all the interfaces are collected, or there is an error in the collection the signaler object is notified to inform other threads.

Parameters:

address - TODO

See Also:

IfTableEntry

Method Detail

createTableEntry

protected IfTableEntry createTableEntry(SnmpObjId base,
                            SnmpInstId inst,
                            Object val)

createTableEntry

Specified by:

createTableEntry in class SnmpTable<IfTableEntry>

Parameters:

base - a SnmpObjId object.

inst - a SnmpInstId object.

val - a Object object.

Returns:

a T object.

getEntry

public IfTableEntry getEntry(int ifIndex)

getEntry

Parameters:

ifIndex - a int.

Returns:

a IfTableEntry object.

getOperStatus

public int getOperStatus(int ifIndex)

getOperStatus

Parameters:

ifIndex - a int.

Returns:

a int.

getAdminStatus

public int getAdminStatus(int ifIndex)

getAdminStatus

Parameters:

ifIndex - a int.

Returns:

a int.

getIfType

public int getIfType(int ifIndex)

getIfType

Parameters:

ifIndex - a int.

Returns:

a int.

getIfDescr

public String getIfDescr(int ifIndex)

getIfDescr

Parameters:

ifIndex - a int.

Returns:

a String object.

getIfSpeed

public Long getIfSpeed(int ifIndex)

getIfSpeed

Parameters:

ifIndex - a int.

Returns:

a Long object.

getPhysAddr

public String getPhysAddr(int ifIndex)

getPhysAddr

Parameters:

ifIndex - a int.

Returns:

a String object.