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"; |
| 40 | private static final String SUPPRESS_HOST = "suppressHost"; |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame^] | 41 | private static final String HOST_LEARNING = "hostLearning"; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 42 | |
| 43 | @Override |
| 44 | public boolean isValid() { |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame^] | 45 | return hasOnlyFields(VROUTER_MACS, VROUTER_ID, SUPPRESS_SUBNET, |
| 46 | SUPPRESS_HOST, HOST_LEARNING) && |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 47 | vRouterMacs() != null && vRouterId() != null && |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 48 | suppressSubnet() != null && suppressHost() != null; |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Gets vRouters from the config. |
| 53 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 54 | * @return Set of vRouter MAC addresses, empty is not specified, |
| 55 | * or null if not valid |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 56 | */ |
| 57 | public Set<MacAddress> vRouterMacs() { |
| 58 | if (!object.has(VROUTER_MACS)) { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 59 | return ImmutableSet.of(); |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 60 | } |
| 61 | |
| 62 | ImmutableSet.Builder<MacAddress> builder = ImmutableSet.builder(); |
| 63 | ArrayNode arrayNode = (ArrayNode) object.path(VROUTER_MACS); |
| 64 | for (JsonNode jsonNode : arrayNode) { |
| 65 | MacAddress mac; |
| 66 | |
| 67 | String macStr = jsonNode.asText(null); |
| 68 | if (macStr == null) { |
| 69 | return null; |
| 70 | } |
| 71 | try { |
| 72 | mac = MacAddress.valueOf(macStr); |
| 73 | } catch (IllegalArgumentException e) { |
| 74 | return null; |
| 75 | } |
| 76 | |
| 77 | builder.add(mac); |
| 78 | } |
| 79 | return builder.build(); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Sets vRouters to the config. |
| 84 | * |
| 85 | * @param vRouterMacs a set of vRouter MAC addresses |
| 86 | * @return this {@link SegmentRoutingAppConfig} |
| 87 | */ |
| 88 | public SegmentRoutingAppConfig setVRouterMacs(Set<MacAddress> vRouterMacs) { |
| 89 | if (vRouterMacs == null) { |
| 90 | object.remove(VROUTER_MACS); |
| 91 | } else { |
| 92 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 93 | |
| 94 | vRouterMacs.forEach(mac -> { |
| 95 | arrayNode.add(mac.toString()); |
| 96 | }); |
| 97 | |
| 98 | object.set(VROUTER_MACS, arrayNode); |
| 99 | } |
| 100 | return this; |
| 101 | } |
| 102 | |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 103 | /** |
| 104 | * Gets vRouter device ID. |
| 105 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 106 | * @return Optional vRouter device ID, |
| 107 | * empty is not specified or null if not valid |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 108 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 109 | public Optional<DeviceId> vRouterId() { |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 110 | if (!object.has(VROUTER_ID)) { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 111 | return Optional.empty(); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | try { |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 115 | return Optional.of(DeviceId.deviceId(object.path(VROUTER_ID).asText())); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 116 | } catch (IllegalArgumentException e) { |
| 117 | return null; |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Sets vRouter device ID. |
| 123 | * |
| 124 | * @param vRouterId vRouter device ID |
| 125 | * @return this {@link SegmentRoutingAppConfig} |
| 126 | */ |
| 127 | public SegmentRoutingAppConfig setVRouterId(DeviceId vRouterId) { |
| 128 | if (vRouterId == null) { |
| 129 | object.remove(VROUTER_ID); |
| 130 | } else { |
| 131 | object.put(VROUTER_ID, vRouterId.toString()); |
| 132 | } |
| 133 | return this; |
| 134 | } |
| 135 | |
| 136 | /** |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 137 | * Gets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 138 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 139 | * @return Set of port names, empty if not specified, or null |
| 140 | * if not valid |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 141 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 142 | public Set<ConnectPoint> suppressSubnet() { |
| 143 | if (!object.has(SUPPRESS_SUBNET)) { |
| 144 | return ImmutableSet.of(); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 145 | } |
| 146 | |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 147 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
| 148 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_SUBNET); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 149 | for (JsonNode jsonNode : arrayNode) { |
| 150 | String portName = jsonNode.asText(null); |
| 151 | if (portName == null) { |
| 152 | return null; |
| 153 | } |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 154 | try { |
| 155 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 156 | } catch (IllegalArgumentException e) { |
| 157 | return null; |
| 158 | } |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 159 | } |
| 160 | return builder.build(); |
| 161 | } |
| 162 | |
| 163 | /** |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 164 | * Sets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 165 | * |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 166 | * @param suppressSubnet names of ports to which SegmentRouting does not push |
| 167 | * subnet rules |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 168 | * @return this {@link SegmentRoutingAppConfig} |
| 169 | */ |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 170 | public SegmentRoutingAppConfig setSuppressSubnet(Set<ConnectPoint> suppressSubnet) { |
| 171 | if (suppressSubnet == null) { |
| 172 | object.remove(SUPPRESS_SUBNET); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 173 | } else { |
| 174 | ArrayNode arrayNode = mapper.createArrayNode(); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 175 | suppressSubnet.forEach(connectPoint -> { |
| 176 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 177 | }); |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 178 | object.set(SUPPRESS_SUBNET, arrayNode); |
| 179 | } |
| 180 | return this; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * Gets names of ports to which SegmentRouting does not push host rules. |
| 185 | * |
| 186 | * @return Set of port names, empty if not specified, or null |
| 187 | * if not valid |
| 188 | */ |
| 189 | public Set<ConnectPoint> suppressHost() { |
| 190 | if (!object.has(SUPPRESS_HOST)) { |
| 191 | return ImmutableSet.of(); |
| 192 | } |
| 193 | |
| 194 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
| 195 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_HOST); |
| 196 | for (JsonNode jsonNode : arrayNode) { |
| 197 | String portName = jsonNode.asText(null); |
| 198 | if (portName == null) { |
| 199 | return null; |
| 200 | } |
| 201 | try { |
| 202 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 203 | } catch (IllegalArgumentException e) { |
| 204 | return null; |
| 205 | } |
| 206 | } |
| 207 | return builder.build(); |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Sets names of ports to which SegmentRouting does not push host rules. |
| 212 | * |
| 213 | * @param suppressHost names of ports to which SegmentRouting does not push |
| 214 | * host rules |
| 215 | * @return this {@link SegmentRoutingAppConfig} |
| 216 | */ |
| 217 | public SegmentRoutingAppConfig setSuppressHost(Set<ConnectPoint> suppressHost) { |
| 218 | if (suppressHost == null) { |
| 219 | object.remove(SUPPRESS_HOST); |
| 220 | } else { |
| 221 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 222 | suppressHost.forEach(connectPoint -> { |
| 223 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
| 224 | }); |
| 225 | object.set(SUPPRESS_HOST, arrayNode); |
Charles Chan | 43547ca | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 226 | } |
| 227 | return this; |
| 228 | } |
| 229 | |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame^] | 230 | /** |
| 231 | * Gets whether host learning is enabled or not. |
| 232 | * |
| 233 | * @return true if enabled. false if disabled or not configured |
| 234 | */ |
| 235 | public boolean hostLearning() { |
| 236 | return object.has(HOST_LEARNING) && object.path(HOST_LEARNING).asBoolean(); |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * Sets whether host learning is enabled or not. |
| 241 | * |
| 242 | * @param enabled true if enabled |
| 243 | * @return this {@link SegmentRoutingAppConfig} |
| 244 | */ |
| 245 | public SegmentRoutingAppConfig setHostLearning(boolean enabled) { |
| 246 | object.put(HOST_LEARNING, enabled); |
| 247 | return this; |
| 248 | } |
| 249 | |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 250 | @Override |
| 251 | public String toString() { |
| 252 | return toStringHelper(this) |
| 253 | .add("vRouterMacs", vRouterMacs()) |
Charles Chan | 57bd98c | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 254 | .add("vRouterId", vRouterId()) |
| 255 | .add("suppressSubnet", suppressSubnet()) |
| 256 | .add("suppressHost", suppressHost()) |
Charles Chan | 370a65b | 2016-05-10 17:29:47 -0700 | [diff] [blame^] | 257 | .add("hostLearning", hostLearning()) |
Charles Chan | 82ab193 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 258 | .toString(); |
| 259 | } |
| 260 | } |