Package org.netxms.client.snmp

Class SnmpObjectId

java.lang.Object
org.netxms.client.snmp.SnmpObjectId
public class SnmpObjectId extends Object
This class represents SNMP Object Id (OID)

  • Constructor Details

    • SnmpObjectId

      public SnmpObjectId()
      Create empty OID

    • SnmpObjectId

      public SnmpObjectId(long[] value)
      Create OID from array of OID elements
      Parameters:
      value - OID elements

    • SnmpObjectId

      public SnmpObjectId(SnmpObjectId parent, long id)
      Create child OID - add given value at the end of parent OID.
      Parameters:
      parent - parent OID
      id - id

  • Method Details

    • parseSnmpObjectId

      public static SnmpObjectId parseSnmpObjectId(String s) throws SnmpObjectIdFormatException
      Parse string argument as SNMP OID. Expected to be ion format .n.n.n.n.n
      Parameters:
      s - string to parse
      Returns:
      SNMP OID object
      Throws:
      SnmpObjectIdFormatException - when string passed is not a valid SNMP OID

    • getLength

      public int getLength()
      Get object identifier length.
      Returns:
      OID length

    • setNXCPVariable

      public void setNXCPVariable(NXCPMessage msg, long varId)
      Set NXCP variable to OID's value
      Parameters:
      msg - NXCP message
      varId - Variable ID

    • startsWith

      public boolean startsWith(SnmpObjectId oid)
      Check if this object id starts with given object id.
      Parameters:
      oid - Object id to check
      Returns:
      true if this object id starts with given object id

    • compareTo

      public int compareTo(SnmpObjectId oid)
      Compare two object identifiers. The return value is -1 if this object identifier is less than given object identifier, 0 if they are equal, and 1 if this object identifier is greater then given object identifier.
      Parameters:
      oid - object identifier to compare with
      Returns:
      -1, 0, or 1 (see above for details)

    • getIdFromPos

      public long getIdFromPos(int pos)
      Get part of object ID from given position.
      Parameters:
      pos - position
      Returns:
      part of object id from given position or -1 if position is invalid

    • subId

      public SnmpObjectId subId(int length)
      Create sub ID of given length.
      Parameters:
      length - sub ID length
      Returns:
      sub ID object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: