Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -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 | |
Ray Milkey | 6c01374 | 2017-08-15 10:16:43 -0700 | [diff] [blame] | 17 | package org.onosproject.net.config.basics; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 18 | |
| 19 | import com.fasterxml.jackson.databind.JsonNode; |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 21 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Thomas Vachuska | 4c571ae | 2015-09-10 16:31:59 -0700 | [diff] [blame] | 22 | import com.google.common.annotations.Beta; |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 23 | import com.google.common.collect.ImmutableSet; |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 24 | import com.google.common.collect.Lists; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 25 | import com.google.common.collect.Sets; |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 26 | import org.onlab.packet.IpPrefix; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 27 | import org.onlab.packet.MacAddress; |
| 28 | import org.onlab.packet.VlanId; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 29 | import org.onosproject.net.ConnectPoint; |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 30 | import org.onosproject.net.config.Config; |
Ray Milkey | 6c01374 | 2017-08-15 10:16:43 -0700 | [diff] [blame] | 31 | import org.onosproject.net.config.ConfigException; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 32 | import org.onosproject.net.host.InterfaceIpAddress; |
Ray Milkey | 6c01374 | 2017-08-15 10:16:43 -0700 | [diff] [blame] | 33 | import org.onosproject.net.intf.Interface; |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 34 | import org.slf4j.Logger; |
| 35 | import org.slf4j.LoggerFactory; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 36 | |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 37 | import java.util.Iterator; |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 38 | import java.util.List; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 39 | import java.util.Set; |
| 40 | |
Jonathan Hart | 4b5c6dc | 2015-10-13 14:27:48 -0700 | [diff] [blame] | 41 | import static com.google.common.base.Preconditions.checkArgument; |
| 42 | import static com.google.common.base.Preconditions.checkNotNull; |
| 43 | |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 44 | /** |
| 45 | * Configuration for interfaces. |
| 46 | */ |
Thomas Vachuska | 4c571ae | 2015-09-10 16:31:59 -0700 | [diff] [blame] | 47 | @Beta |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 48 | public class InterfaceConfig extends Config<ConnectPoint> { |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 49 | private static Logger log = LoggerFactory.getLogger(InterfaceConfig.class); |
| 50 | |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 51 | public static final String NAME = "name"; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 52 | public static final String IPS = "ips"; |
| 53 | public static final String MAC = "mac"; |
| 54 | public static final String VLAN = "vlan"; |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 55 | public static final String VLAN_UNTAGGED = "vlan-untagged"; |
| 56 | public static final String VLAN_TAGGED = "vlan-tagged"; |
| 57 | public static final String VLAN_NATIVE = "vlan-native"; |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 58 | |
Jonathan Hart | 4b5c6dc | 2015-10-13 14:27:48 -0700 | [diff] [blame] | 59 | private static final String CONFIG_VALUE_ERROR = "Error parsing config value"; |
| 60 | private static final String INTF_NULL_ERROR = "Interface cannot be null"; |
| 61 | private static final String INTF_NAME_ERROR = "Interface must have a valid name"; |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 62 | |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 63 | @Override |
| 64 | public boolean isValid() { |
| 65 | for (JsonNode node : array) { |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 66 | if (!hasOnlyFields((ObjectNode) node, NAME, IPS, MAC, VLAN, |
| 67 | VLAN_UNTAGGED, VLAN_TAGGED, VLAN_NATIVE)) { |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 68 | return false; |
| 69 | } |
| 70 | |
| 71 | ObjectNode obj = (ObjectNode) node; |
| 72 | |
| 73 | if (!(isString(obj, NAME, FieldPresence.OPTIONAL) && |
| 74 | isMacAddress(obj, MAC, FieldPresence.OPTIONAL) && |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 75 | isIntegralNumber(obj, VLAN, FieldPresence.OPTIONAL, 0, VlanId.MAX_VLAN) && |
| 76 | isIntegralNumber(obj, VLAN_UNTAGGED, FieldPresence.OPTIONAL, 0, VlanId.MAX_VLAN) && |
| 77 | isIntegralNumber(obj, VLAN_NATIVE, FieldPresence.OPTIONAL, 0, VlanId.MAX_VLAN))) { |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 78 | return false; |
| 79 | } |
| 80 | |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 81 | for (JsonNode ipNode : node.path(IPS)) { |
| 82 | if (!ipNode.isTextual() || IpPrefix.valueOf(ipNode.asText()) == null) { |
| 83 | return false; |
| 84 | } |
| 85 | } |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 86 | |
| 87 | checkArgument(!hasField(obj, VLAN_TAGGED) || |
| 88 | (node.path(VLAN_TAGGED).isArray() && node.path(VLAN_TAGGED).size() >= 1), |
| 89 | "%s must be an array with at least one element", VLAN_TAGGED); |
| 90 | |
| 91 | for (JsonNode vlanNode : node.path(VLAN_TAGGED)) { |
| 92 | checkArgument(vlanNode.isInt() && |
| 93 | vlanNode.intValue() >= 0 && vlanNode.intValue() <= VlanId.MAX_VLAN, |
| 94 | "Invalid VLAN ID %s in %s", vlanNode.intValue(), VLAN_TAGGED); |
| 95 | } |
| 96 | |
| 97 | checkArgument(!hasField(obj, VLAN_UNTAGGED) || |
| 98 | !(hasField(obj, VLAN_TAGGED) || hasField(obj, VLAN_NATIVE)), |
| 99 | "%s and %s should not be used when %s is set", VLAN_TAGGED, VLAN_NATIVE, VLAN_UNTAGGED); |
| 100 | |
| 101 | checkArgument(!hasField(obj, VLAN_TAGGED) || !hasField(obj, VLAN_UNTAGGED), |
| 102 | "%s should not be used when %s is set", VLAN_UNTAGGED, VLAN_TAGGED); |
| 103 | |
| 104 | checkArgument(!hasField(obj, VLAN_NATIVE) || hasField(obj, VLAN_TAGGED), |
| 105 | "%s should not be used alone without %s", VLAN_NATIVE, VLAN_TAGGED); |
| 106 | |
| 107 | checkArgument(!hasField(obj, VLAN_NATIVE) || !hasField(obj, VLAN_TAGGED) || |
| 108 | !getVlans(obj, VLAN_TAGGED).contains(getVlan(obj, VLAN_NATIVE)), |
| 109 | "%s cannot be one of the VLANs configured in %s", VLAN_NATIVE, VLAN_TAGGED); |
Jonathan Hart | 9eb45bb | 2016-02-12 10:59:11 -0800 | [diff] [blame] | 110 | } |
| 111 | return true; |
| 112 | } |
| 113 | |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 114 | /** |
| 115 | * Retrieves all interfaces configured on this port. |
| 116 | * |
| 117 | * @return set of interfaces |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 118 | * @throws ConfigException if there is any error in the JSON config |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 119 | */ |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 120 | public Set<Interface> getInterfaces() throws ConfigException { |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 121 | Set<Interface> interfaces = Sets.newHashSet(); |
| 122 | |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 123 | try { |
Jonathan Hart | ed4fdcd | 2015-09-08 14:13:37 -0700 | [diff] [blame] | 124 | for (JsonNode intfNode : array) { |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 125 | String name = intfNode.path(NAME).asText(null); |
| 126 | |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 127 | List<InterfaceIpAddress> ips = getIps(intfNode); |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 128 | |
Luca Prete | e3879f7 | 2015-10-16 11:19:53 +0200 | [diff] [blame] | 129 | String mac = intfNode.path(MAC).asText(); |
| 130 | MacAddress macAddr = mac.isEmpty() ? null : MacAddress.valueOf(mac); |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 131 | |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 132 | VlanId vlan = getVlan(intfNode, VLAN); |
| 133 | VlanId vlanUntagged = getVlan(intfNode, VLAN_UNTAGGED); |
| 134 | Set<VlanId> vlanTagged = getVlans(intfNode, VLAN_TAGGED); |
| 135 | VlanId vlanNative = getVlan(intfNode, VLAN_NATIVE); |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 136 | |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 137 | interfaces.add(new Interface(name, subject, ips, macAddr, vlan, |
| 138 | vlanUntagged, vlanTagged, vlanNative)); |
Jonathan Hart | 4cb3988 | 2015-08-12 23:50:55 -0400 | [diff] [blame] | 139 | } |
| 140 | } catch (IllegalArgumentException e) { |
| 141 | throw new ConfigException(CONFIG_VALUE_ERROR, e); |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | return interfaces; |
| 145 | } |
| 146 | |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 147 | /** |
| 148 | * Adds an interface to the config. |
| 149 | * |
| 150 | * @param intf interface to add |
| 151 | */ |
| 152 | public void addInterface(Interface intf) { |
Jonathan Hart | 4b5c6dc | 2015-10-13 14:27:48 -0700 | [diff] [blame] | 153 | checkNotNull(intf, INTF_NULL_ERROR); |
| 154 | checkArgument(!intf.name().equals(Interface.NO_INTERFACE_NAME), INTF_NAME_ERROR); |
| 155 | |
| 156 | // Remove old interface with this name if it exists |
| 157 | removeInterface(intf.name()); |
| 158 | |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 159 | ObjectNode intfNode = array.addObject(); |
Luca Prete | e3879f7 | 2015-10-16 11:19:53 +0200 | [diff] [blame] | 160 | |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 161 | intfNode.put(NAME, intf.name()); |
| 162 | |
Luca Prete | e3879f7 | 2015-10-16 11:19:53 +0200 | [diff] [blame] | 163 | if (intf.mac() != null) { |
| 164 | intfNode.put(MAC, intf.mac().toString()); |
| 165 | } |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 166 | |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 167 | if (!intf.ipAddressesList().isEmpty()) { |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 168 | intfNode.set(IPS, putIps(intf.ipAddressesList())); |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | if (!intf.vlan().equals(VlanId.NONE)) { |
| 172 | intfNode.put(VLAN, intf.vlan().toString()); |
| 173 | } |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 174 | |
| 175 | if (!intf.vlanUntagged().equals(VlanId.NONE)) { |
| 176 | intfNode.put(VLAN_UNTAGGED, intf.vlanUntagged().toString()); |
| 177 | } |
| 178 | |
| 179 | if (!intf.vlanTagged().isEmpty()) { |
Ray Milkey | 874581a | 2018-03-02 10:20:32 -0800 | [diff] [blame] | 180 | intfNode.set(VLAN_TAGGED, putVlans(intf.vlanTagged())); |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | if (!intf.vlanNative().equals(VlanId.NONE)) { |
| 184 | intfNode.put(VLAN_NATIVE, intf.vlanNative().toString()); |
| 185 | } |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | /** |
| 189 | * Removes an interface from the config. |
| 190 | * |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 191 | * @param name name of the interface to remove |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 192 | */ |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 193 | public void removeInterface(String name) { |
Jonathan Hart | 4b5c6dc | 2015-10-13 14:27:48 -0700 | [diff] [blame] | 194 | checkNotNull(name, INTF_NULL_ERROR); |
| 195 | checkArgument(!name.equals(Interface.NO_INTERFACE_NAME), INTF_NAME_ERROR); |
| 196 | |
Jonathan Hart | 7dbe629 | 2015-11-10 08:33:17 -0800 | [diff] [blame] | 197 | Iterator<JsonNode> it = array.iterator(); |
| 198 | while (it.hasNext()) { |
| 199 | JsonNode node = it.next(); |
| 200 | if (node.path(NAME).asText().equals(name)) { |
| 201 | it.remove(); |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 202 | break; |
| 203 | } |
| 204 | } |
| 205 | } |
| 206 | |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 207 | /** |
| 208 | * Extracts VLAN ID from given path of given json node. |
| 209 | * |
| 210 | * @param node JSON node |
| 211 | * @param path path |
| 212 | * @return VLAN ID |
| 213 | */ |
| 214 | private VlanId getVlan(JsonNode node, String path) { |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 215 | VlanId vlan = VlanId.NONE; |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 216 | if (!node.path(path).isMissingNode()) { |
| 217 | vlan = VlanId.vlanId(Short.valueOf(node.path(path).asText())); |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 218 | } |
| 219 | return vlan; |
| 220 | } |
| 221 | |
Charles Chan | bae2cb2 | 2017-01-18 19:35:20 -0800 | [diff] [blame] | 222 | /** |
| 223 | * Extracts a set of VLAN ID from given path of given json node. |
| 224 | * |
| 225 | * @param node JSON node |
| 226 | * @param path path |
| 227 | * @return a set of VLAN ID |
| 228 | */ |
| 229 | private Set<VlanId> getVlans(JsonNode node, String path) { |
| 230 | ImmutableSet.Builder<VlanId> vlanIdBuilder = ImmutableSet.builder(); |
| 231 | |
| 232 | JsonNode vlansNode = node.get(path); |
| 233 | if (vlansNode != null) { |
| 234 | vlansNode.forEach(vlanNode -> |
| 235 | vlanIdBuilder.add(VlanId.vlanId(vlanNode.shortValue()))); |
| 236 | } |
| 237 | |
| 238 | return vlanIdBuilder.build(); |
| 239 | } |
| 240 | |
| 241 | private ArrayNode putVlans(Set<VlanId> vlans) { |
| 242 | ArrayNode vlanArray = mapper.createArrayNode(); |
| 243 | |
| 244 | vlans.forEach(vlan -> vlanArray.add(vlan.toShort())); |
| 245 | |
| 246 | return vlanArray; |
| 247 | } |
| 248 | |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 249 | private List<InterfaceIpAddress> getIps(JsonNode node) { |
| 250 | List<InterfaceIpAddress> ips = Lists.newArrayList(); |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 251 | |
| 252 | JsonNode ipsNode = node.get(IPS); |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 253 | if (ipsNode != null) { |
| 254 | ipsNode.forEach(jsonNode -> |
| 255 | ips.add(InterfaceIpAddress.valueOf(jsonNode.asText()))); |
| 256 | } |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 257 | |
| 258 | return ips; |
| 259 | } |
| 260 | |
Jonathan Hart | 00cddda | 2016-02-16 10:30:37 -0800 | [diff] [blame] | 261 | private ArrayNode putIps(List<InterfaceIpAddress> intfIpAddresses) { |
Jonathan Hart | 0bdf837 | 2015-10-08 14:30:36 -0700 | [diff] [blame] | 262 | ArrayNode ipArray = mapper.createArrayNode(); |
| 263 | |
| 264 | intfIpAddresses.forEach(i -> ipArray.add(i.toString())); |
| 265 | |
| 266 | return ipArray; |
| 267 | } |
| 268 | |
Jonathan Hart | eb8c947 | 2015-08-05 07:43:13 -0700 | [diff] [blame] | 269 | } |