Fix circuit-pack equipment state on XPDR

[transportpce.git] / common / src / main / java / org / opendaylight / transportpce / common / openroadminterfaces / OpenRoadmInterfaces.java

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
index dc3821652d04c22812816a94f5fe802ea3515619..d0bc45e9553d97c74eda18163ef21b57462f29b4 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
@@ -16,13 +16,13 @@ import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfac
 public interface OpenRoadmInterfaces {
 
     /**
-     * This methods does an edit-config operation on the openROADM device in order
-     * to create the given interface.
+     * This methods does an edit-config operation on the openROADM device in
+     * order to create the given interface.
      *
      * <p>
-     * Before posting the interface it checks if:
-     * 1. Interface with same name does not exist
-     * 2. If exists then admin state of interface is outOfState/Maintenance
+     * Before posting the interface it checks if: 1. Interface with same name
+     * does not exist 2. If exists then admin state of interface is
+     * outOfState/Maintenance
      * </p>
      *
      * @param nodeId node ID
@@ -34,10 +34,22 @@ public interface OpenRoadmInterfaces {
      */
     void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException;
 
+    /**
+     * This methods does an edit-config operation on the openROADM device in
+     * order to manages the equipment-state status of the circuit pack on which
+     * OpenRoadmEthernet or OpenRoadmOch interfaces are created, according to
+     * OpenRoadm whitepaper. Concerns only XPDR node.
+     *
+     * @param nodeId node ID
+     * @param circuitPackName Circtuit-Pack name
+     * @param activate activate or not
+     */
+    void postEquipmentState(String nodeId, String circuitPackName, boolean activate) throws OpenRoadmInterfaceException;
+
     /**
      * This private does a get on the interface subtree of the device with the
-     * interface name as the key and return the class corresponding to the interface
-     * type.
+     * interface name as the key and return the class corresponding to the
+     * interface type.
      *
      * @param nodeId node ID
      *
@@ -51,13 +63,12 @@ public interface OpenRoadmInterfaces {
     Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
 
     /**
-     * This methods does an edit-config operation on the openROADM device in order
-     * to delete the given interface.
+     * This methods does an edit-config operation on the openROADM device in
+     * order to delete the given interface.
      *
      * <p>
-     * Before deleting the method:
-     * 1. Checks if interface exists
-     * 2. If exists then changes the state of interface to outOfService
+     * Before deleting the method: 1. Checks if interface exists 2. If exists
+     * then changes the state of interface to outOfService
      * </p>
      *
      * @param nodeId node ID