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