renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.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.renderer.openroadminterface;
  10
  11 import java.math.BigDecimal;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  16 import org.opendaylight.transportpce.common.StringConstants;
  17 import org.opendaylight.transportpce.common.Timeouts;
  18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  19 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
  20 import org.opendaylight.transportpce.common.mapping.PortMapping;
  21 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev201012.network.nodes.Mapping;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpenROADMOpticalMultiplex;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalTransport;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.R100G;
  43 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
  44 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes;
  45 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
  46 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
  47 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
  48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
  49 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
  50 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
  51 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
  52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.common.Uint32;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58
  59 public class OpenRoadmInterface121 {
  60     private static final String MAPPING_MSG_ERROR =
  61             "Unable to get mapping from PortMapping for node % and logical connection port %s";
  62     private final PortMapping portMapping;
  63     private final OpenRoadmInterfaces openRoadmInterfaces;
  64     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterface121.class);
  65
  66     public  OpenRoadmInterface121(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
  67         this.portMapping = portMapping;
  68         this.openRoadmInterfaces = openRoadmInterfaces;
  69     }
  70
  71     public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
  72             throws OpenRoadmInterfaceException {
  73         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
  74         if (portMap == null) {
  75             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
  76         }
  77
  78         // Ethernet interface specific data
  79         EthernetBuilder ethIfBuilder = new EthernetBuilder()
  80                 .setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled)
  81                 .setDuplex(EthAttributes.Duplex.Full)
  82                 .setFec(EthAttributes.Fec.Off)
  83                 .setSpeed(Uint32.valueOf(100000))
  84                 .setMtu(Uint32.valueOf(9000));
  85
  86         InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
  87                                                                           logicalConnPoint + "-ETHERNET");
  88
  89         // Create Interface1 type object required for adding as augmentation
  90         Interface1Builder ethIf1Builder = new Interface1Builder();
  91         ethInterfaceBldr.addAugmentation(ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
  92
  93         // Post interface on the device
  94         this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
  95
  96         // Post the equipment-state change on the device circuit-pack
  97         this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
  98
  99         return ethInterfaceBldr.getName();
 100     }
 101
 102     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
 103                                                            String key) {
 104         return new InterfaceBuilder()
 105                 .setDescription("  TBD   ")
 106                 .setCircuitId("   TBD    ")
 107                 .setSupportingCircuitPackName(portMap.getSupportingCircuitPackName())
 108                 .setSupportingPort(portMap.getSupportingPort())
 109                 .setAdministrativeState(AdminStates.InService)
 110                 .setType(type)
 111                 .setName(key)
 112                 .withKey(new InterfaceKey(key));
 113     }
 114     /**
 115      * This methods creates an OTU interface on the given termination point.
 116      *
 117      * @param nodeId node ID
 118      * @param logicalConnPoint logical Connection Point
 119      * @param supportOchInterface support OCH Interface
 120      *
 121      * @return Name of the interface if successful, otherwise return null.
 122      * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
 123      */
 124
 125     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 126             throws OpenRoadmInterfaceException {
 127         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 128         if (portMap == null) {
 129             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
 130         }
 131         // Create generic interface
 132         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
 133                 + "-OTU");
 134         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
 135
 136         // OTU interface specific data
 137         OtuBuilder otuIfBuilder = new OtuBuilder()
 138                 .setFec(OtuAttributes.Fec.Scfec)
 139                 .setRate(OTU4.class);
 140
 141         // Create Interface1 type object required for adding as augmentation
 142         // TODO look at imports of different versions of class
 143         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
 144                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
 145         otuInterfaceBldr.addAugmentation(otuIf1Builder.setOtu(otuIfBuilder.build()).build());
 146
 147         // Post interface on the device
 148         this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
 149         return otuInterfaceBldr.getName();
 150     }
 151
 152     /**
 153      * This methods creates an ODU interface on the given termination point.
 154      *
 155      * @param nodeId node ID
 156      * @param logicalConnPoint logical Connection Point
 157      * @param supportingOtuInterface supporting OTU Interface
 158      *
 159      * @return Name of the interface if successful, otherwise return null.
 160      * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
 161      */
 162
 163     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 164             throws OpenRoadmInterfaceException {
 165         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 166         if (portMap == null) {
 167             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
 168         }
 169         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
 170                 + "-ODU");
 171         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
 172
 173         // ODU interface specific data
 174         // Set Opu attributes
 175         OpuBuilder opuBldr = new OpuBuilder()
 176                 .setPayloadType("07")
 177                 .setExpPayloadType("07");
 178         OduBuilder oduIfBuilder = new OduBuilder()
 179                 .setRate(ODU4.class)
 180                 .setMonitoringMode(OduAttributes.MonitoringMode.Terminated)
 181                 .setOpu(opuBldr.build());
 182
 183         // Create Interface1 type object required for adding as augmentation
 184         // TODO look at imports of different versions of class
 185         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
 186                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
 187         oduInterfaceBldr.addAugmentation(oduIf1Builder.setOdu(oduIfBuilder.build()).build());
 188
 189         // Post interface on the device
 190         this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
 191         return oduInterfaceBldr.getName();
 192     }
 193     /**
 194      * This methods creates an OCH interface on the given termination point on
 195      * Roadm.
 196      *
 197      * @param nodeId node ID
 198      * @param logicalConnPoint logical connection point
 199      * @param waveNumber wavelength number of the OCH interface.
 200      * @param lowerSpectralSlotNumber int
 201      * @param higherSpectralSlotNumber int
 202      * @return Name of the interface if successful, otherwise return null.
 203      *
 204      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 205      */
 206
 207     public List<String> createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber,
 208             int lowerSpectralSlotNumber, int higherSpectralSlotNumber)
 209         throws OpenRoadmInterfaceException {
 210         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 211         if (portMap == null) {
 212             throw new OpenRoadmInterfaceException(String.format(
 213                 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
 214                     nodeId, logicalConnPoint));
 215         }
 216         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
 217                 String.valueOf(lowerSpectralSlotNumber),
 218                 String.valueOf(higherSpectralSlotNumber));
 219         // Create generic interface
 220         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 221             createOpenRoadmOchInterfaceName(logicalConnPoint, spectralSlotName));
 222
 223         // OCH interface specific data
 224         OchBuilder ocIfBuilder = new OchBuilder().setWavelengthNumber(Uint32.valueOf(waveNumber));
 225
 226         // Add supporting OMS interface
 227         if (portMap.getSupportingOms() != null) {
 228             ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
 229         }
 230         // Create Interface1 type object required for adding as augmentation
 231         // TODO look at imports of different versions of class
 232         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
 233                 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
 234                 .rev161014.Interface1Builder();
 235         ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
 236
 237         List<String> interfacesCreated = new ArrayList<>();
 238         // Post interface on the device
 239         openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 240         interfacesCreated.add(ochInterfaceBldr.getName());
 241         return interfacesCreated;
 242     }
 243
 244     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber,
 245         OchAttributes.ModulationFormat format, int lowerSpectralSlotNumber, int higherSpectralSlotNumber)
 246                 throws OpenRoadmInterfaceException {
 247         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 248         if (portMap == null) {
 249             throw new OpenRoadmInterfaceException(String.format(
 250                 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
 251                     nodeId, logicalConnPoint));
 252         }
 253         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
 254                 String.valueOf(lowerSpectralSlotNumber),
 255                 String.valueOf(higherSpectralSlotNumber));
 256         // OCH interface specific data
 257         OchBuilder ocIfBuilder = new OchBuilder()
 258                 .setWavelengthNumber(Uint32.valueOf(waveNumber))
 259                 .setModulationFormat(format)
 260                 .setRate(R100G.class)
 261                 .setTransmitPower(new PowerDBm(new BigDecimal("-5")));
 262
 263         // Create Interface1 type object required for adding as augmentation
 264         // TODO look at imports of different versions of class
 265         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 266                 .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 267                 .interfaces.rev161014.Interface1Builder();
 268         // Create generic interface
 269         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 270             createOpenRoadmOchInterfaceName(logicalConnPoint, spectralSlotName));
 271         ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
 272
 273         // Post interface on the device
 274         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 275
 276         // Post the equipment-state change on the device circuit-pack if xpdr node
 277         if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
 278             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 279         }
 280         return ochInterfaceBldr.getName();
 281     }
 282
 283     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotName) {
 284         return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotName);
 285     }
 286
 287     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 288         if (mapping.getSupportingOms() == null) {
 289             // Create generic interface
 290             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
 291                 "OMS-" + mapping.getLogicalConnectionPoint());
 292             if (mapping.getSupportingOts() != null) {
 293                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
 294             } else {
 295                 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
 296                           mapping.getLogicalConnectionPoint());
 297                 return null;
 298             }
 299             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
 300             this.portMapping.updateMapping(nodeId, mapping);
 301             return omsInterfaceBldr.build().getName();
 302         } else {
 303             return mapping.getSupportingOms();
 304         }
 305     }
 306
 307     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 308         if (mapping.getSupportingOts() == null) {
 309             // Create generic interface
 310             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
 311                     + mapping.getLogicalConnectionPoint());
 312             // OTS interface augmentation specific data
 313             OtsBuilder otsIfBuilder = new OtsBuilder();
 314             otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
 315
 316             // Create Interface1 type object required for adding as
 317             // augmentation
 318             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
 319                     .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm
 320                     .optical.transport.interfaces.rev161014.Interface1Builder();
 321             otsInterfaceBldr.addAugmentation(otsIf1Builder.setOts(otsIfBuilder.build()).build());
 322             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
 323             this.portMapping.updateMapping(nodeId, mapping);
 324             return otsInterfaceBldr.build().getName();
 325         } else {
 326             return mapping.getSupportingOts();
 327         }
 328     }
 329
 330     public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
 331         DeviceTransactionManager deviceTransactionManager) {
 332         InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 333             .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
 334         LOG.info("reading xc {} in node {}", xc, nodeId);
 335         Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
 336             LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 337         if (crossconnection.isPresent()) {
 338             RoadmConnections rc = crossconnection.get();
 339             LOG.info("xd {} found", xc);
 340             if (rc.getSource().getSrcIf().equals(interfaceName)
 341                 || rc.getDestination().getDstIf().equals(interfaceName)) {
 342                 return true;
 343             }
 344         } else {
 345             LOG.info("xd {} not found !", xc);
 346         }
 347         return false;
 348     }
 349
 350 }