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