Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.device; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
| 19 | import org.onosproject.net.MastershipRole; |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 20 | import org.onosproject.net.PortNumber; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 21 | import org.onosproject.net.provider.Provider; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 22 | |
pierventre | 1db25f0 | 2022-02-03 21:34:04 +0100 | [diff] [blame] | 23 | import java.util.concurrent.CompletableFuture; |
| 24 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 25 | /** |
| 26 | * Abstraction of a device information provider. |
| 27 | */ |
| 28 | public interface DeviceProvider extends Provider { |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 29 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 30 | /** |
| 31 | * Triggers an asynchronous probe of the specified device, intended to |
Ayaka Koshibe | e8708e3 | 2014-10-22 13:40:18 -0700 | [diff] [blame] | 32 | * determine whether the device is present or not. An indirect result of this |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 33 | * should be invocation of |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 34 | * {@link org.onosproject.net.device.DeviceProviderService#deviceConnected} )} or |
| 35 | * {@link org.onosproject.net.device.DeviceProviderService#deviceDisconnected} |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 36 | * at some later point in time. |
| 37 | * |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 38 | * @param deviceId ID of device to be probed |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 39 | */ |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 40 | void triggerProbe(DeviceId deviceId); |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Notifies the provider of a mastership role change for the specified |
| 44 | * device as decided by the core. |
| 45 | * |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 46 | * @param deviceId device identifier |
| 47 | * @param newRole newly determined mastership role |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 48 | */ |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 49 | void roleChanged(DeviceId deviceId, MastershipRole newRole); |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 50 | |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 51 | /** |
| 52 | * Checks the reachability (connectivity) of a device from this provider. |
Aaron Kruglikov | 8e0a08a | 2016-06-21 14:31:03 -0700 | [diff] [blame] | 53 | * Reachability, unlike availability, denotes whether THIS particular node |
| 54 | * can send messages and receive replies from the specified device. |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 55 | * <p> |
| 56 | * Implementations are encouraged to check for reachability by using only |
| 57 | * internal provider state, i.e., without blocking execution. |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 58 | * |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 59 | * @param deviceId device identifier |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 60 | * @return true if reachable, false otherwise |
| 61 | */ |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 62 | boolean isReachable(DeviceId deviceId); |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 63 | |
| 64 | /** |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 65 | * Checks the availability of the device from the provider perspective. |
| 66 | * Availability denotes whether the device is reachable by |
| 67 | * this node and able to perform its functions as expected (e.g., forward |
| 68 | * traffic). |
| 69 | * |
| 70 | * <p> |
| 71 | * Implementations are encouraged to check for availability by using only |
| 72 | * internal provider state, i.e., without blocking execution. |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 73 | * |
| 74 | * @param deviceId device identifier |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 75 | * @return completable future eventually true if available, false otherwise |
| 76 | */ |
| 77 | default boolean isAvailable(DeviceId deviceId) { |
| 78 | // For most implementations such as OpenFlow, reachability is equivalent |
| 79 | // to availability. |
| 80 | return isReachable(deviceId); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Administratively enables or disables a port. |
| 85 | * |
| 86 | * @param deviceId device identifier |
sangyun-han | b885ed0 | 2016-10-13 15:49:43 +0900 | [diff] [blame] | 87 | * @param portNumber port number |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 88 | * @param enable true if port is to be enabled, false to disable |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 89 | */ |
| 90 | void changePortState(DeviceId deviceId, PortNumber portNumber, |
| 91 | boolean enable); |
Thomas Vachuska | 5b38dc0 | 2018-05-10 15:24:40 -0700 | [diff] [blame] | 92 | |
| 93 | |
| 94 | /** |
| 95 | * Administratively triggers 'disconnection' from the device. This is meant |
| 96 | * purely in logical sense and is intended to apply equally to implementations |
| 97 | * relying on connectionless control protocols. |
| 98 | * |
| 99 | * An indirect result of this should be invocation of |
| 100 | * {@link org.onosproject.net.device.DeviceProviderService#deviceDisconnected} |
| 101 | * if the device was presently 'connected' and |
| 102 | * {@link org.onosproject.net.device.DeviceProviderService#deviceConnected} |
| 103 | * at some later point in time if the device is available and continues to |
| 104 | * be permitted to reconnect or if the provider continues to discover it. |
| 105 | * |
| 106 | * @param deviceId device identifier |
| 107 | */ |
| 108 | default void triggerDisconnect(DeviceId deviceId) { |
| 109 | throw new UnsupportedOperationException(id() + " does not implement this feature"); |
| 110 | } |
| 111 | |
pierventre | 1db25f0 | 2022-02-03 21:34:04 +0100 | [diff] [blame] | 112 | /** |
| 113 | * Probe the reachability of the device from the provider perspective. |
| 114 | * <p> |
| 115 | * Implementations are encouraged to provide an async implementation. |
| 116 | * With the respect of triggerProbe, this method returns whether or |
| 117 | * not was possible to send a message to the device from this instance. |
| 118 | * Instead, isReachable asses only the capability to send a message from |
| 119 | * this node but does not imply sending a message to the device. |
| 120 | * |
| 121 | * @param deviceId device identifier |
| 122 | * @return completable future eventually true if reachable, false otherwise |
| 123 | */ |
| 124 | default CompletableFuture<Boolean> probeReachability(DeviceId deviceId) { |
| 125 | return CompletableFuture.completedFuture(isReachable(deviceId)); |
| 126 | } |
| 127 | |
pierventre | 47ffb95 | 2022-02-18 05:16:48 -0800 | [diff] [blame] | 128 | /** |
| 129 | * Return the grace period of this provider in milliseconds. With some devices, it might be |
| 130 | * required more time to establish a working channel. This method returns a grace period |
| 131 | * that should be respected before checking the reachability with the device. |
| 132 | * |
| 133 | * @return the grace period of the device. 0 if the device is expected to be immediately functional |
| 134 | */ |
| 135 | default int gracePeriod() { |
| 136 | return 0; |
| 137 | } |
| 138 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 139 | } |