org.opennms.bb.dp.capsd.snmp
Class IpAddrTableEntry

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.TreeMap
              |
              +--org.opennms.bb.dp.capsd.snmp.IpAddrTableEntry
All Implemented Interfaces:
Cloneable, Map, Serializable, SortedMap

public final class IpAddrTableEntry
extends TreeMap

The IpAddrTableEntry class is designed to hold all the MIB-II information for one entry in the ipAddrTable. The table effectively contains a list of these entries, each entry having information about one address. The entry contains an IP Address, its netmask, interface binding, broadcast address, and maximum packet reassembly size.

This object is used by the IpAddrTable to hold infomation single entries in the table. See the IpAddrTable documentation form more information.

Version:
$Revision: 1.10 $
Author:
Sowmya, Weave, OpenNMS
See Also:
IpAddrTable, RFC1213, Serialized Form

Inner classes inherited from class java.util.TreeMap
TreeMap.Entry
 
Inner classes inherited from class java.util.Map
Map.Entry
 
Field Summary
private static NamedSnmpVar[] ms_elemList
          The keys that will be supported by default from the TreeMap base class.
static SnmpObjectId ROOT
          The SnmpObjectId that represents the root of the interface tree.
static String TABLE_OID
          The TABLE_OID is the object identifier that represents the root of the IP Address table in the MIB forest.
 
Fields inherited from class java.util.TreeMap
BLACK, comparator, ENTRIES, entrySet, KEYS, keySet, modCount, RED, root, serialVersionUID, size, values, VALUES
 
Constructor Summary
IpAddrTableEntry()
          Creates a default instance of the IP Address table entry map.
IpAddrTableEntry(SnmpVarBind[] vars)
          The class constructor used to initialize the object to its initial state.
 
Method Summary
(package private) static void ()
          Initialize the element list for the class.
static SnmpPduRequest getNextPdu()
          This method is used to get a generic SNMP GETNEXT PDU that constains one varbind per member element.
 void update(SnmpVarBind[] vars)
          This method is used to update the map with the current information from the agent.
 
Methods inherited from class java.util.TreeMap
addAllForTreeSet, buildFromSorted, buildFromSorted, clear, clone, colorOf, comparator, compare, computeRedLevel, containsKey, containsValue, decrementSize, deleteEntry, entrySet, firstEntry, firstKey, fixAfterDeletion, fixAfterInsertion, get, getCeilEntry, getEntry, getPrecedingEntry, headMap, incrementSize, key, keySet, lastEntry, lastKey, leftOf, parentOf, put, putAll, readObject, readTreeSet, remove, rightOf, rotateLeft, rotateRight, setColor, size, subMap, successor, swapPosition, tailMap, valEquals, values, valueSearchNonNull, valueSearchNull, writeObject
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, isEmpty, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode, isEmpty
 

Field Detail

ms_elemList

private static NamedSnmpVar[] ms_elemList

The keys that will be supported by default from the TreeMap base class. Each of the elements in the list are an instance of the SNMP Interface table. Objects in this list should be used by multiple instances of this class.


TABLE_OID

public static final String TABLE_OID

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


ROOT

public static final SnmpObjectId ROOT

The SnmpObjectId that represents the root of the interface tree. It is created when the class is initialized and contains the value of TABLE_OID.

See Also:
TABLE_OID
Constructor Detail

IpAddrTableEntry

public IpAddrTableEntry()

Creates a default instance of the IP Address table entry map. The map represents a singular instance of the address table. Each column in the table for the loaded instance may be retreived either through its name or object identifier.

The initial table is constructied with zero elements in the map.


IpAddrTableEntry

public IpAddrTableEntry(SnmpVarBind[] vars)

The class constructor used to initialize the object to its initial state. Although the object's member variables can change after an instance is created, this constructor will initialize all the variables as per their named variable from the passed array of SNMP varbinds.

If the information in the object should not be modified then a final modifier can be applied to the created object.

Parameters:
vars - The array of variable bindings.
Method Detail

static void ()

Initialize the element list for the class. This is class wide data, but will be used by each instance.


update

public void update(SnmpVarBind[] vars)

This method is used to update the map with the current information from the agent. The array of variables should be all the elements in the address row.

This does not clear out any column in the actual row that does not have a definition.

Parameters:
vars - The variables in the interface row.

getNextPdu

public static SnmpPduRequest getNextPdu()

This method is used to get a generic SNMP GETNEXT PDU that constains one varbind per member element. The PDU can then be used to perform an SNMP walk of the MIB-II interface table a remote host.

Returns:
An SnmpPduRequest with the command of GETNEXT and one varbind for each member variable.