Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [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 | 82ab193 | 2016-01-30 23:22:37 -0800 | [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 | |
| 19 | import com.fasterxml.jackson.databind.JsonNode; |
| 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 21 | import com.google.common.collect.ImmutableSet; |
| 22 | import org.onlab.packet.MacAddress; |
| 23 | import org.onosproject.core.ApplicationId; |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 24 | import org.onosproject.net.ConnectPoint; |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 25 | import org.onosproject.net.DeviceId; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 26 | import org.onosproject.net.config.Config; |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 27 | |
| 28 | import java.util.Optional; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 29 | import java.util.Set; |
| 30 | |
| 31 | import static com.google.common.base.MoreObjects.toStringHelper; |
| 32 | |
| 33 | /** |
| 34 | * App configuration object for Segment Routing. |
| 35 | */ |
| 36 | public class SegmentRoutingAppConfig extends Config<ApplicationId> { |
| 37 | private static final String VROUTER_MACS = "vRouterMacs"; |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 38 | private static final String VROUTER_ID = "vRouterId"; |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 39 | private static final String SUPPRESS_SUBNET = "suppressSubnet"; |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 40 | private static final String SUPPRESS_HOST_BY_PORT = "suppressHostByPort"; |
| 41 | // TODO We might want to move SUPPRESS_HOST_BY_PROVIDER to Component Config |
| 42 | private static final String SUPPRESS_HOST_BY_PROVIDER = "suppressHostByProvider"; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 43 | |
| 44 | @Override |
| 45 | public boolean isValid() { |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 46 | return hasOnlyFields(VROUTER_MACS, VROUTER_ID, SUPPRESS_SUBNET, |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 47 | SUPPRESS_HOST_BY_PORT, SUPPRESS_HOST_BY_PROVIDER) && |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 48 | vRouterMacs() != null && vRouterId() != null && |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 49 | suppressSubnet() != null && suppressHostByPort() != null && |
| 50 | suppressHostByProvider() != null; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Gets vRouters from the config. |
| 55 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 56 | * @return Set of vRouter MAC addresses, empty is not specified, |
| 57 | * or null if not valid |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 58 | */ |
| 59 | public Set<MacAddress> vRouterMacs() { |
| 60 | if (!object.has(VROUTER_MACS)) { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 61 | return ImmutableSet.of(); |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | ImmutableSet.Builder<MacAddress> builder = ImmutableSet.builder(); |
| 65 | ArrayNode arrayNode = (ArrayNode) object.path(VROUTER_MACS); |
| 66 | for (JsonNode jsonNode : arrayNode) { |
| 67 | MacAddress mac; |
| 68 | |
| 69 | String macStr = jsonNode.asText(null); |
| 70 | if (macStr == null) { |
| 71 | return null; |
| 72 | } |
| 73 | try { |
| 74 | mac = MacAddress.valueOf(macStr); |
| 75 | } catch (IllegalArgumentException e) { |
| 76 | return null; |
| 77 | } |
| 78 | |
| 79 | builder.add(mac); |
| 80 | } |
| 81 | return builder.build(); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Sets vRouters to the config. |
| 86 | * |
| 87 | * @param vRouterMacs a set of vRouter MAC addresses |
| 88 | * @return this {@link SegmentRoutingAppConfig} |
| 89 | */ |
| 90 | public SegmentRoutingAppConfig setVRouterMacs(Set<MacAddress> vRouterMacs) { |
| 91 | if (vRouterMacs == null) { |
| 92 | object.remove(VROUTER_MACS); |
| 93 | } else { |
| 94 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 95 | |
| 96 | vRouterMacs.forEach(mac -> { |
| 97 | arrayNode.add(mac.toString()); |
| 98 | }); |
| 99 | |
| 100 | object.set(VROUTER_MACS, arrayNode); |
| 101 | } |
| 102 | return this; |
| 103 | } |
| 104 | |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 105 | /** |
| 106 | * Gets vRouter device ID. |
| 107 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 108 | * @return Optional vRouter device ID, |
| 109 | * empty is not specified or null if not valid |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 110 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 111 | public Optional<DeviceId> vRouterId() { |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 112 | if (!object.has(VROUTER_ID)) { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 113 | return Optional.empty(); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | try { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 117 | return Optional.of(DeviceId.deviceId(object.path(VROUTER_ID).asText())); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 118 | } catch (IllegalArgumentException e) { |
| 119 | return null; |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Sets vRouter device ID. |
| 125 | * |
| 126 | * @param vRouterId vRouter device ID |
| 127 | * @return this {@link SegmentRoutingAppConfig} |
| 128 | */ |
| 129 | public SegmentRoutingAppConfig setVRouterId(DeviceId vRouterId) { |
| 130 | if (vRouterId == null) { |
| 131 | object.remove(VROUTER_ID); |
| 132 | } else { |
| 133 | object.put(VROUTER_ID, vRouterId.toString()); |
| 134 | } |
| 135 | return this; |
| 136 | } |
| 137 | |
| 138 | /** |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 139 | * Gets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 140 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 141 | * @return Set of port names, empty if not specified, or null |
| 142 | * if not valid |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 143 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 144 | public Set<ConnectPoint> suppressSubnet() { |
| 145 | if (!object.has(SUPPRESS_SUBNET)) { |
| 146 | return ImmutableSet.of(); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 147 | } |
| 148 | |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 149 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
| 150 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_SUBNET); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 151 | for (JsonNode jsonNode : arrayNode) { |
| 152 | String portName = jsonNode.asText(null); |
| 153 | if (portName == null) { |
| 154 | return null; |
| 155 | } |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 156 | try { |
| 157 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 158 | } catch (IllegalArgumentException e) { |
| 159 | return null; |
| 160 | } |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 161 | } |
| 162 | return builder.build(); |
| 163 | } |
| 164 | |
| 165 | /** |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 166 | * Sets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 167 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 168 | * @param suppressSubnet names of ports to which SegmentRouting does not push |
| 169 | * subnet rules |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 170 | * @return this {@link SegmentRoutingAppConfig} |
| 171 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 172 | public SegmentRoutingAppConfig setSuppressSubnet(Set<ConnectPoint> suppressSubnet) { |
| 173 | if (suppressSubnet == null) { |
| 174 | object.remove(SUPPRESS_SUBNET); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 175 | } else { |
| 176 | ArrayNode arrayNode = mapper.createArrayNode(); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 177 | suppressSubnet.forEach(connectPoint -> { |
| 178 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 179 | }); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 180 | object.set(SUPPRESS_SUBNET, arrayNode); |
| 181 | } |
| 182 | return this; |
| 183 | } |
| 184 | |
| 185 | /** |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 186 | * Gets connect points to which SegmentRouting does not push host rules. |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 187 | * |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 188 | * @return Set of connect points, empty if not specified, or null |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 189 | * if not valid |
| 190 | */ |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 191 | public Set<ConnectPoint> suppressHostByPort() { |
| 192 | if (!object.has(SUPPRESS_HOST_BY_PORT)) { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 193 | return ImmutableSet.of(); |
| 194 | } |
| 195 | |
| 196 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 197 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_HOST_BY_PORT); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 198 | for (JsonNode jsonNode : arrayNode) { |
| 199 | String portName = jsonNode.asText(null); |
| 200 | if (portName == null) { |
| 201 | return null; |
| 202 | } |
| 203 | try { |
| 204 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 205 | } catch (IllegalArgumentException e) { |
| 206 | return null; |
| 207 | } |
| 208 | } |
| 209 | return builder.build(); |
| 210 | } |
| 211 | |
| 212 | /** |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 213 | * Sets connect points to which SegmentRouting does not push host rules. |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 214 | * |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 215 | * @param connectPoints connect points to which SegmentRouting does not push |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 216 | * host rules |
| 217 | * @return this {@link SegmentRoutingAppConfig} |
| 218 | */ |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 219 | public SegmentRoutingAppConfig setSuppressHostByPort(Set<ConnectPoint> connectPoints) { |
| 220 | if (connectPoints == null) { |
| 221 | object.remove(SUPPRESS_HOST_BY_PORT); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 222 | } else { |
| 223 | ArrayNode arrayNode = mapper.createArrayNode(); |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 224 | connectPoints.forEach(connectPoint -> { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 225 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
| 226 | }); |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 227 | object.set(SUPPRESS_HOST_BY_PORT, arrayNode); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 228 | } |
| 229 | return this; |
| 230 | } |
| 231 | |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 232 | /** |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 233 | * Gets provider names from which SegmentRouting does not learn host info. |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 234 | * |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 235 | * @return array of provider names that need to be ignored |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 236 | */ |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 237 | public Set<String> suppressHostByProvider() { |
| 238 | if (!object.has(SUPPRESS_HOST_BY_PROVIDER)) { |
| 239 | return ImmutableSet.of(); |
| 240 | } |
| 241 | |
| 242 | ImmutableSet.Builder<String> builder = ImmutableSet.builder(); |
| 243 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_HOST_BY_PROVIDER); |
| 244 | for (JsonNode jsonNode : arrayNode) { |
| 245 | String providerName = jsonNode.asText(null); |
| 246 | if (providerName == null) { |
| 247 | return null; |
| 248 | } |
| 249 | builder.add(providerName); |
| 250 | } |
| 251 | return builder.build(); |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 252 | } |
| 253 | |
| 254 | /** |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 255 | * Sets provider names from which SegmentRouting does not learn host info. |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 256 | * |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 257 | * @param providers set of provider names |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 258 | * @return this {@link SegmentRoutingAppConfig} |
| 259 | */ |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 260 | public SegmentRoutingAppConfig setSuppressHostByProvider(Set<String> providers) { |
| 261 | if (providers == null) { |
| 262 | object.remove(SUPPRESS_HOST_BY_PROVIDER); |
| 263 | } else { |
| 264 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 265 | providers.forEach(arrayNode::add); |
| 266 | object.set(SUPPRESS_HOST_BY_PROVIDER, arrayNode); |
| 267 | } |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 268 | return this; |
| 269 | } |
| 270 | |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 271 | @Override |
| 272 | public String toString() { |
| 273 | return toStringHelper(this) |
| 274 | .add("vRouterMacs", vRouterMacs()) |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 275 | .add("vRouterId", vRouterId()) |
| 276 | .add("suppressSubnet", suppressSubnet()) |
Charles Chan | 3bf64b9 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 277 | .add("suppressHostByPort", suppressHostByPort()) |
| 278 | .add("suppressHostByProvider", suppressHostByProvider()) |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 279 | .toString(); |
| 280 | } |
| 281 | } |