Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 43b5354 | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -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 | */ |
| 16 | |
| 17 | package org.onosproject.segmentrouting.config; |
| 18 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.JsonNode; |
Charles Chan | e7c6102 | 2015-10-07 14:21:45 -0700 | [diff] [blame] | 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 21 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 22 | import com.google.common.collect.ImmutableMap; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 23 | import org.onlab.packet.Ip4Address; |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 24 | import org.onlab.packet.Ip6Address; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 25 | import org.onlab.packet.MacAddress; |
| 26 | import org.onosproject.net.DeviceId; |
| 27 | import org.onosproject.net.config.Config; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 28 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 29 | import java.util.HashMap; |
| 30 | import java.util.HashSet; |
| 31 | import java.util.Map; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 32 | import java.util.Optional; |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 33 | import java.util.Set; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Configuration object for Segment Routing Application. |
| 37 | */ |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 38 | public class SegmentRoutingDeviceConfig extends Config<DeviceId> { |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 39 | private static final String NAME = "name"; |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 40 | private static final String IP4 = "ipv4Loopback"; |
| 41 | private static final String IP6 = "ipv6Loopback"; |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 42 | private static final String MAC = "routerMac"; |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 43 | private static final String IP4_SID = "ipv4NodeSid"; |
| 44 | private static final String IP6_SID = "ipv6NodeSid"; |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 45 | private static final String EDGE = "isEdgeRouter"; |
| 46 | private static final String ADJSIDS = "adjacencySids"; |
| 47 | private static final String ADJSID = "adjSid"; |
| 48 | private static final String PORTS = "ports"; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 49 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 50 | @Override |
| 51 | public boolean isValid() { |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 52 | return hasOnlyFields(NAME, IP4, IP6, MAC, |
| 53 | IP4_SID, IP6_SID, EDGE, |
| 54 | ADJSIDS, ADJSID, PORTS) && |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 55 | name() != null && |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 56 | routerIpv4() != null && |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 57 | routerMac() != null && |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 58 | nodeSidIPv4() != -1 && |
Charles Chan | b7f75ac | 2016-01-11 18:28:54 -0800 | [diff] [blame] | 59 | isEdgeRouter() != null && |
| 60 | adjacencySids() != null; |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Gets the name of the router. |
| 65 | * |
| 66 | * @return Optional name of the router. May be empty if not configured. |
| 67 | */ |
| 68 | public Optional<String> name() { |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 69 | String name = get(NAME, null); |
| 70 | return name != null ? Optional.of(name) : Optional.empty(); |
| 71 | } |
| 72 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 73 | /** |
| 74 | * Sets the name of the router. |
| 75 | * |
| 76 | * @param name name of the router. |
| 77 | * @return the config of the router. |
| 78 | */ |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 79 | public SegmentRoutingDeviceConfig setName(String name) { |
| 80 | return (SegmentRoutingDeviceConfig) setOrClear(NAME, name); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 81 | } |
| 82 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 83 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 84 | * Gets the IPv4 address of the router. |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 85 | * |
| 86 | * @return IP address of the router. Or null if not configured. |
| 87 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 88 | public Ip4Address routerIpv4() { |
| 89 | String ip = get(IP4, null); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 90 | return ip != null ? Ip4Address.valueOf(ip) : null; |
| 91 | } |
| 92 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 93 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 94 | * Gets the IPv6 address of the router. |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 95 | * |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 96 | * @return IP address of the router. Or null if not configured. |
| 97 | */ |
| 98 | public Ip6Address routerIpv6() { |
| 99 | String ip = get(IP6, null); |
| 100 | return ip != null ? Ip6Address.valueOf(ip) : null; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Sets the IPv4 address of the router. |
| 105 | * |
| 106 | * @param ip IPv4 address of the router. |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 107 | * @return the config of the router. |
| 108 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 109 | public SegmentRoutingDeviceConfig setRouterIpv4(String ip) { |
| 110 | return (SegmentRoutingDeviceConfig) setOrClear(IP4, ip); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Sets the IPv6 address of the router. |
| 115 | * |
| 116 | * @param ip IPv6 address of the router. |
| 117 | * @return the config of the router. |
| 118 | */ |
| 119 | public SegmentRoutingDeviceConfig setRouterIpv6(String ip) { |
| 120 | return (SegmentRoutingDeviceConfig) setOrClear(IP6, ip); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 121 | } |
| 122 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 123 | /** |
| 124 | * Gets the MAC address of the router. |
| 125 | * |
| 126 | * @return MAC address of the router. Or null if not configured. |
| 127 | */ |
| 128 | public MacAddress routerMac() { |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 129 | String mac = get(MAC, null); |
| 130 | return mac != null ? MacAddress.valueOf(mac) : null; |
| 131 | } |
| 132 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 133 | /** |
| 134 | * Sets the MAC address of the router. |
| 135 | * |
| 136 | * @param mac MAC address of the router. |
| 137 | * @return the config of the router. |
| 138 | */ |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 139 | public SegmentRoutingDeviceConfig setRouterMac(String mac) { |
| 140 | return (SegmentRoutingDeviceConfig) setOrClear(MAC, mac); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 141 | } |
| 142 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 143 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 144 | * Gets the IPv4 node SID of the router. |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 145 | * |
| 146 | * @return node SID of the router. Or -1 if not configured. |
| 147 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 148 | public int nodeSidIPv4() { |
| 149 | return get(IP4_SID, -1); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 150 | } |
| 151 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 152 | /** |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 153 | * Gets the IPv6 node SID of the router. |
| 154 | * |
| 155 | * @return node SID of the router. Or -1 if not configured. |
| 156 | */ |
| 157 | public int nodeSidIPv6() { |
| 158 | return get(IP6_SID, -1); |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Sets the node IPv4 node SID of the router. |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 163 | * |
| 164 | * @param sid node SID of the router. |
| 165 | * @return the config of the router. |
| 166 | */ |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 167 | public SegmentRoutingDeviceConfig setNodeSidIPv4(int sid) { |
| 168 | return (SegmentRoutingDeviceConfig) setOrClear(IP4_SID, sid); |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Sets the node IPv6 node SID of the router. |
| 173 | * |
| 174 | * @param sid node SID of the router. |
| 175 | * @return the config of the router. |
| 176 | */ |
| 177 | public SegmentRoutingDeviceConfig setNodeSidIPv6(int sid) { |
| 178 | return (SegmentRoutingDeviceConfig) setOrClear(IP6_SID, sid); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 179 | } |
| 180 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 181 | /** |
| 182 | * Checks if the router is an edge router. |
| 183 | * |
| 184 | * @return true if the router is an edge router. |
| 185 | * false if the router is not an edge router. |
| 186 | * null if the value is not configured. |
| 187 | */ |
| 188 | public Boolean isEdgeRouter() { |
| 189 | String isEdgeRouter = get(EDGE, null); |
| 190 | return isEdgeRouter != null ? |
| 191 | Boolean.valueOf(isEdgeRouter) : |
| 192 | null; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 193 | } |
| 194 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 195 | /** |
| 196 | * Specifies if the router is an edge router. |
| 197 | * |
| 198 | * @param isEdgeRouter true if the router is an edge router. |
| 199 | * @return the config of the router. |
| 200 | */ |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 201 | public SegmentRoutingDeviceConfig setIsEdgeRouter(boolean isEdgeRouter) { |
| 202 | return (SegmentRoutingDeviceConfig) setOrClear(EDGE, isEdgeRouter); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 203 | } |
| 204 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 205 | /** |
| 206 | * Gets the adjacency SIDs of the router. |
| 207 | * |
| 208 | * @return adjacency SIDs of the router. Or null if not configured. |
| 209 | */ |
| 210 | public Map<Integer, Set<Integer>> adjacencySids() { |
| 211 | if (!object.has(ADJSIDS)) { |
| 212 | return null; |
Charles Chan | e7c6102 | 2015-10-07 14:21:45 -0700 | [diff] [blame] | 213 | } |
| 214 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 215 | Map<Integer, Set<Integer>> adjacencySids = new HashMap<>(); |
| 216 | ArrayNode adjacencySidsNode = (ArrayNode) object.path(ADJSIDS); |
| 217 | for (JsonNode adjacencySidNode : adjacencySidsNode) { |
| 218 | int asid = adjacencySidNode.path(ADJSID).asInt(-1); |
| 219 | if (asid == -1) { |
| 220 | return null; |
| 221 | } |
Charles Chan | e7c6102 | 2015-10-07 14:21:45 -0700 | [diff] [blame] | 222 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 223 | HashSet<Integer> ports = new HashSet<>(); |
| 224 | ArrayNode portsNode = (ArrayNode) adjacencySidNode.path(PORTS); |
| 225 | for (JsonNode portNode : portsNode) { |
| 226 | int port = portNode.asInt(-1); |
| 227 | if (port == -1) { |
| 228 | return null; |
| 229 | } |
| 230 | ports.add(port); |
| 231 | } |
| 232 | adjacencySids.put(asid, ports); |
| 233 | } |
| 234 | |
| 235 | return ImmutableMap.copyOf(adjacencySids); |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Sets the adjacency SIDs of the router. |
| 240 | * |
| 241 | * @param adjacencySids adjacency SIDs of the router. |
| 242 | * @return the config of the router. |
| 243 | */ |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 244 | public SegmentRoutingDeviceConfig setAdjacencySids(Map<Integer, Set<Integer>> adjacencySids) { |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 245 | if (adjacencySids == null) { |
| 246 | object.remove(ADJSIDS); |
| 247 | } else { |
| 248 | ArrayNode adjacencySidsNode = mapper.createArrayNode(); |
| 249 | |
| 250 | adjacencySids.forEach((sid, ports) -> { |
| 251 | ObjectNode adjacencySidNode = mapper.createObjectNode(); |
| 252 | |
| 253 | adjacencySidNode.put(ADJSID, sid); |
| 254 | |
| 255 | ArrayNode portsNode = mapper.createArrayNode(); |
| 256 | ports.forEach(port -> { |
| 257 | portsNode.add(port.toString()); |
| 258 | }); |
| 259 | adjacencySidNode.set(PORTS, portsNode); |
| 260 | |
| 261 | adjacencySidsNode.add(adjacencySidNode); |
Charles Chan | e7c6102 | 2015-10-07 14:21:45 -0700 | [diff] [blame] | 262 | }); |
| 263 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 264 | object.set(ADJSIDS, adjacencySidsNode); |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 265 | } |
| 266 | |
Charles Chan | 9bec8a3 | 2015-12-01 10:00:51 -0800 | [diff] [blame] | 267 | return this; |
Charles Chan | 72f556a | 2015-10-05 17:50:33 -0700 | [diff] [blame] | 268 | } |
Pier Ventre | adb4ae6 | 2016-11-23 09:57:42 -0800 | [diff] [blame^] | 269 | } |