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