org.onosproject.net.host

Interface HostStore

All Superinterfaces:

Store<HostEvent,HostStoreDelegate>

public interface HostStore
extends Store<HostEvent,HostStoreDelegate>

Manages inventory of end-station hosts; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
void	clearAddressBindings(ConnectPoint connectPoint) Removes any previously stored address information for a given connection point.
HostEvent	createOrUpdateHost(ProviderId providerId, HostId hostId, HostDescription hostDescription) Creates a new host or updates the existing one based on the specified description.
Set<PortAddresses>	getAddressBindings() Returns the address bindings stored for all connection points.
Set<PortAddresses>	getAddressBindingsForPort(ConnectPoint connectPoint) Returns the address bindings for a particular connection point.
Set<Host>	getConnectedHosts(ConnectPoint connectPoint) Returns the set of hosts whose location falls on the given connection point.
Set<Host>	getConnectedHosts(DeviceId deviceId) Returns the set of hosts whose location falls on the given device.
Host	getHost(HostId hostId) Returns the host with the specified identifer.
int	getHostCount() Returns the number of hosts in the store.
Iterable<Host>	getHosts() Returns a collection of all hosts in the store.
Set<Host>	getHosts(org.onlab.packet.IpAddress ip) Returns the set of hosts with the specified IP address.
Set<Host>	getHosts(org.onlab.packet.MacAddress mac) Returns the set of hosts with the specified MAC address.
Set<Host>	getHosts(org.onlab.packet.VlanId vlanId) Returns the set of all hosts within the specified VLAN.
void	removeAddressBindings(PortAddresses addresses) Removes the given addresses from the set of address information held for a port.
HostEvent	removeHost(HostId hostId) Removes the specified host from the inventory.
void	updateAddressBindings(PortAddresses addresses) Updates the address information for a given port.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

createOrUpdateHost

HostEvent createOrUpdateHost(ProviderId providerId,
                             HostId hostId,
                             HostDescription hostDescription)

Creates a new host or updates the existing one based on the specified description.

Parameters:

providerId - provider identification

hostId - host identification

hostDescription - host description data

Returns:

appropriate event or null if no change resulted

removeHost

HostEvent removeHost(HostId hostId)

Removes the specified host from the inventory.

Parameters:

hostId - host identification

Returns:

remove event or null if host was not found

getHostCount

int getHostCount()

Returns the number of hosts in the store.

Returns:

host count

getHosts

Iterable<Host> getHosts()

Returns a collection of all hosts in the store.

Returns:

iterable collection of all hosts

getHost

Host getHost(HostId hostId)

Returns the host with the specified identifer.

Parameters:

hostId - host identification

Returns:

host or null if not found

getHosts

Set<Host> getHosts(org.onlab.packet.VlanId vlanId)

Returns the set of all hosts within the specified VLAN.

Parameters:

vlanId - vlan id

Returns:

set of hosts in the vlan

getHosts

Set<Host> getHosts(org.onlab.packet.MacAddress mac)

Returns the set of hosts with the specified MAC address.

Parameters:

mac - mac address

Returns:

set of hosts with the given mac

getHosts

Set<Host> getHosts(org.onlab.packet.IpAddress ip)

Returns the set of hosts with the specified IP address.

Parameters:

ip - ip address

Returns:

set of hosts with the given IP

getConnectedHosts

Set<Host> getConnectedHosts(ConnectPoint connectPoint)

Returns the set of hosts whose location falls on the given connection point.

Parameters:

connectPoint - connection point

Returns:

set of hosts

getConnectedHosts

Set<Host> getConnectedHosts(DeviceId deviceId)

Returns the set of hosts whose location falls on the given device.

Parameters:

deviceId - infrastructure device identifier

Returns:

set of hosts

updateAddressBindings

void updateAddressBindings(PortAddresses addresses)

Updates the address information for a given port. The given address information is added to any previously held information for the port.

Parameters:

addresses - the port and address information

removeAddressBindings

void removeAddressBindings(PortAddresses addresses)

Removes the given addresses from the set of address information held for a port.

Parameters:

addresses - the port and address information

clearAddressBindings

void clearAddressBindings(ConnectPoint connectPoint)

Removes any previously stored address information for a given connection point.

Parameters:

connectPoint - the connection point

getAddressBindings

Set<PortAddresses> getAddressBindings()

Returns the address bindings stored for all connection points.

Returns:

the set of address bindings

getAddressBindingsForPort

Set<PortAddresses> getAddressBindingsForPort(ConnectPoint connectPoint)

Returns the address bindings for a particular connection point.

Parameters:

connectPoint - the connection point to return address information for

Returns:

address information for the connection point