common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfacesImpl221.java

   1 /*
   2  * Copyright © 2017 AT&T and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.transportpce.common.openroadminterfaces;
  10
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import java.util.Optional;
  13 import java.util.concurrent.ExecutionException;
  14 import java.util.concurrent.Future;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.common.api.CommitInfo;
  17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  18 import org.opendaylight.transportpce.common.StringConstants;
  19 import org.opendaylight.transportpce.common.Timeouts;
  20 import org.opendaylight.transportpce.common.device.DeviceTransaction;
  21 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev171215.AdminStates;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev171215.States;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOdu;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOtu;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.maintenance.loopback.rev171215.maint.loopback.MaintLoopbackBuilder;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.maintenance.testsignal.rev171215.maint.testsignal.MaintTestsignalBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.odu.container.OduBuilder;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.otu.container.OtuBuilder;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 public class OpenRoadmInterfacesImpl221 {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfacesImpl221.class);
  46
  47     private final DeviceTransactionManager deviceTransactionManager;
  48
  49     public OpenRoadmInterfacesImpl221(DeviceTransactionManager deviceTransactionManager) {
  50         this.deviceTransactionManager = deviceTransactionManager;
  51     }
  52
  53     public void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException {
  54         Future<Optional<DeviceTransaction>> deviceTxFuture = deviceTransactionManager.getDeviceTransaction(nodeId);
  55         DeviceTransaction deviceTx;
  56         try {
  57             Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
  58             if (deviceTxOpt.isPresent()) {
  59                 deviceTx = deviceTxOpt.get();
  60             } else {
  61                 throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
  62                     nodeId));
  63             }
  64         } catch (InterruptedException | ExecutionException e) {
  65             throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
  66                 nodeId), e);
  67         }
  68
  69         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
  70             Interface.class, new InterfaceKey(ifBuilder.getName()));
  71         LOG.info("POST INTERF for {} : InterfaceBuilder : name = {} \t type = {}", nodeId, ifBuilder.getName(),
  72             ifBuilder.getType().toString());
  73         deviceTx.merge(LogicalDatastoreType.CONFIGURATION, interfacesIID, ifBuilder.build());
  74         FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
  75             deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
  76         try {
  77             txSubmitFuture.get();
  78             LOG.info("Successfully posted interface {} on node {}", ifBuilder.getName(), nodeId);
  79         } catch (InterruptedException | ExecutionException e) {
  80             throw new OpenRoadmInterfaceException(String.format("Failed to post interface %s on node %s!", ifBuilder
  81                 .getName(), nodeId), e);
  82         }
  83     }
  84
  85
  86     public Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
  87         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
  88             .child(Interface.class, new InterfaceKey(interfaceName));
  89         return deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.CONFIGURATION,
  90             interfacesIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  91     }
  92
  93
  94     public synchronized void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
  95         LOG.info("deleting interface {} on device221 {}", interfaceName, nodeId);
  96         Optional<Interface> intf2DeleteOpt;
  97         try {
  98             intf2DeleteOpt = getInterface(nodeId, interfaceName);
  99         } catch (OpenRoadmInterfaceException e) {
 100             throw new OpenRoadmInterfaceException(String.format("Failed to check if interface %s exists on node %s!",
 101                 interfaceName, nodeId), e);
 102         }
 103         if (intf2DeleteOpt.isPresent()) {
 104             Interface intf2Delete = intf2DeleteOpt.get();
 105             // State admin state to out of service
 106             InterfaceBuilder ifBuilder = new InterfaceBuilder(intf2Delete);
 107             if (ifBuilder.getType() == OtnOdu.class) {
 108                 Interface1Builder oduBuilder = new Interface1Builder(intf2Delete.augmentation(Interface1.class));
 109                 OduBuilder odu = new OduBuilder(oduBuilder.getOdu());
 110                 if (odu.getMaintTestsignal() != null) {
 111                     MaintTestsignalBuilder maintSignalBuilder = new MaintTestsignalBuilder();
 112                     maintSignalBuilder.setEnabled(false);
 113                     odu.setMaintTestsignal(maintSignalBuilder.build());
 114                 }
 115                 oduBuilder.setOdu(odu.build());
 116                 ifBuilder.addAugmentation(oduBuilder.build());
 117             } else if (ifBuilder.getType() == OtnOtu.class) {
 118                 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder
 119                     otuBuilder =
 120                     new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder(
 121                         intf2Delete.augmentation(
 122                             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1
 123                             .class));
 124                 OtuBuilder otu = new OtuBuilder(otuBuilder.getOtu());
 125                 if (otu.getMaintLoopback() != null) {
 126                     MaintLoopbackBuilder maintLoopBackBuilder = new MaintLoopbackBuilder();
 127                     maintLoopBackBuilder.setEnabled(false);
 128                     otu.setMaintLoopback(maintLoopBackBuilder.build());
 129                 }
 130                 otuBuilder.setOtu(otu.build());
 131                 ifBuilder.addAugmentation(otuBuilder.build());
 132             }
 133             ifBuilder.setAdministrativeState(AdminStates.OutOfService);
 134             // post interface with updated admin state
 135             try {
 136                 postInterface(nodeId, ifBuilder);
 137             } catch (OpenRoadmInterfaceException ex) {
 138                 throw new OpenRoadmInterfaceException(String.format("Failed to set state of interface %s to %s while"
 139                     + " deleting it!", interfaceName, AdminStates.OutOfService), ex);
 140             }
 141
 142             InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 143                 Interface.class, new InterfaceKey(interfaceName));
 144             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 145                 nodeId);
 146             DeviceTransaction deviceTx;
 147             try {
 148                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 149                 if (deviceTxOpt.isPresent()) {
 150                     deviceTx = deviceTxOpt.get();
 151                 } else {
 152                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 153                         nodeId));
 154                 }
 155             } catch (InterruptedException | ExecutionException e) {
 156                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 157                     nodeId), e);
 158             }
 159
 160             deviceTx.delete(LogicalDatastoreType.CONFIGURATION, interfacesIID);
 161             FluentFuture<? extends @NonNull CommitInfo> commit =
 162                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 163
 164             try {
 165                 commit.get();
 166                 LOG.info("Successfully deleted {} on node {}", interfaceName, nodeId);
 167             } catch (InterruptedException | ExecutionException e) {
 168                 throw new OpenRoadmInterfaceException(String.format("Failed to delete interface %s on " + "node %s",
 169                     interfaceName, nodeId), e);
 170             }
 171             // change the equipment state on circuit pack if xpdr node
 172             if (intf2Delete.getName().contains(StringConstants.CLIENT_TOKEN) || intf2Delete.getName().contains(
 173                 StringConstants.NETWORK_TOKEN)) {
 174                 postEquipmentState(nodeId, intf2Delete.getSupportingCircuitPackName(), false);
 175             }
 176
 177         } else {
 178             LOG.info("Interface does not exist, cannot delete on node {}", nodeId);
 179         }
 180     }
 181
 182     public void postEquipmentState(String nodeId, String circuitPackName, boolean activate)
 183         throws OpenRoadmInterfaceException {
 184         InstanceIdentifier<CircuitPacks> circuitPackIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 185             CircuitPacks.class, new CircuitPacksKey(circuitPackName));
 186         Optional<CircuitPacks> cpOpt = this.deviceTransactionManager.getDataFromDevice(nodeId,
 187             LogicalDatastoreType.CONFIGURATION, circuitPackIID, Timeouts.DEVICE_READ_TIMEOUT,
 188             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 189         CircuitPacks cp = null;
 190         if (cpOpt.isPresent()) {
 191             cp = cpOpt.get();
 192         } else {
 193             throw new OpenRoadmInterfaceException(String.format(
 194                 "Could not find CircuitPack %s in equipment config datastore for node %s", circuitPackName, nodeId));
 195         }
 196         CircuitPacksBuilder cpBldr = new CircuitPacksBuilder(cp);
 197         boolean change = false;
 198         if (activate) {
 199             if (cpBldr.getEquipmentState() != null
 200                     && !States.NotReservedInuse.equals(cpBldr.getEquipmentState())) {
 201                 cpBldr.setEquipmentState(States.NotReservedInuse);
 202                 change = true;
 203             }
 204         } else if ((cpBldr.getEquipmentState() != null
 205                 && !States.NotReservedAvailable.equals(cpBldr.getEquipmentState()))) {
 206             cpBldr.setEquipmentState(States.NotReservedAvailable);
 207             change = true;
 208         }
 209         if (change) {
 210             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 211                 nodeId);
 212             DeviceTransaction deviceTx;
 213             try {
 214                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 215                 if (deviceTxOpt.isPresent()) {
 216                     deviceTx = deviceTxOpt.get();
 217                 } else {
 218                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 219                         nodeId));
 220                 }
 221             } catch (InterruptedException | ExecutionException e) {
 222                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 223                     nodeId), e);
 224             }
 225             deviceTx.merge(LogicalDatastoreType.CONFIGURATION, circuitPackIID, cpBldr.build());
 226             FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
 227                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 228             try {
 229                 txSubmitFuture.get();
 230                 LOG.info("Successfully posted equipment state change on node {}", nodeId);
 231             } catch (InterruptedException | ExecutionException e) {
 232                 throw new OpenRoadmInterfaceException(String.format("Failed to post equipment state on node %s!",
 233                     nodeId), e);
 234             }
 235         }
 236     }
 237
 238     public String getSupportedInterface(String nodeId, String interf) {
 239         Optional<Interface> supInterfOpt;
 240         try {
 241             supInterfOpt = getInterface(nodeId, interf);
 242             if (supInterfOpt.isPresent()) {
 243                 return supInterfOpt.get().getSupportingInterface();
 244             } else {
 245                 return null;
 246             }
 247         } catch (OpenRoadmInterfaceException e) {
 248             LOG.error("error getting Supported Interface of {} - {}", interf, nodeId, e);
 249             return null;
 250         }
 251     }
 252
 253 }