org.opennms.netmgt.capsd.snmp
Class IfTableEntry

java.lang.Object
  org.opennms.netmgt.snmp.AbstractSnmpStore
      org.opennms.netmgt.capsd.snmp.SnmpStore
          org.opennms.netmgt.capsd.snmp.SnmpTableEntry
              org.opennms.netmgt.capsd.snmp.IfTableEntry

public final class IfTableEntry
extends SnmpTableEntry

This object contains a list of all the elements defined in the MIB-II interface table. An instance object is initialized by calling the constructor and passing in a variable list from an SNMP PDU. The actual data can be recovered via the base class map interface.

Once an instance is created and its data set either via the constructor or from the update method, the actual elements can be retreived using the instance names. The names include: ifIndex,ifDescr, ifSpeed,etc al. The information can also be accessed by using the complete object identifer for the entry.

For more information on the individual fields, and to find out their respective object identifiers see RFC1213 from the IETF.

Author:

Sowmya , Weave , Jon Whetzel , OpenNMS

See Also:

RFC1213

Field Summary

static String	IF_ADMIN_STATUS
static String	IF_DESCR
static String	IF_IN_DISCARDS
static String	IF_IN_ERRORS
static String	IF_IN_NUCAST
static String	IF_IN_OCTETS
static String	IF_IN_UCAST
static String	IF_IN_UKNOWN_PROTOS
static String	IF_INDEX
static String	IF_LAST_CHANGE
static String	IF_MTU
static String	IF_OPER_STATUS
static String	IF_OUT_DISCARDS
static String	IF_OUT_ERRORS
static String	IF_OUT_NUCAST
static String	IF_OUT_OCTETS
static String	IF_OUT_QLEN
static String	IF_OUT_UCAST
static String	IF_PHYS_ADDR
static String	IF_SPECIFIC
static String	IF_SPEED
static String	IF_TYPE
static NamedSnmpVar[]	ms_elemList
static String	TABLE_OID The TABLE_OID is the object identifier that represents the root of the interface table in the MIB forest.

Fields inherited from class org.opennms.netmgt.snmp.AbstractSnmpStore

IFINDEX

Constructor Summary

IfTableEntry()
The class constructor used to initialize the object to its initial state.

Method Summary

Integer	getIfAdminStatus()
String	getIfDescr()
Integer	getIfOperStatus()
Long	getIfSpeed()
Integer	getIfType()
String	getPhysAddr()

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

getElementListSize, getElements, log, storeResult

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

getDisplayString, getHexString, getIfIndex, getInt32, getIPAddress, getObjectID, getUInt32, getValue, isEmpty, putIfIndex, putValue, size

Methods inherited from class java.lang.Object

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

Field Detail

IF_INDEX

public static final String IF_INDEX

See Also:

Constant Field Values

IF_DESCR

public static final String IF_DESCR

See Also:

Constant Field Values

IF_TYPE

public static final String IF_TYPE

See Also:

Constant Field Values

IF_MTU

public static final String IF_MTU

See Also:

Constant Field Values

IF_SPEED

public static final String IF_SPEED

See Also:

Constant Field Values

IF_PHYS_ADDR

public static final String IF_PHYS_ADDR

See Also:

Constant Field Values

IF_ADMIN_STATUS

public static final String IF_ADMIN_STATUS

See Also:

Constant Field Values

IF_OPER_STATUS

public static final String IF_OPER_STATUS

See Also:

Constant Field Values

IF_LAST_CHANGE

public static final String IF_LAST_CHANGE

See Also:

Constant Field Values

IF_IN_OCTETS

public static final String IF_IN_OCTETS

See Also:

Constant Field Values

IF_IN_UCAST

public static final String IF_IN_UCAST

See Also:

Constant Field Values

IF_IN_NUCAST

public static final String IF_IN_NUCAST

See Also:

Constant Field Values

IF_IN_DISCARDS

public static final String IF_IN_DISCARDS

See Also:

Constant Field Values

IF_IN_ERRORS

public static final String IF_IN_ERRORS

See Also:

Constant Field Values

IF_IN_UKNOWN_PROTOS

public static final String IF_IN_UKNOWN_PROTOS

See Also:

Constant Field Values

IF_OUT_OCTETS

public static final String IF_OUT_OCTETS

See Also:

Constant Field Values

IF_OUT_UCAST

public static final String IF_OUT_UCAST

See Also:

Constant Field Values

IF_OUT_NUCAST

public static final String IF_OUT_NUCAST

See Also:

Constant Field Values

IF_OUT_DISCARDS

public static final String IF_OUT_DISCARDS

See Also:

Constant Field Values

IF_OUT_ERRORS

public static final String IF_OUT_ERRORS

See Also:

Constant Field Values

IF_OUT_QLEN

public static final String IF_OUT_QLEN

See Also:

Constant Field Values

IF_SPECIFIC

public static final String IF_SPECIFIC

See Also:

Constant Field Values

ms_elemList

public static NamedSnmpVar[] ms_elemList

TABLE_OID

public static final String TABLE_OID

The TABLE_OID is the object identifier that represents the root of the interface table in the MIB forest.

See Also:

Constant Field Values

Constructor Detail

IfTableEntry

public IfTableEntry()

The class constructor used to initialize the object to its initial state. Although the object's attributes and data can be changed after its created, this constructor will initialize all the variables as per their named varbind in the passed array. This array should have been collected from an SnmpPduRequest that was received from a remote host.

Parameters:

vars - The array of variable bindings.

Method Detail

getIfType

public Integer getIfType()

getIfAdminStatus

public Integer getIfAdminStatus()

getIfDescr

public String getIfDescr()

getPhysAddr

public String getPhysAddr()

getIfOperStatus

public Integer getIfOperStatus()

getIfSpeed

public Long getIfSpeed()