Module org.snmp4j

Class IpAddress

    • Field Detail

      • ANY_IPADDRESS

        public static final java.net.InetAddress ANY_IPADDRESS
    • Constructor Detail

      • IpAddress

        public IpAddress()
        Creates a 0.0.0.0 IP address.
      • IpAddress

        public IpAddress​(java.net.InetAddress address)
        Creates an IP address from an InetAddress
        Parameters:
        address - an InetAddress instance (must not necessarily be a IPv4 address).
      • IpAddress

        public IpAddress​(java.lang.String address)
        Create an IP address from an address string.
        Parameters:
        address - an IP address String.
        See Also:
        Address.parseAddress(String address)
      • IpAddress

        public IpAddress​(byte[] addressBytes)
        Create an IP address from a raw IP address. The argument is in network byte order: the highest order byte of the address is in first element of the supplied byte array.
        Parameters:
        addressBytes - the raw IP address in network byte order.
        Since:
        1.10.2
    • Method Detail

      • getSyntax

        public int getSyntax()
        Description copied from class: AbstractVariable
        Gets the ASN.1 syntax identifier value of this SNMP variable.
        Specified by:
        getSyntax in interface Variable
        Specified by:
        getSyntax in class AbstractVariable
        Returns:
        an integer value less than 128 for regular SMI objects and a value greater or equal than 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.
      • isValid

        public boolean isValid()
        Description copied from interface: Address
        Checks whether this Address is a valid transport address.
        Specified by:
        isValid in interface Address
        Returns:
        true if the address is valid, false otherwise.
      • toString

        public java.lang.String toString()
        Description copied from class: AbstractVariable
        Gets a string representation of the variable.
        Specified by:
        toString in interface Variable
        Specified by:
        toString in class AbstractVariable
        Returns:
        a string representation of the variable's value.
      • parse

        public static Address parse​(java.lang.String address)
        Parses an IP address string and returns the corresponding IpAddress instance.
        Parameters:
        address - an IP address string which may be a host name or a numerical IP address.
        Returns:
        an IpAddress instance or null if address cannot not be parsed.
        See Also:
        Address.parseAddress(String address)
      • parseAddress

        public boolean parseAddress​(java.lang.String address)
        Description copied from interface: Address
        Parses the address from the supplied string representation.
        Specified by:
        parseAddress in interface Address
        Parameters:
        address - a String representation of this address.
        Returns:
        true if address could be successfully parsed and has been assigned to this address object, false otherwise.
      • encodeBER

        public void encodeBER​(java.io.OutputStream outputStream)
                       throws java.io.IOException
        Description copied from class: AbstractVariable
        Encodes a Variable to an OutputStream.
        Specified by:
        encodeBER in interface BERSerializable
        Specified by:
        encodeBER in class AbstractVariable
        Parameters:
        outputStream - an OutputStream.
        Throws:
        java.io.IOException - if an error occurs while writing to the stream.
      • getBERLength

        public int getBERLength()
        Description copied from class: AbstractVariable
        Returns the length of this Variable in bytes when encoded according to the Basic Encoding Rules (BER).
        Specified by:
        getBERLength in interface BERSerializable
        Specified by:
        getBERLength in class AbstractVariable
        Returns:
        the BER encoded length of this variable.
      • setAddress

        public void setAddress​(byte[] rawValue)
                        throws java.net.UnknownHostException
        Throws:
        java.net.UnknownHostException
      • setInetAddress

        public void setInetAddress​(java.net.InetAddress inetAddress)
      • getInetAddress

        public java.net.InetAddress getInetAddress()
      • clone

        public java.lang.Object clone()
        Description copied from interface: Variable
        Clones this variable. Cloning can be used by the SNMP4J API to better support concurrency by creating a clone for internal processing. The content of this object is independent to the content of the clone. Thus, changes to the clone will have no effect to this object.
        Specified by:
        clone in interface Variable
        Specified by:
        clone in class AbstractVariable
        Returns:
        a new instance of this Variable with the same value.
      • toInt

        public int toInt()
        Description copied from class: AbstractVariable
        Returns an integer representation of this variable if such a representation exists.
        Specified by:
        toInt in interface Variable
        Specified by:
        toInt in class AbstractVariable
        Returns:
        an integer value (if the native representation of this variable would be a long, then the long value will be casted to int).
      • toLong

        public long toLong()
        Description copied from class: AbstractVariable
        Returns a long representation of this variable if such a representation exists.
        Specified by:
        toLong in interface Variable
        Specified by:
        toLong in class AbstractVariable
        Returns:
        a long value.
      • toSubIndex

        public OID toSubIndex​(boolean impliedLength)
        Description copied from class: AbstractVariable
        Converts the value of this Variable to a (sub-)index value.
        Specified by:
        toSubIndex in interface Variable
        Specified by:
        toSubIndex in class AbstractVariable
        Parameters:
        impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.
        Returns:
        an OID that represents this value as an (sub-)index.
      • fromSubIndex

        public void fromSubIndex​(OID subIndex,
                                 boolean impliedLength)
        Description copied from class: AbstractVariable
        Sets the value of this Variable from the supplied (sub-)index.
        Specified by:
        fromSubIndex in interface Variable
        Specified by:
        fromSubIndex in class AbstractVariable
        Parameters:
        subIndex - the sub-index OID.
        impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.
      • setValue

        public void setValue​(java.lang.String value)
        Description copied from interface: Address
        Sets the address value from the supplied String. The string must match the format required for the Address instance implementing this interface. Otherwise an IllegalArgumentException runtime exception is thrown.
        Specified by:
        setValue in interface Address
        Specified by:
        setValue in interface AssignableFromString
        Parameters:
        value - an address String.