Module org.snmp4j

Class GenericAddress

    • Field Detail

      • TYPE_UDP

        public static final java.lang.String TYPE_UDP
        Default address type identifier for an UpdAddress.
        See Also:
        Constant Field Values
      • TYPE_TCP

        public static final java.lang.String TYPE_TCP
        Default address type identifier for a TcpAddress.
        See Also:
        Constant Field Values
      • TYPE_IP

        public static final java.lang.String TYPE_IP
        Default address type identifier for an IpAddress.
        See Also:
        Constant Field Values
      • TYPE_TLS

        public static final java.lang.String TYPE_TLS
        Default address type identifier for an TlsAddress.
        See Also:
        Constant Field Values
      • TYPE_DTLS

        public static final java.lang.String TYPE_DTLS
        Default address type identifier for an DtlsAddress.
        See Also:
        Constant Field Values
      • ADDRESS_TYPES_PROPERTIES

        public static final java.lang.String ADDRESS_TYPES_PROPERTIES
        See Also:
        Constant Field Values
    • Constructor Detail

      • GenericAddress

        public GenericAddress()
      • GenericAddress

        public GenericAddress​(SMIAddress address)
    • 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.
        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.
      • 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​(SMIAddress address)
      • getAddress

        public Address getAddress()
      • parse

        public static Address parse​(java.lang.String address)
        Parses a given transport protocol dependent address string into an Address instance that is subsumed by this GenericAddress object.
        Parameters:
        address - an address string with a leading type specifier as defined in the "address.properties". The format is "type:address" where the format of address depends on type. Valid values for type are, for example, "udp" and "tcp".
        Returns:
        a Address instance of the address classes specified in "address.properties" whose type ID matched the specified ID in address. If address cannot be parsed, null is returned.
        Throws:
        java.lang.IllegalArgumentException - if the address type indicator supplied is not know.
      • parseAddress

        public boolean parseAddress​(java.lang.String address)
        Parse an address form the supplied string.
        Parameters:
        address - an address string known by the GenericAddress.
        Returns:
        boolean
        See Also:
        parse(String address)
      • setValue

        public void setValue​(byte[] rawAddress)
        Description copied from interface: AssignableFromByteArray
        Sets the value of this object from the supplied byte array.
        Parameters:
        rawAddress - a byte array.
      • 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.
      • toByteArray

        public byte[] toByteArray()
        Description copied from interface: AssignableFromByteArray
        Returns the value of this object as a byte array.
        Returns:
        a byte array.
      • 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.
        Parameters:
        value - an address String.
      • getTDomainPrefix

        public static java.lang.String getTDomainPrefix​(java.lang.Class<? extends Address> addressClass)
        Gets the transport domain prefix string (lowercase) for a supplied Address class.
        Parameters:
        addressClass - an implementation class of Address.
        Returns:
        the corresponding transport domain prefix as defined by the IANA registry "SNMP Transport Domains" if the addressClass has been registered with a domain prefix, null otherwise.
        Since:
        2.0