Address comments in gerrit 20328
Create a new class XconnecEndpoint to cover both physical port and load balancer
Also change the CLI load balancer identifier to "LB:"
Change-Id: I0b4cd6e474d8b21468d87fcadd9280fdf7d6aafa
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectCodec.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectCodec.java
index 08558a8..1154e40 100644
--- a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectCodec.java
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectCodec.java
@@ -28,10 +28,13 @@
import java.util.Set;
+/**
+ * Codec for Xconnect.
+ */
public class XconnectCodec extends JsonCodec<XconnectDesc> {
private static final String DEVICE_ID = "deviceId";
private static final String VLAN_ID = "vlanId";
- private static final String PORTS = "ports";
+ private static final String ENDPOINTS = "endpoints";
private static Logger log = LoggerFactory.getLogger(XconnectCodec.class);
@@ -40,8 +43,8 @@
final ObjectNode result = context.mapper().createObjectNode();
result.put(DEVICE_ID, desc.key().deviceId().toString());
result.put(VLAN_ID, desc.key().vlanId().toString());
- final ArrayNode portNode = result.putArray(PORTS);
- desc.ports().forEach(port -> portNode.add(port.toString()));
+ final ArrayNode portNode = result.putArray(ENDPOINTS);
+ desc.endpoints().forEach(endpoint -> portNode.add(endpoint.toString()));
return result;
}
@@ -51,13 +54,14 @@
DeviceId deviceId = DeviceId.deviceId(json.path(DEVICE_ID).asText());
VlanId vlanId = VlanId.vlanId(json.path(VLAN_ID).asText());
- Set<String> ports = Sets.newHashSet();
- JsonNode portNodes = json.get(PORTS);
- if (portNodes != null) {
- portNodes.forEach(portNode -> ports.add(portNode.asText()));
+ Set<XconnectEndpoint> endpoints = Sets.newHashSet();
+ JsonNode endpointNodes = json.get(ENDPOINTS);
+ if (endpointNodes != null) {
+ XconnectEndpoint endpoint = XconnectEndpoint.fromString(endpointNodes.asText());
+ endpointNodes.forEach(endpointNode -> endpoints.add(endpoint));
}
XconnectKey key = new XconnectKey(deviceId, vlanId);
- return new XconnectDesc(key, ports);
+ return new XconnectDesc(key, endpoints);
}
}
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectDesc.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectDesc.java
index e94c1db..1e7a3b2 100644
--- a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectDesc.java
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectDesc.java
@@ -25,17 +25,17 @@
*/
public class XconnectDesc {
private XconnectKey key;
- private Set<String> ports;
+ private Set<XconnectEndpoint> endpoints;
/**
* Constructs new Xconnect description with given device ID and VLAN ID.
*
* @param key Xconnect key
- * @param ports set of ports
+ * @param endpoints set of endpoints
*/
- public XconnectDesc(XconnectKey key, Set<String> ports) {
+ public XconnectDesc(XconnectKey key, Set<XconnectEndpoint> endpoints) {
this.key = key;
- this.ports = ports;
+ this.endpoints = endpoints;
}
/**
@@ -48,12 +48,12 @@
}
/**
- * Gets ports.
+ * Gets endpoints.
*
- * @return set of ports
+ * @return set of endpoints
*/
- public Set<String> ports() {
- return ports;
+ public Set<XconnectEndpoint> endpoints() {
+ return endpoints;
}
@Override
@@ -69,19 +69,19 @@
}
final XconnectDesc other = (XconnectDesc) obj;
return Objects.equals(this.key, other.key) &&
- Objects.equals(this.ports, other.ports);
+ Objects.equals(this.endpoints, other.endpoints);
}
@Override
public int hashCode() {
- return Objects.hash(key, ports);
+ return Objects.hash(key, endpoints);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(getClass())
.add("key", key)
- .add("ports", ports)
+ .add("endpoints", endpoints)
.toString();
}
}
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectEndpoint.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectEndpoint.java
new file mode 100644
index 0000000..c7a2242
--- /dev/null
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectEndpoint.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.segmentrouting.xconnect.api;
+
+/**
+ * Represents cross connect endpoint.
+ */
+public abstract class XconnectEndpoint {
+ public static final String LB_KEYWORD = "LB:";
+ static final String PORT_PATTERN = "^\\d+$";
+ static final String LOAD_BALANCER_PATTERN = "^" + LB_KEYWORD + "\\d+$";
+
+ /**
+ * Types of endpoint.
+ */
+ public enum Type {
+ /**
+ * The endpoint is specified by an port number.
+ */
+ PORT,
+
+ /**
+ * The endpoint is specified by a load balancer.
+ */
+ LOAD_BALANCER
+ }
+
+ /**
+ * Type of this endpoint.
+ *
+ * @return type
+ */
+ public abstract XconnectEndpoint.Type type();
+
+ /**
+ * Constructs XconnectEndpoint from string.
+ *
+ * @param s string
+ * @return XconnectEndpoint
+ * @throws IllegalArgumentException if given string is in a wrong format
+ */
+ public static XconnectEndpoint fromString(String s) {
+ if (s.matches(XconnectEndpoint.PORT_PATTERN)) {
+ return XconnectPortEndpoint.fromString(s);
+ } else if (s.matches(XconnectEndpoint.LOAD_BALANCER_PATTERN)) {
+ return XconnectLoadBalancerEndpoint.fromString(s);
+ } else {
+ throw new IllegalArgumentException("Illegal endpoint format: " + s);
+ }
+ }
+}
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectLoadBalancerEndpoint.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectLoadBalancerEndpoint.java
new file mode 100644
index 0000000..4172292
--- /dev/null
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectLoadBalancerEndpoint.java
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.segmentrouting.xconnect.api;
+
+import java.util.Objects;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+/**
+ * Represents a cross connect endpoint specified by load balancer.
+ */
+public final class XconnectLoadBalancerEndpoint extends XconnectEndpoint {
+ private final int key;
+
+ private XconnectLoadBalancerEndpoint(int key) {
+ this.key = key;
+ }
+
+ /**
+ * Returns load balancer key.
+ *
+ * @return load balancer key.
+ */
+ public int key() {
+ return key;
+ }
+
+ /**
+ * Returns an instance of XconnectLoadBalancerEndpoint with given load balancer key.
+ *
+ * @param key load balancer key
+ * @return an instance of XconnectLoadBalancerEndpoint
+ */
+ public static XconnectLoadBalancerEndpoint of(int key) {
+ return new XconnectLoadBalancerEndpoint(key);
+ }
+
+ /**
+ * Gets XconnectLoadBalancerEndpoint from string.
+ *
+ * @param s string
+ * @return XconnectLoadBalancerEndpoint
+ */
+ public static XconnectLoadBalancerEndpoint fromString(String s) {
+ checkArgument(s.matches(LOAD_BALANCER_PATTERN), "String {} does not match {} format", s, LOAD_BALANCER_PATTERN);
+ return new XconnectLoadBalancerEndpoint(Integer.valueOf(s.replaceFirst(LB_KEYWORD, "")));
+ }
+
+ @Override
+ public Type type() {
+ return Type.LOAD_BALANCER;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(key);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof XconnectLoadBalancerEndpoint) {
+ final XconnectLoadBalancerEndpoint other = (XconnectLoadBalancerEndpoint) obj;
+ return Objects.equals(this.key, other.key);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return LB_KEYWORD + String.valueOf(key);
+ }
+}
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectPortEndpoint.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectPortEndpoint.java
new file mode 100644
index 0000000..f26eaf0
--- /dev/null
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectPortEndpoint.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.segmentrouting.xconnect.api;
+
+import org.onosproject.net.PortNumber;
+
+import java.util.Objects;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+/**
+ * Represents a cross connect endpoint specified by port number.
+ */
+public final class XconnectPortEndpoint extends XconnectEndpoint {
+ private final PortNumber port;
+
+ private XconnectPortEndpoint(PortNumber port) {
+ this.port = port;
+ }
+
+ /**
+ * Returns port number.
+ *
+ * @return port number
+ */
+ public PortNumber port() {
+ return port;
+ }
+
+ /**
+ * Returns an instance of XconnectPortEndpoint with given port number.
+ *
+ * @param port port number
+ * @return an instance of XconnectPortEndpoint
+ */
+ public static XconnectPortEndpoint of(PortNumber port) {
+ return new XconnectPortEndpoint(port);
+ }
+
+ /**
+ * Gets XconnectPortEndpoint from string.
+ *
+ * @param s string
+ * @return XconnectPortEndpoint
+ */
+ public static XconnectPortEndpoint fromString(String s) {
+ checkArgument(s.matches(PORT_PATTERN), "String {} does not match {} format", s, PORT_PATTERN);
+ return new XconnectPortEndpoint(PortNumber.fromString(s));
+ }
+
+ @Override
+ public XconnectEndpoint.Type type() {
+ return Type.PORT;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(port);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof XconnectPortEndpoint) {
+ final XconnectPortEndpoint other = (XconnectPortEndpoint) obj;
+ return Objects.equals(this.port, other.port);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return String.valueOf(port);
+ }
+}
diff --git a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectService.java b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectService.java
index fe51b06..2fe6488 100644
--- a/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectService.java
+++ b/app/src/main/java/org/onosproject/segmentrouting/xconnect/api/XconnectService.java
@@ -44,9 +44,9 @@
*
* @param deviceId device ID
* @param vlanId VLAN ID
- * @param ports set of ports
+ * @param endpoints set of endpoints
*/
- void addOrUpdateXconnect(DeviceId deviceId, VlanId vlanId, Set<String> ports);
+ void addOrUpdateXconnect(DeviceId deviceId, VlanId vlanId, Set<XconnectEndpoint> endpoints);
/**
* Deletes Xconnect.