com.adventnet.snmp.snmp2.vacm
Class VacmViewTreeEntry

java.lang.Object
  |
  +--com.adventnet.snmp.snmp2.vacm.VacmViewTreeEntry

public class VacmViewTreeEntry
extends java.lang.Object
implements java.io.Serializable

This class is used to keep track of the VacmAccessEntry objects for each unique familyViewName. It maintains a list of VacmFamilyEntry objects for a each family viewName. The API user need not instantiate this class as the VacmViewTreeTable instantiates it. Once the VacmFamilyEntry object is created, it has to be added to the VacmViewTreeTable.

See Also:
VacmViewTreeTable, Serialized Form

Field Summary
(package private)  java.util.Vector familyVector
          Vector of VacmFamilyEntry Objects.
(package private)  byte[] familyViewName
          VacmViewTreeFamilyName
 
Constructor Summary
(package private) VacmViewTreeEntry(byte[] viewName)
          Creates a VacmViewTreeEntry with the specified familyViewName
 
Method Summary
(package private)  void addElement(VacmFamilyEntry entry1)
          Adds an entry to the accessEntryVector.
 java.util.Vector getFamilyEntries()
          Returns an Vector of VacmFamilyEntry maintained by this class.
 byte[] getFamilyViewName()
          Get the FamilyViewName associated with this object.
 java.lang.Object getKey()
          Retrive the Key for this VacmViewTreeEntry.
static java.lang.Object getKey(byte[] viewName)
          Retrive the Key for this VacmViewTreeEntry.
(package private)  boolean isInMibView(int[] OID)
          This method checks to see if the requested variable OID is in the MibView for this entry's viewName.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

familyViewName

byte[] familyViewName
VacmViewTreeFamilyName

familyVector

java.util.Vector familyVector
Vector of VacmFamilyEntry Objects. The vector is sorted.
Constructor Detail

VacmViewTreeEntry

VacmViewTreeEntry(byte[] viewName)
Creates a VacmViewTreeEntry with the specified familyViewName
Parameters:
viewName - The FamilyViewName
Method Detail

getFamilyViewName

public byte[] getFamilyViewName()
Get the FamilyViewName associated with this object.
Returns:
familyViewName associated with this object.

getFamilyEntries

public java.util.Vector getFamilyEntries()
Returns an Vector of VacmFamilyEntry maintained by this class.
Returns:
A vector of VacmFamilyEntry objects mainted by this class.

addElement

void addElement(VacmFamilyEntry entry1)
Adds an entry to the accessEntryVector.
Parameters:
entry - The VacmFamilyEntry

getKey

public java.lang.Object getKey()
Retrive the Key for this VacmViewTreeEntry.
Returns:
The Key as an Object

getKey

public static java.lang.Object getKey(byte[] viewName)
Retrive the Key for this VacmViewTreeEntry. Takes the familyName as parameter.
Parameters:
viewName - The familyViewName
Returns:
the key as a String object.
Throws:
java.lang.NullPointerException - if the viewName is null.

isInMibView

boolean isInMibView(int[] OID)
This method checks to see if the requested variable OID is in the MibView for this entry's viewName. Returns a boolean value if the OID is in mibView
Parameters:
OID - The requested variable OID
Returns:
True if the OID is in the MibView, false Otherwise