Package org.opennms.netmgt.provision.service.snmp

Class IfTable

java.lang.Object

org.opennms.netmgt.snmp.CollectionTracker

org.opennms.netmgt.snmp.AggregateTracker

org.opennms.netmgt.provision.service.snmp.SnmpTable<IfTableEntry>

org.opennms.netmgt.provision.service.snmp.IfTable

All Implemented Interfaces:

Collectable, ProxiableTracker

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

See Also:

RFC1213

Constructor Summary

Constructors

Constructor	Description
IfTable(java.net.InetAddress address)	Constructs an IfTable object that is used to collect the interface elements from the remote agent.
IfTable(java.net.InetAddress address, java.util.Set<SnmpInstId> ifIndices)	Constructor for IfTable.

Method Summary

Modifier and Type	Method	Description
protected IfTableEntry	createTableEntry(SnmpObjId base, SnmpInstId inst, java.lang.Object val)	createTableEntry
java.lang.Integer	getAdminStatus(int ifIndex)	getAdminStatus
java.lang.String	getIfDescr(int ifIndex)	getIfDescr
java.util.Set<java.lang.Integer>	getIfIndices()	getIfIndices
java.lang.Long	getIfSpeed(int ifIndex)	getIfSpeed
java.lang.Integer	getIfType(int ifIndex)	getIfType
java.lang.Integer	getOperStatus(int ifIndex)	getOperStatus
java.lang.String	getPhysAddr(int ifIndex)	getPhysAddr
void	updateSnmpInterfaceData(OnmsNode node)	updateSnmpInterfaceData
void	updateSnmpInterfaceData(OnmsNode node, java.lang.Integer ifIndex)	updateSnmpInterfaceData

Methods inherited from class org.opennms.netmgt.provision.service.snmp.SnmpTable

getEntries, getEntry, getEntry, getInstances, reportFatalErr, reportGenErr, reportNonFatalErr, reportNoSuchNameErr, storeResult

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

buildNextPdu, getWalkRequests, handleWalkResponses, 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

Constructor Detail

IfTable

public IfTable(java.net.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

IfTable

public IfTable(java.net.InetAddress address,
               java.util.Set<SnmpInstId> ifIndices)

Constructor for IfTable.

Parameters:

address - a InetAddress object.

ifIndices - a Set object.

Method Detail

createTableEntry

protected IfTableEntry createTableEntry(SnmpObjId base,
                                        SnmpInstId inst,
                                        java.lang.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.

getOperStatus

public java.lang.Integer getOperStatus(int ifIndex)

getOperStatus

Parameters:

ifIndex - a int.

Returns:

a Integer object.

getAdminStatus

public java.lang.Integer getAdminStatus(int ifIndex)

getAdminStatus

Parameters:

ifIndex - a int.

Returns:

a Integer object.

getIfType

public java.lang.Integer getIfType(int ifIndex)

getIfType

Parameters:

ifIndex - a int.

Returns:

a Integer object.

getIfDescr

public java.lang.String getIfDescr(int ifIndex)

getIfDescr

Parameters:

ifIndex - a int.

Returns:

a String object.

getIfSpeed

public java.lang.Long getIfSpeed(int ifIndex)

getIfSpeed

Parameters:

ifIndex - a int.

Returns:

a Long object.

getPhysAddr

public java.lang.String getPhysAddr(int ifIndex)

getPhysAddr

Parameters:

ifIndex - a int.

Returns:

a String object.

updateSnmpInterfaceData

public void updateSnmpInterfaceData(OnmsNode node)

updateSnmpInterfaceData

Parameters:

node - a OnmsNode object.

updateSnmpInterfaceData

public void updateSnmpInterfaceData(OnmsNode node,
                                    java.lang.Integer ifIndex)

updateSnmpInterfaceData

Parameters:

node - a OnmsNode object.

ifIndex - a Integer object.

getIfIndices

public java.util.Set<java.lang.Integer> getIfIndices()

getIfIndices

Returns:

a Set object.