org.onosproject.net.driver

Interface DriverService

All Superinterfaces:

DriverResolver

All Known Subinterfaces:

DriverAdminService

public interface DriverService
extends DriverResolver

Service for obtaining drivers and driver behaviour implementations.

Method Summary

Modifier and Type	Method and Description
DriverHandler	createHandler(DeviceId deviceId, String... credentials) Creates a new driver handler for interacting with the specified device.
Driver	getDriver(DeviceId deviceId) Returns the driver for the specified device.
Driver	getDriver(String mfr, String hw, String sw) Returns the driver that matches the specified primordial device discovery information.
Set<Driver>	getDrivers() Returns the overall set of drivers being provided.
Set<Driver>	getDrivers(Class<? extends Behaviour> withBehaviour) Returns the set of drivers which support the specified behaviour.

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

getDriver

Method Detail

getDrivers

Set<Driver> getDrivers()

Returns the overall set of drivers being provided.

Returns:

provided drivers

getDrivers

Set<Driver> getDrivers(Class<? extends Behaviour> withBehaviour)

Returns the set of drivers which support the specified behaviour.

Parameters:

withBehaviour - behaviour class to query by

Returns:

provided drivers

getDriver

Driver getDriver(String mfr,
                 String hw,
                 String sw)

Returns the driver that matches the specified primordial device discovery information.

Parameters:

mfr - device manufacturer

hw - device hardware name/version

sw - device software version

Returns:

driver or null of no matching one is found

getDriver

Driver getDriver(DeviceId deviceId)

Returns the driver for the specified device. If the device carries driver annotation, its value is used to look-up the driver. Otherwise, the device manufacturer, hardware and software version attributes are used to look-up the driver. First using their literal values and if no driver is found, using ERE matching against the driver manufacturer, hardware and software version fields.

Parameters:

deviceId - device identifier

Returns:

driver or null of no matching one is found

Throws:

org.onlab.util.ItemNotFoundException - if device or driver for it are not found

createHandler

DriverHandler createHandler(DeviceId deviceId,
                            String... credentials)

Creates a new driver handler for interacting with the specified device. The driver is looked-up using the same semantics as getDriver(DeviceId) method.

Parameters:

deviceId - device identifier

credentials - optional login credentials in string form

Returns:

driver handler

Throws:

org.onlab.util.ItemNotFoundException - if device or driver for it are not found