Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0947d7e | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -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 | */ |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 16 | package org.onosproject.segmentrouting.config; |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 17 | |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
Pier Ventre | b6a7f34 | 2016-11-26 21:05:22 -0800 | [diff] [blame] | 19 | import org.onlab.packet.IpPrefix; |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 20 | import org.onlab.packet.MacAddress; |
| 21 | import org.onosproject.net.DeviceId; |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 22 | import org.onosproject.net.PortNumber; |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 23 | |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 24 | import java.util.List; |
| 25 | import java.util.Map; |
| 26 | |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Mechanism through which group handler module retrieves |
| 29 | * the device specific attributes such as segment ID, |
| 30 | * Mac address...etc from group handler applications. |
| 31 | */ |
| 32 | public interface DeviceProperties { |
| 33 | /** |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 34 | * Checks if the device is configured. |
| 35 | * |
| 36 | * @param deviceId device identifier |
| 37 | * @return true if the device is configured |
| 38 | */ |
| 39 | boolean isConfigured(DeviceId deviceId); |
| 40 | |
| 41 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 42 | * Returns the IPv4 segment id of a device to be used in group creation. |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 43 | * |
| 44 | * @param deviceId device identifier |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 45 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 46 | * @return segment id of a device |
| 47 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 48 | int getIPv4SegmentId(DeviceId deviceId) throws DeviceConfigNotFoundException; |
| 49 | |
| 50 | /** |
| 51 | * Returns the IPv6 segment id of a device to be used in group creation. |
| 52 | * |
| 53 | * @param deviceId device identifier |
| 54 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
| 55 | * @return segment id of a device |
| 56 | */ |
| 57 | int getIPv6SegmentId(DeviceId deviceId) throws DeviceConfigNotFoundException; |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 58 | |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 59 | /** |
| 60 | * Returns the Mac address of a device to be used in group creation. |
| 61 | * |
| 62 | * @param deviceId device identifier |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 63 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 64 | * @return mac address of a device |
| 65 | */ |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 66 | MacAddress getDeviceMac(DeviceId deviceId) throws DeviceConfigNotFoundException; |
| 67 | |
| 68 | /** |
Andreas Pantelopoulos | 5e7be3d | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 69 | * |
| 70 | * @param deviceId device identifier |
| 71 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
| 72 | * @return the pseudowire routing label for a leaf node |
| 73 | */ |
| 74 | int getPWRoutingLabel(DeviceId deviceId) throws DeviceConfigNotFoundException; |
| 75 | |
| 76 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 77 | * Returns the router ipv4 address of a segment router. |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 78 | * |
| 79 | * @param deviceId device identifier |
| 80 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
| 81 | * @return router ip address |
| 82 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame] | 83 | IpAddress getRouterIpv4(DeviceId deviceId) throws DeviceConfigNotFoundException; |
| 84 | |
| 85 | /** |
| 86 | * Returns the router ipv6 address of a segment router. |
| 87 | * |
| 88 | * @param deviceId device identifier |
| 89 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
| 90 | * @return router ip address |
| 91 | */ |
| 92 | IpAddress getRouterIpv6(DeviceId deviceId) throws DeviceConfigNotFoundException; |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 93 | |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 94 | /** |
| 95 | * Indicates whether a device is edge device or transit/core device. |
| 96 | * |
| 97 | * @param deviceId device identifier |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 98 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 99 | * @return boolean |
| 100 | */ |
Charles Chan | 319d1a2 | 2015-11-03 10:42:14 -0800 | [diff] [blame] | 101 | boolean isEdgeDevice(DeviceId deviceId) throws DeviceConfigNotFoundException; |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 102 | |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 103 | /** |
pierventre | 30368ab | 2021-02-24 23:23:22 +0100 | [diff] [blame] | 104 | * Returns a list of edge devices. |
| 105 | * |
| 106 | * @return list of the edge device ids |
| 107 | */ |
| 108 | List<DeviceId> getEdgeDeviceIds(); |
| 109 | |
| 110 | /** |
Charles Chan | a240145 | 2021-06-03 15:57:48 -0700 | [diff] [blame] | 111 | * Returns a list of infra devices. |
| 112 | * |
| 113 | * @return list of the infra device ids |
| 114 | */ |
| 115 | List<DeviceId> getInfraDeviceIds(); |
| 116 | |
| 117 | /** |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 118 | * Returns all segment IDs to be considered in building auto |
| 119 | * |
| 120 | * created groups. |
| 121 | * @return list of segment IDs |
| 122 | */ |
| 123 | List<Integer> getAllDeviceSegmentIds(); |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 124 | |
| 125 | /** |
| 126 | * Returns subnet-to-ports mapping of given device. |
| 127 | * |
| 128 | * For each entry of the map |
| 129 | * Key: a subnet |
| 130 | * Value: a list of ports, which are bound to the subnet |
| 131 | * |
| 132 | * @param deviceId device identifier |
Ray Milkey | 2aa9338 | 2016-04-05 17:39:44 -0700 | [diff] [blame] | 133 | * @throws DeviceConfigNotFoundException if the device configuration is not found |
Charles Chan | 7727767 | 2015-10-20 16:24:19 -0700 | [diff] [blame] | 134 | * @return a map that contains all subnet-to-ports mapping of given device |
| 135 | */ |
Pier Ventre | b6a7f34 | 2016-11-26 21:05:22 -0800 | [diff] [blame] | 136 | Map<IpPrefix, List<PortNumber>> getSubnetPortsMap(DeviceId deviceId) |
Saurav Das | 52d4ed7 | 2016-03-28 19:00:18 -0700 | [diff] [blame] | 137 | throws DeviceConfigNotFoundException; |
Srikanth Vavilapalli | 37a461b | 2015-04-07 15:12:32 -0700 | [diff] [blame] | 138 | } |