Class DefaultHostDescription

    • Constructor Detail

      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      HostLocation location,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        location - host location
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      HostLocation location,
                                      IpAddress ip,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        location - host location
        ip - host IP address
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      HostLocation location,
                                      java.util.Set<IpAddress> ip,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        location - host location
        ip - host IP addresses
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      HostLocation location,
                                      boolean configured,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        location - host location
        configured - true if configured via NetworkConfiguration
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      HostLocation location,
                                      java.util.Set<IpAddress> ip,
                                      boolean configured,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        location - host location
        ip - host IP address
        configured - true if configured via NetworkConfiguration
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      java.util.Set<HostLocation> locations,
                                      java.util.Set<IpAddress> ip,
                                      boolean configured,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        locations - host locations
        ip - host IP address
        configured - true if configured via NetworkConfiguration
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      java.util.Set<HostLocation> locations,
                                      java.util.Set<IpAddress> ip,
                                      VlanId innerVlan,
                                      EthType tpid,
                                      boolean configured,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        locations - host locations
        ip - host IP address
        innerVlan - host inner VLAN identifier
        tpid - outer TPID of a host
        configured - true if configured via NetworkConfiguration
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(MacAddress mac,
                                      VlanId vlan,
                                      java.util.Set<HostLocation> locations,
                                      java.util.Set<HostLocation> auxLocations,
                                      java.util.Set<IpAddress> ip,
                                      VlanId innerVlan,
                                      EthType tpid,
                                      boolean configured,
                                      SparseAnnotations... annotations)
        Creates a host description using the supplied information.
        Parameters:
        mac - host MAC address
        vlan - host VLAN identifier
        locations - host locations
        auxLocations - set of auxiliary locations, or null if unspecified
        ip - host IP address
        innerVlan - host inner VLAN identifier
        tpid - outer TPID of a host
        configured - true if configured via NetworkConfiguration
        annotations - optional key/value annotations map
      • DefaultHostDescription

        public DefaultHostDescription​(HostDescription base,
                                      SparseAnnotations annotations)
        Creates a host description using the supplied information.
        Parameters:
        base - HostDescription to basic information
        annotations - Annotations to use.
    • Method Detail

      • copyReplacingAnnotation

        public static DefaultHostDescription copyReplacingAnnotation​(HostDescription base,
                                                                     SparseAnnotations annotations)
        Creates a host description using the supplied information.
        Parameters:
        base - base
        annotations - annotations
        Returns:
        host description
      • hwAddress

        public MacAddress hwAddress()
        Description copied from interface: HostDescription
        Returns the MAC address associated with this host (NIC).
        Specified by:
        hwAddress in interface HostDescription
        Returns:
        the MAC address of this host
      • vlan

        public VlanId vlan()
        Description copied from interface: HostDescription
        Returns the VLAN associated with this host.
        Specified by:
        vlan in interface HostDescription
        Returns:
        the VLAN ID value
      • location

        public HostLocation location()
        Description copied from interface: HostDescription
        Returns the most recent location of the host on the network edge.
        Specified by:
        location in interface HostDescription
        Returns:
        the most recent host location
      • auxLocations

        public java.util.Set<HostLocation> auxLocations()
        Description copied from interface: HostDescription
        Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.
        Specified by:
        auxLocations in interface HostDescription
        Returns:
        auxiliary locations, or null if unspecified
      • ipAddress

        public java.util.Set<IpAddress> ipAddress()
        Description copied from interface: HostDescription
        Returns the IP address associated with this host's MAC.
        Specified by:
        ipAddress in interface HostDescription
        Returns:
        host IP address
      • configured

        public boolean configured()
        Description copied from interface: HostDescription
        Returns true if configured by NetworkConfiguration.
        Specified by:
        configured in interface HostDescription
        Returns:
        configured/learnt dynamically
      • innerVlan

        public VlanId innerVlan()
        Description copied from interface: HostDescription
        Returns the inner VLAN associated with this host.
        Specified by:
        innerVlan in interface HostDescription
        Returns:
        VLAN ID value; VlanId.NONE if only one VLAN ID is associated with this host
      • tpid

        public EthType tpid()
        Description copied from interface: HostDescription
        Returns the TPID of the outermost VLAN associated with this host.
        Specified by:
        tpid in interface HostDescription
        Returns:
        TPID of the outermost VLAN header
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object