Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [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.iptopology.api.device; |
| 17 | |
| 18 | import org.onosproject.net.DeviceId; |
| 19 | import org.onosproject.net.provider.ProviderService; |
| 20 | |
| 21 | import java.util.List; |
| 22 | |
| 23 | /** |
| 24 | * Service through which ip device providers can inject ip device information into |
| 25 | * the core. |
| 26 | */ |
| 27 | public interface IpDeviceProviderService extends ProviderService<IpDeviceProvider> { |
| 28 | |
| 29 | /** |
| 30 | * Signals the core that an ip device is added or updated with IP topology information. |
| 31 | * |
| 32 | * @param deviceId device identifier |
| 33 | * @param deviceDescription information about network ip device |
| 34 | */ |
| 35 | void addOrUpdateIpDevice(DeviceId deviceId, IpDeviceDescription deviceDescription); |
| 36 | |
| 37 | /** |
| 38 | * Signals the core that an ip device is removed. |
| 39 | * |
| 40 | * @param deviceId identity of the ip device to be removed |
| 41 | */ |
| 42 | void removeIpDevice(DeviceId deviceId); |
| 43 | |
| 44 | /** |
| 45 | * Sends information about all interfaces of a device. It is up to the core to |
| 46 | * determine what has changed. |
| 47 | * |
| 48 | * @param deviceId identity of the ip device |
| 49 | * @param interfaceDescriptions list of device interfaces |
| 50 | */ |
| 51 | void updateInterfaces(DeviceId deviceId, List<InterfaceDescription> interfaceDescriptions); |
| 52 | |
| 53 | /** |
| 54 | * signals interfaces of a device is deleted. |
| 55 | * |
| 56 | * @param deviceId identity of the ip device |
| 57 | * @param interfaceDescriptions list of device interfaces |
| 58 | */ |
| 59 | void removeInterfaces(DeviceId deviceId, List<InterfaceDescription> interfaceDescriptions); |
| 60 | |
| 61 | /** |
| 62 | * Sends information about all ip prefix of a device. It is up to the core to |
| 63 | * determine what has changed. |
| 64 | * |
| 65 | * @param deviceId identity of the ip device |
| 66 | * @param prefixDescriptions list of device ip prefixes |
| 67 | */ |
| 68 | void updatePrefixes(DeviceId deviceId, List<PrefixDescription> prefixDescriptions); |
| 69 | |
| 70 | /** |
| 71 | * signals ip prefix of a device is deleted. |
| 72 | * |
| 73 | * @param deviceId identity of the ip device |
| 74 | * @param prefixDescriptions list of device ip prefixes |
| 75 | */ |
| 76 | void removePrefixes(DeviceId deviceId, List<PrefixDescription> prefixDescriptions); |
| 77 | |
| 78 | } |