Aihua Guo | 1ce2dd1 | 2016-08-12 23:37:44 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 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.tetopology.management.api; |
| 17 | |
| 18 | import org.onosproject.net.provider.Provider; |
| 19 | |
| 20 | /** |
| 21 | * Abstraction of an IETF network provider. |
| 22 | * APIs for Manager to signal Provider. |
| 23 | */ |
| 24 | public interface TeTopologyProvider extends Provider { |
| 25 | |
| 26 | /** |
| 27 | * TODO: |
| 28 | * |
| 29 | * Signals provider that abstract networks/network/link/node has been created/updated/deleted. |
| 30 | * It's used by producers. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | // TODO: Need to look at the following functions are required for TE Nodes |
| 35 | |
| 36 | // TODO: consider how dirty the triggerProbe gets; if it costs too much, let's drop it |
| 37 | |
| 38 | /** |
| 39 | * Triggers an asynchronous probe of the specified device, intended to |
| 40 | * determine whether the device is present or not. An indirect result of this |
| 41 | * should be invocation of |
| 42 | * {@link org.onosproject.net.device.DeviceProviderService#deviceConnected} )} or |
| 43 | * {@link org.onosproject.net.device.DeviceProviderService#deviceDisconnected} |
| 44 | * at some later point in time. |
| 45 | * |
| 46 | * @param deviceId ID of device to be probed |
| 47 | */ |
| 48 | //void triggerProbe(DeviceId deviceId); |
| 49 | |
| 50 | /** |
| 51 | * Notifies the provider of a mastership role change for the specified |
| 52 | * device as decided by the core. |
| 53 | * |
| 54 | * @param deviceId device identifier |
| 55 | * @param newRole newly determined mastership role |
| 56 | */ |
| 57 | //void roleChanged(DeviceId deviceId, MastershipRole newRole); |
| 58 | |
| 59 | /** |
| 60 | * Checks the reachability (connectivity) of a device from this provider. |
| 61 | * |
| 62 | * @param deviceId device identifier |
| 63 | * @return true if reachable, false otherwise |
| 64 | */ |
| 65 | //boolean isReachable(DeviceId deviceId); |
| 66 | |
| 67 | } |