Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.net.driver; |
| 17 | |
| 18 | /** |
| 19 | * Representation of context for interacting with a device. |
| 20 | */ |
| 21 | public interface DriverHandler { |
| 22 | |
| 23 | /** |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 24 | * Returns the parent device driver. |
| 25 | * |
| 26 | * @return device driver |
| 27 | */ |
| 28 | Driver driver(); |
| 29 | |
| 30 | /** |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 31 | * Returns the device driver data. |
| 32 | * |
| 33 | * @return device driver data |
| 34 | */ |
| 35 | DriverData data(); |
| 36 | |
| 37 | /** |
| 38 | * Returns the specified facet of behaviour to interact with the device. |
| 39 | * |
| 40 | * @param behaviourClass behaviour class |
| 41 | * @param <T> type of behaviour |
| 42 | * @return behaviour |
| 43 | */ |
| 44 | <T extends Behaviour> T behaviour(Class<T> behaviourClass); |
| 45 | |
Thomas Vachuska | d5d113b | 2015-07-10 12:12:01 -0700 | [diff] [blame] | 46 | /** |
HIGUCHI Yuta | 82b3c11 | 2016-01-07 22:22:26 -0800 | [diff] [blame] | 47 | * Indicates whether or not the driver, or any of its parents, support |
| 48 | * the specified class of behaviour. |
| 49 | * |
| 50 | * @param behaviourClass behaviour class |
| 51 | * @return true if behaviour is supported |
| 52 | */ |
| 53 | default boolean hasBehaviour(Class<? extends Behaviour> behaviourClass) { |
| 54 | return driver().hasBehaviour(behaviourClass); |
| 55 | } |
| 56 | |
| 57 | /** |
Thomas Vachuska | d5d113b | 2015-07-10 12:12:01 -0700 | [diff] [blame] | 58 | * Returns the reference to the implementation of the specified service. |
| 59 | * Provides access to run-time context. |
| 60 | * |
| 61 | * @param serviceClass service class |
| 62 | * @param <T> type of service |
| 63 | * @return service implementation |
| 64 | * @throws org.onlab.osgi.ServiceNotFoundException if service is unavailable |
| 65 | */ |
| 66 | <T> T get(Class<T> serviceClass); |
| 67 | |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 68 | } |