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