Package org.onosproject.net.driver

Interface DriverService

    • Method Detail

      • getDrivers

        java.util.Set<Driver> getDrivers()
        Returns the overall set of drivers being provided.
        Specified by:
        getDrivers in interface DriverRegistry
        Returns:
        provided drivers

      • getDrivers

        java.util.Set<Driver> getDrivers​(java.lang.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​(DeviceId deviceId)
        Returns the driver for the specified device. If the network configuration for the specified device carries the driver property or if the device carries the driver annotation, they will be used to look-up the driver, in respective order. 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:
        ItemNotFoundException - if device or driver for it are not found

      • getDeviceDrivers

        java.util.Map<DeviceId,​java.lang.String> getDeviceDrivers()
        Returns a map between all devices and their driver names.
        Returns:
        map of (device id, driver name)

      • createHandler

        DriverHandler createHandler​(DeviceId deviceId,
                            java.lang.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:
        ItemNotFoundException - if device or driver for it are not found