[Emu] Defining classes for ODU SIGID and SIGTYPE Fields in Flow Criteria and Instruction - Data Model and Tests only
Change-Id: I3a71520caa286a1fcc509c581036ef4848de9b5b
diff --git a/core/api/src/main/java/org/onosproject/net/flow/instructions/Instruction.java b/core/api/src/main/java/org/onosproject/net/flow/instructions/Instruction.java
index d01ea29..eddbbb7 100644
--- a/core/api/src/main/java/org/onosproject/net/flow/instructions/Instruction.java
+++ b/core/api/src/main/java/org/onosproject/net/flow/instructions/Instruction.java
@@ -59,6 +59,11 @@
L0MODIFICATION,
/**
+ * Signifies that the traffic should be modified in L1 way.
+ */
+ L1MODIFICATION,
+
+ /**
* Signifies that the traffic should be modified in L2 way.
*/
L2MODIFICATION,
@@ -86,6 +91,7 @@
/**
* Returns the type of instruction.
+ *
* @return type of instruction
*/
Type type();
diff --git a/core/api/src/main/java/org/onosproject/net/flow/instructions/Instructions.java b/core/api/src/main/java/org/onosproject/net/flow/instructions/Instructions.java
index c9f1068..26981e5 100644
--- a/core/api/src/main/java/org/onosproject/net/flow/instructions/Instructions.java
+++ b/core/api/src/main/java/org/onosproject/net/flow/instructions/Instructions.java
@@ -25,10 +25,12 @@
import org.onosproject.net.IndexedLambda;
import org.onosproject.net.Lambda;
import org.onosproject.net.OchSignal;
+import org.onosproject.net.OduSignalId;
import org.onosproject.net.PortNumber;
import org.onosproject.net.flow.instructions.L0ModificationInstruction.L0SubType;
import org.onosproject.net.flow.instructions.L0ModificationInstruction.ModLambdaInstruction;
import org.onosproject.net.flow.instructions.L0ModificationInstruction.ModOchSignalInstruction;
+import org.onosproject.net.flow.instructions.L1ModificationInstruction.ModOduSignalIdInstruction;
import org.onosproject.net.flow.instructions.L3ModificationInstruction.L3SubType;
import org.onosproject.net.flow.instructions.L3ModificationInstruction.ModIPInstruction;
import org.onosproject.net.flow.instructions.L3ModificationInstruction.ModIPv6FlowLabelInstruction;
@@ -47,7 +49,6 @@
*/
public final class Instructions {
-
// Ban construction
private Instructions() {}
@@ -117,6 +118,16 @@
}
/**
+ * Creates an L1 modification with the specified ODU signal Id.
+ *
+ * @param oduSignalId ODU Signal Id
+ * @return a L1 modification
+ */
+ public static L1ModificationInstruction modL1OduSignalId(OduSignalId oduSignalId) {
+ checkNotNull(oduSignalId, "L1 ODU signal ID cannot be null");
+ return new ModOduSignalIdInstruction(oduSignalId);
+ }
+ /**
* Creates a l2 src modification.
*
* @param addr the mac address to modify to
diff --git a/core/api/src/main/java/org/onosproject/net/flow/instructions/L1ModificationInstruction.java b/core/api/src/main/java/org/onosproject/net/flow/instructions/L1ModificationInstruction.java
new file mode 100644
index 0000000..c6847d1
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/instructions/L1ModificationInstruction.java
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2014-2015 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.flow.instructions;
+
+import org.onosproject.net.OduSignalId;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+
+import java.util.Objects;
+
+public abstract class L1ModificationInstruction implements Instruction {
+
+ /**
+ * Represents the type of traffic treatment.
+ */
+ public enum L1SubType {
+ /**
+ * ODU (Optical channel Data Unit) Signal Id modification.
+ */
+ ODU_SIGID
+ }
+
+ public abstract L1SubType subtype();
+
+ @Override
+ public final Type type() {
+ return Type.L1MODIFICATION;
+ }
+
+ /**
+ * Represents an L1 ODU (Optical channel Data Unit) Signal Id modification instruction.
+ */
+ public static final class ModOduSignalIdInstruction extends L1ModificationInstruction {
+
+ private final OduSignalId oduSignalId;
+
+ ModOduSignalIdInstruction(OduSignalId oduSignalId) {
+ this.oduSignalId = oduSignalId;
+ }
+
+ @Override
+ public L1SubType subtype() {
+ return L1SubType.ODU_SIGID;
+ }
+
+ public OduSignalId oduSignalId() {
+ return oduSignalId;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(oduSignalId);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!(obj instanceof ModOduSignalIdInstruction)) {
+ return false;
+ }
+ final ModOduSignalIdInstruction that = (ModOduSignalIdInstruction) obj;
+ return Objects.equals(this.oduSignalId, that.oduSignalId);
+ }
+
+ @Override
+ public String toString() {
+ return toStringHelper(this)
+ .add("oduSignalId", oduSignalId)
+ .toString();
+ }
+ }
+
+}