Package org.onosproject.net

Class DefaultHost

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.net.AbstractModel

org.onosproject.net.AbstractProjectableModel

org.onosproject.net.AbstractElement

org.onosproject.net.DefaultHost

All Implemented Interfaces:

Annotated, Projectable, Element, Host, Provided

public class DefaultHost
extends AbstractElement
implements Host

A basic implementation of a Host.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.AbstractProjectableModel

AbstractProjectableModel.AnnotationDriverData

Field Summary

Fields inherited from class org.onosproject.net.AbstractElement

id

Fields inherited from class org.onosproject.net.AbstractProjectableModel

NO_DRIVER, NO_DRIVER_SERVICE

Constructor Summary

Constructors

Constructor	Description
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, Set<HostLocation> locations, Set<IpAddress> ips, boolean configured, Annotations... annotations)	Creates an end-station host using the supplied information.
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, Set<HostLocation> locations, Set<IpAddress> ips, VlanId innerVlan, EthType tpid, boolean configured, boolean suspended, Annotations... annotations)	Creates an end-station host using the supplied information.
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, Set<HostLocation> locations, Set<IpAddress> ips, VlanId innerVlan, EthType tpid, boolean configured, Annotations... annotations)	Creates an end-station host using the supplied information.
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, Set<HostLocation> locations, Set<HostLocation> auxLocations, Set<IpAddress> ips, VlanId innerVlan, EthType tpid, boolean configured, boolean suspended, Annotations... annotations)	Creates an end-station host using the supplied information.
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, HostLocation location, Set<IpAddress> ips, boolean configured, Annotations... annotations)	Creates an end-station host using the supplied information.
DefaultHost(ProviderId providerId, HostId id, MacAddress mac, VlanId vlan, HostLocation location, Set<IpAddress> ips, Annotations... annotations)	Creates an end-station host using the supplied information.

Method Summary

Modifier and Type	Method	Description
Set<HostLocation>	auxLocations()	Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.
boolean	configured()	Returns true if configured by NetworkConfiguration.
boolean	equals(Object obj)
int	hashCode()
HostId	id()	Host identification.
VlanId	innerVlan()	Returns the inner VLAN ID tied to this host.
Set<IpAddress>	ipAddresses()	Returns an unmodifiable set of IP addresses currently bound to the host MAC address.
HostLocation	location()	Returns the most recent host location where the host attaches to the network edge.
Set<HostLocation>	locations()	Returns host locations where the host attaches to the network edge.
MacAddress	mac()	Returns the host MAC address.
boolean	suspended()	Returns the state of host whether it is in suspended state(offending host due to frequent movement.).
String	toString()
EthType	tpid()	Returns the TPID of the outermost VLAN associated with this host.
VlanId	vlan()	Returns the VLAN ID tied to this host.

Methods inherited from class org.onosproject.net.AbstractProjectableModel

as, asData, bindAndCheckDriver, bindDriver, driver, driverService, is, locateDriver, setDriverService

Methods inherited from class org.onosproject.net.AbstractModel

providerId

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.driver.Projectable

as, is, project

Methods inherited from interface org.onosproject.net.Provided

providerId

Constructor Detail

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   HostLocation location,
                   Set<IpAddress> ips,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

location - host location

ips - host IP addresses

annotations - optional key/value annotations

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   HostLocation location,
                   Set<IpAddress> ips,
                   boolean configured,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

location - host location

ips - host IP addresses

configured - true if configured via NetworkConfiguration

annotations - optional key/value annotations

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   Set<HostLocation> locations,
                   Set<IpAddress> ips,
                   boolean configured,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

locations - set of host locations

ips - host IP addresses

configured - true if configured via NetworkConfiguration

annotations - optional key/value annotations

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   Set<HostLocation> locations,
                   Set<IpAddress> ips,
                   VlanId innerVlan,
                   EthType tpid,
                   boolean configured,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

locations - set of host locations

ips - host IP addresses

innerVlan - host inner VLAN identifier

tpid - outer TPID of a host

configured - true if configured via NetworkConfiguration

annotations - optional key/value annotations

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   Set<HostLocation> locations,
                   Set<IpAddress> ips,
                   VlanId innerVlan,
                   EthType tpid,
                   boolean configured,
                   boolean suspended,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

locations - set of host locations

ips - host IP addresses

configured - true if configured via NetworkConfiguration

innerVlan - host inner VLAN identifier

tpid - outer TPID of a host

suspended - true if the host is suspended due to policy violation.

annotations - optional key/value annotations

DefaultHost

public DefaultHost(ProviderId providerId,
                   HostId id,
                   MacAddress mac,
                   VlanId vlan,
                   Set<HostLocation> locations,
                   Set<HostLocation> auxLocations,
                   Set<IpAddress> ips,
                   VlanId innerVlan,
                   EthType tpid,
                   boolean configured,
                   boolean suspended,
                   Annotations... annotations)

Creates an end-station host using the supplied information.

Parameters:

providerId - provider identity

id - host identifier

mac - host MAC address

vlan - host VLAN identifier

locations - set of host locations

auxLocations - set of auxiliary locations, or null if unspecified

ips - host IP addresses

configured - true if configured via NetworkConfiguration

innerVlan - host inner VLAN identifier

tpid - outer TPID of a host

suspended - true if the host is suspended due to policy violation.

annotations - optional key/value annotations

Method Detail

id

public HostId id()

Description copied from interface: Host

Host identification.

Specified by:

id in interface Element

Specified by:

id in interface Host

Returns:

host id

mac

public MacAddress mac()

Description copied from interface: Host

Returns the host MAC address.

Specified by:

mac in interface Host

Returns:

mac address

ipAddresses

public Set<IpAddress> ipAddresses()

Returns an unmodifiable set of IP addresses currently bound to the host MAC address.

Specified by:

ipAddresses in interface Host

Returns:

set of IP addresses; empty if no IP address is bound

location

public HostLocation location()

Description copied from interface: Host

Returns the most recent host location where the host attaches to the network edge.

Specified by:

location in interface Host

Returns:

the most recent host location

locations

public Set<HostLocation> locations()

Description copied from interface: Host

Returns host locations where the host attaches to the network edge.

Specified by:

locations in interface Host

Returns:

host locations

auxLocations

public Set<HostLocation> auxLocations()

Description copied from interface: Host

Returns host auxiliary locations, which could be useful for app operations in addition to the attach points.

Specified by:

auxLocations in interface Host

Returns:

auxiliary locations, or null if unspecified

vlan

public VlanId vlan()

Description copied from interface: Host

Returns the VLAN ID tied to this host.

Specified by:

vlan in interface Host

Returns:

VLAN ID value

innerVlan

public VlanId innerVlan()

Description copied from interface: Host

Returns the inner VLAN ID tied to this host.

Specified by:

innerVlan in interface Host

Returns:

VLAN ID value; VlanId.NONE if only one VLAN ID is tied to this host

tpid

public EthType tpid()

Description copied from interface: Host

Returns the TPID of the outermost VLAN associated with this host.

Specified by:

tpid in interface Host

Returns:

TPID of the outermost VLAN header

configured

public boolean configured()

Description copied from interface: Host

Returns true if configured by NetworkConfiguration.

Specified by:

configured in interface Host

Returns:

configured/learnt dynamically

suspended

public boolean suspended()

Description copied from interface: Host

Returns the state of host whether it is in suspended state(offending host due to frequent movement.).

Specified by:

suspended in interface Host

Returns:

state true if suspended else false.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object