IfTableEntry (OpenNMS 2015.1.9 API)

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

```
public final class IfTableEntry
extends SnmpStore
```
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 retrieved using the instance names. The names include: ifIndex,ifDescr, ifSpeed,etc. The information can also be accessed by using the complete object identifier 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

Fields
Modifier and Type	Field and Description
`static String`	`IF_ADMIN_STATUS` Constant `IF_ADMIN_STATUS="ifAdminStatus"`
`static String`	`IF_DESCR` Constant `IF_DESCR="ifDescr"`
`static String`	`IF_IN_DISCARDS` Constant `IF_IN_DISCARDS="ifInDiscards"`
`static String`	`IF_IN_ERRORS` Constant `IF_IN_ERRORS="ifInErrors"`
`static String`	`IF_IN_NUCAST` Constant `IF_IN_NUCAST="ifInNUcastPkts"`
`static String`	`IF_IN_OCTETS` Constant `IF_IN_OCTETS="ifInOctets"`
`static String`	`IF_IN_UCAST` Constant `IF_IN_UCAST="ifInUcastPkts"`
`static String`	`IF_IN_UKNOWN_PROTOS` Constant `IF_IN_UKNOWN_PROTOS="ifInUnknownProtos"`
`static String`	`IF_INDEX` Constant `IF_INDEX="AbstractSnmpStore.IFINDEX"`
`static String`	`IF_LAST_CHANGE` Constant `IF_LAST_CHANGE="ifLastChange"`
`static String`	`IF_MTU` Constant `IF_MTU="ifMtu"`
`static String`	`IF_OPER_STATUS` Constant `IF_OPER_STATUS="ifOperStatus"`
`static String`	`IF_OUT_DISCARDS` Constant `IF_OUT_DISCARDS="ifOutDiscards"`
`static String`	`IF_OUT_ERRORS` Constant `IF_OUT_ERRORS="ifOutErrors"`
`static String`	`IF_OUT_NUCAST` Constant `IF_OUT_NUCAST="ifOutNUcastPkts"`
`static String`	`IF_OUT_OCTETS` Constant `IF_OUT_OCTETS="ifOutOctets"`
`static String`	`IF_OUT_QLEN` Constant `IF_OUT_QLEN="ifOutQLen"`
`static String`	`IF_OUT_UCAST` Constant `IF_OUT_UCAST="ifOutUcastPkts"`
`static String`	`IF_PHYS_ADDR` Constant `IF_PHYS_ADDR="ifPhysAddr"`
`static String`	`IF_SPECIFIC` Constant `IF_SPECIFIC="ifSpecific"`
`static String`	`IF_SPEED` Constant `IF_SPEED="ifSpeed"`
`static String`	`IF_TYPE` Constant `IF_TYPE="ifType"`
`static NamedSnmpVar[]`	`ms_elemList` Constant `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

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`IfTableEntry()` The class constructor used to initialize the object to its initial state.

Method Summary

Methods
Modifier and Type	Method and Description
`Integer`	`getIfAdminStatus()` getIfAdminStatus
`String`	`getIfDescr()` getIfDescr
`Integer`	`getIfOperStatus()` getIfOperStatus
`Long`	`getIfSpeed()` getIfSpeed
`Integer`	`getIfType()` getIfType
`String`	`getPhysAddr()` getPhysAddr

Methods inherited from class org.opennms.netmgt.snmp.SnmpStore
getElementListSize, getElements, 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
```
    Constant IF_INDEX="AbstractSnmpStore.IFINDEX"
    
    See Also:
    Constant Field Values
  - IF_DESCR
```
public static final String IF_DESCR
```
    Constant IF_DESCR="ifDescr"
    
    See Also:
    Constant Field Values
  - IF_TYPE
```
public static final String IF_TYPE
```
    Constant IF_TYPE="ifType"
    
    See Also:
    Constant Field Values
  - IF_MTU
```
public static final String IF_MTU
```
    Constant IF_MTU="ifMtu"
    
    See Also:
    Constant Field Values
  - IF_SPEED
```
public static final String IF_SPEED
```
    Constant IF_SPEED="ifSpeed"
    
    See Also:
    Constant Field Values
  - IF_PHYS_ADDR
```
public static final String IF_PHYS_ADDR
```
    Constant IF_PHYS_ADDR="ifPhysAddr"
    
    See Also:
    Constant Field Values
  - IF_ADMIN_STATUS
```
public static final String IF_ADMIN_STATUS
```
    Constant IF_ADMIN_STATUS="ifAdminStatus"
    
    See Also:
    Constant Field Values
  - IF_OPER_STATUS
```
public static final String IF_OPER_STATUS
```
    Constant IF_OPER_STATUS="ifOperStatus"
    
    See Also:
    Constant Field Values
  - IF_LAST_CHANGE
```
public static final String IF_LAST_CHANGE
```
    Constant IF_LAST_CHANGE="ifLastChange"
    
    See Also:
    Constant Field Values
  - IF_IN_OCTETS
```
public static final String IF_IN_OCTETS
```
    Constant IF_IN_OCTETS="ifInOctets"
    
    See Also:
    Constant Field Values
  - IF_IN_UCAST
```
public static final String IF_IN_UCAST
```
    Constant IF_IN_UCAST="ifInUcastPkts"
    
    See Also:
    Constant Field Values
  - IF_IN_NUCAST
```
public static final String IF_IN_NUCAST
```
    Constant IF_IN_NUCAST="ifInNUcastPkts"
    
    See Also:
    Constant Field Values
  - IF_IN_DISCARDS
```
public static final String IF_IN_DISCARDS
```
    Constant IF_IN_DISCARDS="ifInDiscards"
    
    See Also:
    Constant Field Values
  - IF_IN_ERRORS
```
public static final String IF_IN_ERRORS
```
    Constant IF_IN_ERRORS="ifInErrors"
    
    See Also:
    Constant Field Values
  - IF_IN_UKNOWN_PROTOS
```
public static final String IF_IN_UKNOWN_PROTOS
```
    Constant IF_IN_UKNOWN_PROTOS="ifInUnknownProtos"
    
    See Also:
    Constant Field Values
  - IF_OUT_OCTETS
```
public static final String IF_OUT_OCTETS
```
    Constant IF_OUT_OCTETS="ifOutOctets"
    
    See Also:
    Constant Field Values
  - IF_OUT_UCAST
```
public static final String IF_OUT_UCAST
```
    Constant IF_OUT_UCAST="ifOutUcastPkts"
    
    See Also:
    Constant Field Values
  - IF_OUT_NUCAST
```
public static final String IF_OUT_NUCAST
```
    Constant IF_OUT_NUCAST="ifOutNUcastPkts"
    
    See Also:
    Constant Field Values
  - IF_OUT_DISCARDS
```
public static final String IF_OUT_DISCARDS
```
    Constant IF_OUT_DISCARDS="ifOutDiscards"
    
    See Also:
    Constant Field Values
  - IF_OUT_ERRORS
```
public static final String IF_OUT_ERRORS
```
    Constant IF_OUT_ERRORS="ifOutErrors"
    
    See Also:
    Constant Field Values
  - IF_OUT_QLEN
```
public static final String IF_OUT_QLEN
```
    Constant IF_OUT_QLEN="ifOutQLen"
    
    See Also:
    Constant Field Values
  - IF_SPECIFIC
```
public static final String IF_SPECIFIC
```
    Constant IF_SPECIFIC="ifSpecific"
    
    See Also:
    Constant Field Values
  - ms_elemList
```
public static final NamedSnmpVar[] ms_elemList
```
    Constant 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.
- Method Detail
  - getIfType
```
public Integer getIfType()
```
    getIfType
    
    Returns:
    a Integer object.
  - getIfAdminStatus
```
public Integer getIfAdminStatus()
```
    getIfAdminStatus
    
    Returns:
    a Integer object.
  - getIfDescr
```
public String getIfDescr()
```
    getIfDescr
    
    Returns:
    a String object.
  - getPhysAddr
```
public String getPhysAddr()
```
    getPhysAddr
    
    Returns:
    a String object.
  - getIfOperStatus
```
public Integer getIfOperStatus()
```
    getIfOperStatus
    
    Returns:
    a Integer object.
  - getIfSpeed
```
public Long getIfSpeed()
```
    getIfSpeed
    
    Returns:
    a Long object.

Class IfTableEntry

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

IF_INDEX

IF_DESCR

IF_TYPE

IF_MTU

IF_SPEED

IF_PHYS_ADDR

IF_ADMIN_STATUS

IF_OPER_STATUS

IF_LAST_CHANGE

IF_IN_OCTETS

IF_IN_UCAST

IF_IN_NUCAST

IF_IN_DISCARDS

IF_IN_ERRORS

IF_IN_UKNOWN_PROTOS

IF_OUT_OCTETS

IF_OUT_UCAST

IF_OUT_NUCAST

IF_OUT_DISCARDS

IF_OUT_ERRORS

IF_OUT_QLEN

IF_SPECIFIC

ms_elemList

TABLE_OID

Constructor Detail

IfTableEntry

Method Detail

getIfType

getIfAdminStatus

getIfDescr

getPhysAddr

getIfOperStatus

getIfSpeed