common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfacesImpl121.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.rev170206.circuit.packs.CircuitPacks;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.packs.CircuitPacksBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.packs.CircuitPacksKey;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.States;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.maintenance.loopback.rev161014.maint.loopback.MaintLoopbackBuilder;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.maintenance.testsignal.rev161014.maint.testsignal.MaintTestsignalBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.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 OpenRoadmInterfacesImpl121 {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfacesImpl121.class);
  46
  47     private final DeviceTransactionManager deviceTransactionManager;
  48
  49     public OpenRoadmInterfacesImpl121(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         deviceTx.merge(LogicalDatastoreType.CONFIGURATION, interfacesIID, ifBuilder.build());
  72         FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
  73             deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
  74         try {
  75             txSubmitFuture.get();
  76             LOG.info("Successfully posted interface {} on node {}", ifBuilder.getName(), nodeId);
  77         } catch (InterruptedException | ExecutionException e) {
  78             throw new OpenRoadmInterfaceException(String.format("Failed to post interface %s on node %s!", ifBuilder
  79                 .getName(), nodeId), e);
  80         }
  81     }
  82
  83
  84     public Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
  85         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
  86             .child(Interface.class, new InterfaceKey(interfaceName));
  87         return deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.CONFIGURATION,
  88             interfacesIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  89     }
  90
  91
  92     public synchronized void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
  93         Optional<Interface> intf2DeleteOpt;
  94         try {
  95             intf2DeleteOpt = getInterface(nodeId, interfaceName);
  96         } catch (OpenRoadmInterfaceException e) {
  97             throw new OpenRoadmInterfaceException(String.format("Failed to check if interface %s exists on node %s!",
  98                 interfaceName, nodeId), e);
  99         }
 100         if (intf2DeleteOpt.isPresent()) {
 101             Interface intf2Delete = intf2DeleteOpt.get();
 102             // State admin state to out of service
 103             InterfaceBuilder ifBuilder = new InterfaceBuilder(intf2Delete);
 104             if (ifBuilder.getType() == OtnOdu.class) {
 105                 Interface1Builder oduBuilder = new Interface1Builder(intf2Delete.augmentation(Interface1.class));
 106                 OduBuilder odu = new OduBuilder(oduBuilder.getOdu());
 107                 if (odu.getMaintTestsignal() != null) {
 108                     MaintTestsignalBuilder maintSignalBuilder = new MaintTestsignalBuilder();
 109                     maintSignalBuilder.setEnabled(false);
 110                     odu.setMaintTestsignal(maintSignalBuilder.build());
 111                 }
 112                 oduBuilder.setOdu(odu.build());
 113                 ifBuilder.addAugmentation(oduBuilder.build());
 114             } else if (ifBuilder.getType() == OtnOtu.class) {
 115                 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder
 116                     otuBuilder =
 117                     new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder(
 118                         intf2Delete.augmentation(
 119                             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1
 120                                 .class));
 121                 OtuBuilder otu = new OtuBuilder(otuBuilder.getOtu());
 122                 if (otu.getMaintLoopback() != null) {
 123                     MaintLoopbackBuilder maintLoopBackBuilder = new MaintLoopbackBuilder();
 124                     maintLoopBackBuilder.setEnabled(false);
 125                     otu.setMaintLoopback(maintLoopBackBuilder.build());
 126                 }
 127                 otuBuilder.setOtu(otu.build());
 128                 ifBuilder.addAugmentation(otuBuilder.build());
 129             }
 130             ifBuilder.setAdministrativeState(AdminStates.OutOfService);
 131             // post interface with updated admin state
 132             try {
 133                 postInterface(nodeId, ifBuilder);
 134             } catch (OpenRoadmInterfaceException ex) {
 135                 throw new OpenRoadmInterfaceException(String.format("Failed to set state of interface %s to %s while"
 136                     + " deleting it!", interfaceName, AdminStates.OutOfService), ex);
 137             }
 138
 139             InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 140                 Interface.class, new InterfaceKey(interfaceName));
 141             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 142                 nodeId);
 143             DeviceTransaction deviceTx;
 144             try {
 145                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 146                 if (deviceTxOpt.isPresent()) {
 147                     deviceTx = deviceTxOpt.get();
 148                 } else {
 149                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 150                         nodeId));
 151                 }
 152             } catch (InterruptedException | ExecutionException e) {
 153                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 154                     nodeId), e);
 155             }
 156
 157             deviceTx.delete(LogicalDatastoreType.CONFIGURATION, interfacesIID);
 158             FluentFuture<? extends @NonNull CommitInfo> commit =
 159                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 160
 161             try {
 162                 commit.get();
 163                 LOG.info("Successfully deleted {} on node {}", interfaceName, nodeId);
 164             } catch (InterruptedException | ExecutionException e) {
 165                 throw new OpenRoadmInterfaceException(String.format("Failed to delete interface %s on " + "node %s",
 166                     interfaceName, nodeId), e);
 167             }
 168             // change the equipment state on circuit pack if xpdr node
 169             if (intf2Delete.getName().contains(StringConstants.CLIENT_TOKEN) || intf2Delete.getName().contains(
 170                 StringConstants.NETWORK_TOKEN)) {
 171                 postEquipmentState(nodeId, intf2Delete.getSupportingCircuitPackName(), false);
 172             }
 173
 174         } else {
 175             LOG.info("Interface does not exist, cannot delete on node {}", nodeId);
 176         }
 177     }
 178
 179     public void postEquipmentState(String nodeId, String circuitPackName, boolean activate)
 180         throws OpenRoadmInterfaceException {
 181
 182         InstanceIdentifier<CircuitPacks> circuitPackIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 183             CircuitPacks.class, new CircuitPacksKey(circuitPackName));
 184         Optional<CircuitPacks> cpOpt = this.deviceTransactionManager.getDataFromDevice(nodeId,
 185             LogicalDatastoreType.CONFIGURATION, circuitPackIID, Timeouts.DEVICE_READ_TIMEOUT,
 186             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 187         CircuitPacks cp = null;
 188         if (cpOpt.isPresent()) {
 189             cp = cpOpt.get();
 190         } else {
 191             throw new OpenRoadmInterfaceException(String.format(
 192                 "Could not find CircuitPack %s in equipment config datastore for node %s", circuitPackName, nodeId));
 193         }
 194         CircuitPacksBuilder cpBldr = new CircuitPacksBuilder(cp);
 195         boolean change = false;
 196         if (activate) {
 197             if (cpBldr.getEquipmentState() != null && !cpBldr.getEquipmentState().equals(States.NotReservedInuse)) {
 198                 cpBldr.setEquipmentState(States.NotReservedInuse);
 199                 change = true;
 200             }
 201         } else if (
 202             (cpBldr.getEquipmentState() != null && !cpBldr.getEquipmentState().equals(States.NotReservedAvailable))) {
 203             cpBldr.setEquipmentState(States.NotReservedAvailable);
 204             change = true;
 205         }
 206         if (change) {
 207             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 208                 nodeId);
 209             DeviceTransaction deviceTx;
 210             try {
 211                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 212                 if (deviceTxOpt.isPresent()) {
 213                     deviceTx = deviceTxOpt.get();
 214                 } else {
 215                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 216                         nodeId));
 217                 }
 218             } catch (InterruptedException | ExecutionException e) {
 219                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 220                     nodeId), e);
 221             }
 222             deviceTx.merge(LogicalDatastoreType.CONFIGURATION, circuitPackIID, cpBldr.build());
 223             FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
 224                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 225             try {
 226                 txSubmitFuture.get();
 227                 LOG.info("Successfully posted equipment state change on node {}", nodeId);
 228             } catch (InterruptedException | ExecutionException e) {
 229                 throw new OpenRoadmInterfaceException(String.format("Failed to post equipment state on node %s!",
 230                     nodeId), e);
 231             }
 232         }
 233     }
 234
 235     public String getSupportedInterface(String nodeId, String interf) {
 236         Optional<Interface> supInterfOpt;
 237         try {
 238             supInterfOpt = getInterface(nodeId, interf);
 239             if (supInterfOpt.isPresent()) {
 240                 return supInterfOpt.get().getSupportingInterface();
 241             } else {
 242                 return null;
 243             }
 244         } catch (OpenRoadmInterfaceException e) {
 245             LOG.error("error getting Supported Interface of {} - {}", interf, nodeId, e);
 246             return null;
 247         }
 248     }
 249
 250 }