Add OTN device and ports
Change-Id: I18f3376d1466077e95d7324a27a660302f0123b3
diff --git a/core/api/src/main/java/org/onosproject/net/OtuPort.java b/core/api/src/main/java/org/onosproject/net/OtuPort.java
new file mode 100644
index 0000000..1e4448a
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/OtuPort.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.net;
+
+import java.util.Objects;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+
+/**
+ * Implementation of OTU port (Optical channel Transport Unit).
+ */
+
+public class OtuPort extends DefaultPort {
+
+ private final OtuSignalType signalType;
+
+ /**
+ * Creates an OTU port in the specified network element.
+ *
+ * @param element parent network element
+ * @param number port number
+ * @param isEnabled port enabled state
+ * @param signalType OTU signal type
+ * @param annotations optional key/value annotations
+ */
+ public OtuPort(Element element, PortNumber number, boolean isEnabled,
+ OtuSignalType signalType, Annotations... annotations) {
+ super(element, number, isEnabled, Type.OTU, 0, annotations);
+ this.signalType = signalType;
+ }
+
+ /**
+ * Returns OTU signal type.
+ *
+ * @return OTU signal type
+ */
+ public OtuSignalType signalType() {
+ return signalType;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(number(), isEnabled(), type(), signalType, annotations());
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof OtuPort) {
+ final OtuPort other = (OtuPort) obj;
+ return Objects.equals(this.element().id(), other.element().id()) &&
+ Objects.equals(this.number(), other.number()) &&
+ Objects.equals(this.isEnabled(), other.isEnabled()) &&
+ Objects.equals(this.signalType, other.signalType) &&
+ Objects.equals(this.annotations(), other.annotations());
+ }
+ return false;
+ }
+
+
+ @Override
+ public String toString() {
+ return toStringHelper(this)
+ .add("element", element().id())
+ .add("number", number())
+ .add("isEnabled", isEnabled())
+ .add("type", type())
+ .add("signalType", signalType)
+ .toString();
+ }
+
+}
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/OtuSignalType.java b/core/api/src/main/java/org/onosproject/net/OtuSignalType.java
new file mode 100644
index 0000000..150249e
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/OtuSignalType.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.net;
+
+/**
+ * Represents OTU (Optical channel Transport Unit) signal type.
+ *
+ * <p>
+ * See ITU G.709 "Interfaces for the Optical Transport Network (OTN)" and
+ * Open Networking Foundation "Optical Transport Protocol Extensions Version 1.0".
+ * </p>
+ */
+public enum OtuSignalType {
+ OTU1,
+ OTU2,
+ OTU3,
+ OTU4
+}
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/Port.java b/core/api/src/main/java/org/onosproject/net/Port.java
index d70b1e1..2a3072d 100644
--- a/core/api/src/main/java/org/onosproject/net/Port.java
+++ b/core/api/src/main/java/org/onosproject/net/Port.java
@@ -58,7 +58,12 @@
/**
* Signifies virtual port.
*/
- VIRTUAL
+ VIRTUAL,
+
+ /**
+ * Signifies optical fiber-based OTN port.
+ */
+ OTU
}
/**
diff --git a/core/api/src/main/java/org/onosproject/net/device/OtuPortDescription.java b/core/api/src/main/java/org/onosproject/net/device/OtuPortDescription.java
new file mode 100644
index 0000000..60f2515
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/device/OtuPortDescription.java
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.net.device;
+
+import com.google.common.base.MoreObjects;
+
+import org.onosproject.net.OtuSignalType;
+import org.onosproject.net.Port;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.SparseAnnotations;
+
+/**
+ * Default implementation of immutable OTU port description.
+ */
+public class OtuPortDescription extends DefaultPortDescription {
+
+ private final OtuSignalType signalType;
+
+ /**
+ * Creates OTU port description based on the supplied information.
+ *
+ * @param number port number
+ * @param isEnabled port enabled state
+ * @param signalType OTU signal type
+ * @param annotations optional key/value annotations map
+ */
+ public OtuPortDescription(PortNumber number, boolean isEnabled, OtuSignalType signalType,
+ SparseAnnotations... annotations) {
+ super(number, isEnabled, Port.Type.OTU, 0, annotations);
+ this.signalType = signalType;
+ }
+
+ /**
+ * Creates OTU port description based on the supplied information.
+ *
+ * @param base PortDescription to get basic information from
+ * @param signalType OTU signal type
+ * @param annotations optional key/value annotations map
+ */
+ public OtuPortDescription(PortDescription base, OtuSignalType signalType,
+ SparseAnnotations annotations) {
+ super(base, annotations);
+ this.signalType = signalType;
+ }
+
+ /**
+ * Returns OTU signal type.
+ *
+ * @return OTU signal type
+ */
+ public OtuSignalType signalType() {
+ return signalType;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass())
+ .add("number", portNumber())
+ .add("isEnabled", isEnabled())
+ .add("type", type())
+ .add("signalType", signalType)
+ .toString();
+ }
+
+}
\ No newline at end of file
diff --git a/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java b/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
index 5f6fb04..60fd95a 100644
--- a/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
+++ b/core/net/src/main/java/org/onosproject/net/device/impl/DeviceManager.java
@@ -352,7 +352,8 @@
final Device device = getDevice(deviceId);
List<PortDescription> descs = ports.stream().map(
- port -> (!(Device.Type.ROADM.equals(device.type()))) ?
+ port -> (!(Device.Type.ROADM.equals(device.type()) ||
+ (Device.Type.OTN.equals(device.type())))) ?
new DefaultPortDescription(port.number(), false,
port.type(), port.portSpeed()) :
OpticalPortOperator.descriptionOf(port, false)
@@ -439,7 +440,8 @@
return;
}
Device device = nullIsNotFound(getDevice(deviceId), "Device not found");
- if ((Device.Type.ROADM.equals(device.type()))) {
+ if ((Device.Type.ROADM.equals(device.type())) ||
+ (Device.Type.OTN.equals(device.type()))) {
Port port = getPort(deviceId, portDescription.portNumber());
portDescription = OpticalPortOperator.descriptionOf(port, portDescription.isEnabled());
}
diff --git a/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java b/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java
index 8f60149..ca720e2 100644
--- a/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java
+++ b/core/net/src/main/java/org/onosproject/net/device/impl/OpticalPortOperator.java
@@ -23,6 +23,7 @@
import org.onosproject.net.AnnotationKeys;
import org.onosproject.net.DefaultAnnotations;
import org.onosproject.net.OchPort;
+import org.onosproject.net.OtuPort;
import org.onosproject.net.OduCltPort;
import org.onosproject.net.OmsPort;
import org.onosproject.net.Port;
@@ -32,6 +33,7 @@
import org.onosproject.net.device.OchPortDescription;
import org.onosproject.net.device.OduCltPortDescription;
import org.onosproject.net.device.OmsPortDescription;
+import org.onosproject.net.device.OtuPortDescription;
import org.onosproject.net.device.PortDescription;
import org.slf4j.Logger;
@@ -115,6 +117,9 @@
case COPPER:
return new DefaultPortDescription(port, descr.isEnabled(), descr.type(),
descr.portSpeed(), sa);
+ case OTU:
+ OtuPortDescription otu = (OtuPortDescription) descr;
+ return new OtuPortDescription(port, otu.isEnabled(), otu.signalType(), sa);
default:
log.warn("Unsupported optical port type {} - can't update", descr.type());
return descr;
@@ -183,6 +188,9 @@
case ODUCLT:
OduCltPort odu = (OduCltPort) port;
return new OduCltPortDescription(ptn, isup, odu.signalType(), an);
+ case OTU:
+ OtuPort otu = (OtuPort) port;
+ return new OtuPortDescription(ptn, isup, otu.signalType(), an);
default:
return new DefaultPortDescription(ptn, isup, port.type(), port.portSpeed(), an);
}
diff --git a/core/net/src/test/java/org/onosproject/net/device/impl/BasicDeviceOperatorTest.java b/core/net/src/test/java/org/onosproject/net/device/impl/BasicDeviceOperatorTest.java
index 138283c..54e7a4a 100644
--- a/core/net/src/test/java/org/onosproject/net/device/impl/BasicDeviceOperatorTest.java
+++ b/core/net/src/test/java/org/onosproject/net/device/impl/BasicDeviceOperatorTest.java
@@ -34,11 +34,13 @@
import static org.junit.Assert.assertEquals;
import static org.onosproject.net.Device.Type.ROADM;
import static org.onosproject.net.Device.Type.SWITCH;
+import static org.onosproject.net.Device.Type.OTN;
public class BasicDeviceOperatorTest {
private static final String NAME1 = "of:foo";
private static final String NAME2 = "of:bar";
+ private static final String NAME3 = "of:otn";
private static final String OWNER = "somebody";
private static final URI DURI = URI.create(NAME1);
private static final String MFR = "whitebox";
@@ -64,6 +66,7 @@
private static final BasicDeviceConfig SW_BDC = new BasicDeviceConfig();
private static final BasicDeviceConfig RD_BDC = new BasicDeviceConfig();
+ private static final BasicDeviceConfig OT_BDC = new BasicDeviceConfig();
@Before
public void setUp() {
@@ -72,6 +75,8 @@
RD_BDC.init(DeviceId.deviceId(NAME2), NAME2, JsonNodeFactory.instance.objectNode(), mapper, delegate);
RD_BDC.type(ROADM).manufacturer(MANUFACTURER).hwVersion(HW_VERSION)
.swVersion(SW_VERSION).serial(SERIAL).managementAddress(MANAGEMENT_ADDRESS).driver(DRIVER).owner(OWNER);
+ OT_BDC.init(DeviceId.deviceId(NAME3), NAME3, JsonNodeFactory.instance.objectNode(), mapper, delegate);
+ OT_BDC.type(OTN);
}
@Test
@@ -92,5 +97,9 @@
assertEquals("Wrong serial", SERIAL, desc.serialNumber());
assertEquals("Wrong management Address", MANAGEMENT_ADDRESS,
desc.annotations().value(AnnotationKeys.MANAGEMENT_ADDRESS));
+
+ // override Device type
+ desc = BasicDeviceOperator.combine(OT_BDC, DEV1);
+ assertEquals(OTN, desc.type());
}
}
diff --git a/core/store/dist/src/main/java/org/onosproject/store/device/impl/DeviceDescriptions.java b/core/store/dist/src/main/java/org/onosproject/store/device/impl/DeviceDescriptions.java
index 2320672..36ad2a4 100644
--- a/core/store/dist/src/main/java/org/onosproject/store/device/impl/DeviceDescriptions.java
+++ b/core/store/dist/src/main/java/org/onosproject/store/device/impl/DeviceDescriptions.java
@@ -31,6 +31,7 @@
import org.onosproject.net.device.OchPortDescription;
import org.onosproject.net.device.OduCltPortDescription;
import org.onosproject.net.device.OmsPortDescription;
+import org.onosproject.net.device.OtuPortDescription;
import org.onosproject.net.device.PortDescription;
import org.onosproject.store.Timestamp;
import org.onosproject.store.impl.Timestamped;
@@ -123,6 +124,13 @@
ocDesc, ocDesc.signalType(), merged),
newDesc.timestamp());
break;
+ case OTU:
+ OtuPortDescription otuDesc = (OtuPortDescription) (newDesc.value());
+ newOne = new Timestamped<>(
+ new OtuPortDescription(
+ otuDesc, otuDesc.signalType(), merged),
+ newDesc.timestamp());
+ break;
default:
newOne = new Timestamped<>(
new DefaultPortDescription(newDesc.value(), merged),
diff --git a/core/store/dist/src/main/java/org/onosproject/store/device/impl/GossipDeviceStore.java b/core/store/dist/src/main/java/org/onosproject/store/device/impl/GossipDeviceStore.java
index 53809d1..a10b79d 100644
--- a/core/store/dist/src/main/java/org/onosproject/store/device/impl/GossipDeviceStore.java
+++ b/core/store/dist/src/main/java/org/onosproject/store/device/impl/GossipDeviceStore.java
@@ -48,6 +48,7 @@
import org.onosproject.net.OchPort;
import org.onosproject.net.OduCltPort;
import org.onosproject.net.OmsPort;
+import org.onosproject.net.OtuPort;
import org.onosproject.net.Port;
import org.onosproject.net.PortNumber;
import org.onosproject.net.device.DefaultPortStatistics;
@@ -59,6 +60,7 @@
import org.onosproject.net.device.OchPortDescription;
import org.onosproject.net.device.OduCltPortDescription;
import org.onosproject.net.device.OmsPortDescription;
+import org.onosproject.net.device.OtuPortDescription;
import org.onosproject.net.device.PortDescription;
import org.onosproject.net.device.PortStatistics;
import org.onosproject.net.provider.ProviderId;
@@ -1095,6 +1097,9 @@
case ODUCLT:
OduCltPortDescription oduDesc = (OduCltPortDescription) description;
return new OduCltPort(device, number, isEnabled, oduDesc.signalType(), annotations);
+ case OTU:
+ OtuPortDescription otuDesc = (OtuPortDescription) description;
+ return new OtuPort(device, number, isEnabled, otuDesc.signalType(), annotations);
default:
return new DefaultPort(device, number, isEnabled, description.type(),
description.portSpeed(), annotations);
diff --git a/core/store/serializers/src/main/java/org/onosproject/store/serializers/KryoNamespaces.java b/core/store/serializers/src/main/java/org/onosproject/store/serializers/KryoNamespaces.java
index d5a73c0..9d8a0b2 100644
--- a/core/store/serializers/src/main/java/org/onosproject/store/serializers/KryoNamespaces.java
+++ b/core/store/serializers/src/main/java/org/onosproject/store/serializers/KryoNamespaces.java
@@ -77,6 +77,8 @@
import org.onosproject.net.OduSignalId;
import org.onosproject.net.OduSignalType;
import org.onosproject.net.OmsPort;
+import org.onosproject.net.OtuPort;
+import org.onosproject.net.OtuSignalType;
import org.onosproject.net.Port;
import org.onosproject.net.PortNumber;
import org.onosproject.net.TributarySlot;
@@ -85,6 +87,7 @@
import org.onosproject.net.device.DefaultPortStatistics;
import org.onosproject.net.device.OchPortDescription;
import org.onosproject.net.device.OduCltPortDescription;
+import org.onosproject.net.device.OtuPortDescription;
import org.onosproject.net.device.OmsPortDescription;
import org.onosproject.net.device.PortStatistics;
import org.onosproject.net.flow.CompletedBatchOperation;
@@ -511,6 +514,9 @@
.register(OchPortDescription.class)
.register(OmsPortDescription.class)
.register(TributarySlot.class)
+ .register(OtuPort.class)
+ .register(OtuSignalType.class)
+ .register(OtuPortDescription.class)
.register(
MplsIntent.class,
MplsPathIntent.class,
diff --git a/core/store/serializers/src/test/java/org/onosproject/store/serializers/KryoSerializerTest.java b/core/store/serializers/src/test/java/org/onosproject/store/serializers/KryoSerializerTest.java
index 9a0e94f..b6ece78 100644
--- a/core/store/serializers/src/test/java/org/onosproject/store/serializers/KryoSerializerTest.java
+++ b/core/store/serializers/src/test/java/org/onosproject/store/serializers/KryoSerializerTest.java
@@ -52,6 +52,8 @@
import org.onosproject.net.OchSignal;
import org.onosproject.net.OduCltPort;
import org.onosproject.net.OmsPort;
+import org.onosproject.net.OtuPort;
+import org.onosproject.net.OtuSignalType;
import org.onosproject.net.PortNumber;
import org.onosproject.net.OduSignalType;
import org.onosproject.net.SparseAnnotations;
@@ -225,6 +227,11 @@
}
@Test
+ public void testOtuPort() {
+ testSerializedEquals(new OtuPort(DEV1, P1, true, OtuSignalType.OTU2));
+ testSerializedEquals(new OtuPort(DEV1, P1, true, OtuSignalType.OTU2, A1_2));
+ }
+ @Test
public void testDeviceId() {
testSerializedEquals(DID1);
}