org.onosproject.net.device

Interface DeviceService

public interface DeviceService

Service for interacting with the inventory of infrastructure devices.

Method Summary

Modifier and Type	Method and Description
void	addListener(DeviceListener listener) Adds the specified device listener.
Iterable<Device>	getAvailableDevices() Returns an iterable collection of all devices currently available to the system.
Device	getDevice(DeviceId deviceId) Returns the device with the specified identifier.
int	getDeviceCount() Returns the number of infrastructure devices known to the system.
Iterable<Device>	getDevices() Returns a collection of the currently known infrastructure devices.
Port	getPort(DeviceId deviceId, PortNumber portNumber) Returns the port with the specified number and hosted by the given device.
List<Port>	getPorts(DeviceId deviceId) Returns the list of ports associated with the device.
MastershipRole	getRole(DeviceId deviceId) Returns the current mastership role for the specified device.
boolean	isAvailable(DeviceId deviceId) Indicates whether or not the device is presently online and available.
void	removeListener(DeviceListener listener) Removes the specified device listener.

Method Detail

getDeviceCount

int getDeviceCount()

Returns the number of infrastructure devices known to the system.

Returns:

number of infrastructure devices

getDevices

Iterable<Device> getDevices()

Returns a collection of the currently known infrastructure devices.

Returns:

collection of devices

getAvailableDevices

Iterable<Device> getAvailableDevices()

Returns an iterable collection of all devices currently available to the system.

Returns:

device collection

getDevice

Device getDevice(DeviceId deviceId)

Returns the device with the specified identifier.

Parameters:

deviceId - device identifier

Returns:

device or null if one with the given identifier is not known

getRole

MastershipRole getRole(DeviceId deviceId)

Returns the current mastership role for the specified device.

Parameters:

deviceId - device identifier

Returns:

designated mastership role

getPorts

List<Port> getPorts(DeviceId deviceId)

Returns the list of ports associated with the device.

Parameters:

deviceId - device identifier

Returns:

list of ports

getPort

Port getPort(DeviceId deviceId,
             PortNumber portNumber)

Returns the port with the specified number and hosted by the given device.

Parameters:

deviceId - device identifier

portNumber - port number

Returns:

device port

isAvailable

boolean isAvailable(DeviceId deviceId)

Indicates whether or not the device is presently online and available.

Parameters:

deviceId - device identifier

Returns:

true if the device is available

addListener

void addListener(DeviceListener listener)

Adds the specified device listener.

Parameters:

listener - device listener

removeListener

void removeListener(DeviceListener listener)

Removes the specified device listener.

Parameters:

listener - device listener