Module org.snmp4j
Package org.snmp4j.smi

Interface Address

All Superinterfaces:
AssignableFromByteArray, AssignableFromString
All Known Implementing Classes:
DtlsAddress, GenericAddress, IpAddress, SMIAddress, TcpAddress, TlsAddress, TransportIpAddress, UdpAddress
public interface Address extends AssignableFromString, AssignableFromByteArray
The Address interface serves as a base class for all SNMP transport addresses.
Version:
3.2.0
Author:
Frank Fock

  • Method Details

    • isValid

      boolean isValid()
      Checks whether this Address is a valid transport address.
      Returns:
      true if the address is valid, false otherwise.

    • parseAddress

      boolean parseAddress(String address)
      Parses the address from the supplied string representation.
      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.

    • setValue

      void setValue(String 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 AssignableFromString
      Parameters:
      address - an address String.
      Since:
      1.7

    • isTransportCompatible

      default boolean isTransportCompatible(Class<?> other)
      Checks if the supplied address class is compatible with this class. For example, secure transport classes like TLS are not compatible with TCP because the latter is not able to provide the required security characteristics.
      Parameters:
      other - the Address class to check for compatibility.
      Returns:
      true if the provided address class has the same (compatible) on-the-wire characteristics than this address class. By default, this is true if the provided class other is the same or a subclass than this class.
      Since:
      3.2.0

    • getFamily

      ProtocolFamily getFamily()
      Gets the protocol family of this address.
      Returns:
      a protocol family.
      Since:
      3.7.0

    • getSocketAddress

      SocketAddress getSocketAddress()
      Gets the socket address of this address.
      Returns:
      the socket address representation (if available) of this address or null if that does not exist (yet).
      Since:
      3.7.0