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