Package org.opennms.netmgt.config.datacollection

Class MibObject

  • All Implemented Interfaces:
    Collectable
    public class MibObject
extends java.lang.Object
implements Collectable
    Deprecated.
    Legacy MibObject model object
    This class is responsible for holding information about a particular MIB object parsed from the DataCollection.xml file.
    Author:
    Mike

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String INSTANCE_IFADDRESS
      Deprecated.
      Indicates that the interface's IP address is to be appended to the object's oid.
      static java.lang.String INSTANCE_IFINDEX
      Deprecated.
      Indicates that the interface's 'ifIndex' value from the 'ipInterface' table of the database should be appended to the object's oid.

    • Constructor Summary

      Constructors 
      Constructor Description
      MibObject()
      Deprecated.
      Constructor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object object)
      Deprecated.
      This method is responsible for comparing this MibObject with the passed Object to determine if they are equivalent.
      java.lang.String getAlias()
      Deprecated.
      Returns the object's alias.
      CollectionTracker getCollectionTracker()
      Deprecated.
      getCollectionTracker
      CollectionTracker getCollectionTracker​(SnmpInstId... instances)
      Deprecated.
      getCollectionTracker
      static CollectionTracker[] getCollectionTrackers​(java.util.List<MibObject> objList)
      Deprecated.
      getCollectionTrackers
      static CollectionTracker[] getCollectionTrackers​(java.util.List<MibObject> objList, SnmpInstId... instances)
      Deprecated.
      getCollectionTrackers
      java.lang.String getGroupIfType()
      Deprecated.
      getGroupIfType
      java.lang.String getGroupName()
      Deprecated.
      getGroupName
      java.lang.String getInstance()
      Deprecated.
      Returns the instance string associated with the object.
      java.lang.String getMaxval()
      Deprecated.
      Returns the object's maximum value.
      java.lang.String getMinval()
      Deprecated.
      Returns the object's minimum value.
      java.lang.String getOid()
      Deprecated.
      Returns the object's identifier.
      ResourceType getResourceType()
      Deprecated.
      getResourceType
      SnmpObjId getSnmpObjId()
      Deprecated.
      getSnmpObjId
      java.lang.String getType()
      Deprecated.
      Returns the object's data type.
      int hashCode()
      Deprecated.
      hashCode
      void setAlias​(java.lang.String alias)
      Deprecated.
      This method is used to assign the object's alias.
      void setGroupIfType​(java.lang.String groupIfType)
      Deprecated.
      setGroupIfType
      void setGroupName​(java.lang.String groupName)
      Deprecated.
      setGroupName
      void setInstance​(java.lang.String instance)
      Deprecated.
      This method is used to specify the object's instance to be retrieved.
      void setMaxval​(java.lang.String maxval)
      Deprecated.
      This method is used to assign the object's maximum value.
      void setMinval​(java.lang.String minval)
      Deprecated.
      This method is used to assign the object's minimum value.
      void setOid​(java.lang.String oid)
      Deprecated.
      This method is used to assign the object's identifier.
      void setResourceType​(ResourceType resourceType)
      Deprecated.
      setResourceType
      void setType​(java.lang.String type)
      Deprecated.
      This method is used to assign the object's expected data type.
      java.lang.String toString()
      Deprecated.
      This method is responsible for returning a String object which represents the content of this MibObject.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • INSTANCE_IFINDEX

        public static final java.lang.String INSTANCE_IFINDEX
        Deprecated.
        Indicates that the interface's 'ifIndex' value from the 'ipInterface' table of the database should be appended to the object's oid.
        See Also:
        Constant Field Values

      • INSTANCE_IFADDRESS

        public static final java.lang.String INSTANCE_IFADDRESS
        Deprecated.
        Indicates that the interface's IP address is to be appended to the object's oid.
        See Also:
        Constant Field Values

    • Constructor Detail

      • MibObject

        public MibObject()
        Deprecated.
        Constructor

    • Method Detail

      • setOid

        public void setOid​(java.lang.String oid)
        Deprecated.
        This method is used to assign the object's identifier.
        Parameters:
        oid - - object identifier in dotted decimal notation (e.g., ".1.3.6.1.2.1.1.1")

      • setAlias

        public void setAlias​(java.lang.String alias)
        Deprecated.
        This method is used to assign the object's alias.
        Parameters:
        alias - - object alias (e.g., "sysDescription")

      • setType

        public void setType​(java.lang.String type)
        Deprecated.
        This method is used to assign the object's expected data type.
        Parameters:
        type - - object's data type

      • setMaxval

        public void setMaxval​(java.lang.String maxval)
        Deprecated.
        This method is used to assign the object's maximum value.
        Parameters:
        maxval - object's maximum value

      • setMinval

        public void setMinval​(java.lang.String minval)
        Deprecated.
        This method is used to assign the object's minimum value.
        Parameters:
        minval - object's minimum value

      • setInstance

        public void setInstance​(java.lang.String instance)
        Deprecated.
        This method is used to specify the object's instance to be retrieved. The instance specified here will be dereferenced if necessary and appended to the object's identifier string. Valid instance values are keywords such as "ifIndex" and "ifAddress" or numeric values such as "0" or "99". Numeric values will simply be appended to the objects identifer as-is while keyword values will be dereferenced and will be assigned a valued which is dependent on the SNMP agent's IP address.
        Parameters:
        instance - a String object.
        See Also:
        INSTANCE_IFINDEX, INSTANCE_IFADDRESS, INSTANCE_IFINDEX, INSTANCE_IFADDRESS

      • setGroupName

        public void setGroupName​(java.lang.String groupName)
        Deprecated.

        setGroupName

        Parameters:
        groupName - a String object.

      • getOid

        public java.lang.String getOid()
        Deprecated.
        Returns the object's identifier.
        Returns:
        The object's identifier string.

      • getMaxval

        public java.lang.String getMaxval()
        Deprecated.
        Returns the object's maximum value.
        Returns:
        The object's maxval.

      • getMinval

        public java.lang.String getMinval()
        Deprecated.
        Returns the object's minimum value.
        Returns:
        The object's minval.

      • getAlias

        public java.lang.String getAlias()
        Deprecated.
        Returns the object's alias.
        Returns:
        The object's alias.

      • getType

        public java.lang.String getType()
        Deprecated.
        Returns the object's data type.
        Returns:
        The object's data type

      • getInstance

        public java.lang.String getInstance()
        Deprecated.
        Returns the instance string associated with the object.
        Returns:
        The instance value associated with the object

      • getGroupName

        public java.lang.String getGroupName()
        Deprecated.

        getGroupName

        Returns:
        a String object.

      • equals

        public boolean equals​(java.lang.Object object)
        Deprecated.
        This method is responsible for comparing this MibObject with the passed Object to determine if they are equivalent. The objects are equivalent if the argument is a MibObject object with the same object identifier, instance, alias and type.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Deprecated.

        hashCode

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a int.

      • toString

        public java.lang.String toString()
        Deprecated.
        This method is responsible for returning a String object which represents the content of this MibObject. Primarily used for debugging purposes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String which represents the content of this MibObject

      • getCollectionTrackers

        public static CollectionTracker[] getCollectionTrackers​(java.util.List<MibObject> objList)
        Deprecated.

        getCollectionTrackers

        Parameters:
        objList - a List object.
        Returns:
        an array of CollectionTracker objects.

      • getSnmpObjId

        public SnmpObjId getSnmpObjId()
        Deprecated.

        getSnmpObjId

        Returns:
        a SnmpObjId object.

      • setGroupIfType

        public void setGroupIfType​(java.lang.String groupIfType)
        Deprecated.

        setGroupIfType

        Parameters:
        groupIfType - a String object.

      • getGroupIfType

        public java.lang.String getGroupIfType()
        Deprecated.

        getGroupIfType

        Returns:
        a String object.

      • setResourceType

        public void setResourceType​(ResourceType resourceType)
        Deprecated.

        setResourceType

        Parameters:
        resourceType - a ResourceType object.