renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface22.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
  15 import org.opendaylight.transportpce.common.fixedflex.FixedFlexInterface;
  16 import org.opendaylight.transportpce.common.mapping.PortMapping;
  17 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  18 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
  19 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.nodes.Mapping;
  20 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyGHz;
  21 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyTHz;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.ModulationFormat;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PowerDBm;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.R100G;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev171215.AdminStates;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.EthAttributes;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1Builder;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.ethernet.container.EthernetBuilder;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.EthernetCsmacd;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.InterfaceType;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.MediaChannelTrailTerminationPoint;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.NetworkMediaChannelConnectionTerminationPoint;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpenROADMOpticalMultiplex;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalChannel;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalTransport;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOdu;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOtu;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.mc.ttp.container.McTtpBuilder;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.nmc.ctp.container.NmcCtpBuilder;
  43 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.och.container.OchBuilder;
  44 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.OtsAttributes;
  45 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.ots.container.OtsBuilder;
  46 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.ODU4;
  47 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.OTU4;
  48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.PayloadTypeDef;
  49 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.OduAttributes;
  50 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.odu.container.OduBuilder;
  51 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.opu.OpuBuilder;
  52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.OtuAttributes;
  53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.otu.container.OtuBuilder;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  57
  58
  59 public class OpenRoadmInterface22 {
  60     private final PortMapping portMapping;
  61     private final OpenRoadmInterfaces openRoadmInterfaces;
  62     private FixedFlexInterface fixedFlex;
  63     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfaceFactory.class);
  64
  65     public OpenRoadmInterface22(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces,
  66         FixedFlexInterface fixedFlex) {
  67         this.portMapping = portMapping;
  68         this.openRoadmInterfaces = openRoadmInterfaces;
  69         this.fixedFlex = fixedFlex;
  70     }
  71
  72     public String createOpenRoadmEthInterface(String nodeId,
  73                                               String logicalConnPoint) throws OpenRoadmInterfaceException {
  74         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
  75         if (portMap == null) {
  76             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
  77                 + " logical connection port %s", nodeId, logicalConnPoint));
  78         }
  79
  80         // Ethernet interface specific data
  81         EthernetBuilder ethIfBuilder = new EthernetBuilder();
  82         ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
  83         ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
  84         ethIfBuilder.setFec(EthAttributes.Fec.Off);
  85         ethIfBuilder.setSpeed(100000L);
  86         ethIfBuilder.setMtu(9000L);
  87
  88         InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
  89                                                                           logicalConnPoint + "-ETHERNET");
  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         openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
  96         return ethInterfaceBldr.getName();
  97     }
  98
  99     /**
 100      * This methods creates an OCH interface on the given termination point on
 101      * Roadm.
 102      *
 103      * @param waveNumber wavelength number of the OCH interface.
 104      * @return Name of the interface if successful, otherwise return null.
 105      */
 106
 107     public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
 108         throws OpenRoadmInterfaceException {
 109
 110         List<String> interfacesCreated = new ArrayList<>();
 111
 112         String nmcInterfaceCreated = createNMCInterface(nodeId,logicalConnPoint,waveNumber);
 113         interfacesCreated.add(nmcInterfaceCreated);
 114
 115         String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
 116         interfacesCreated.add(mcInterfaceCreated);
 117
 118         return interfacesCreated;
 119     }
 120
 121     public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
 122         throws OpenRoadmInterfaceException {
 123
 124         //TODO : Check this method
 125
 126         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
 127
 128         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 129         if (portMap == null) {
 130             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 131                 + " logical connection port %s", nodeId, logicalConnPoint));
 132         }
 133
 134         //TODO : Check this method
 135
 136         InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
 137             MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc");
 138         mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
 139
 140         McTtpBuilder mcTtpBuilder = new McTtpBuilder();
 141         mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
 142         mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
 143
 144         // Create Interface1 type object required for adding as augmentation
 145         org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
 146             interface1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel
 147             .interfaces.rev181019.Interface1Builder();
 148         interface1Builder.setMcTtp(mcTtpBuilder.build());
 149         mcInterfaceBldr.addAugmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel
 150             .interfaces.rev181019.Interface1.class,interface1Builder.build());
 151
 152         // Post interface on the device
 153         openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
 154         return mcInterfaceBldr.getName();
 155     }
 156
 157     public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
 158         throws OpenRoadmInterfaceException {
 159
 160         //TODO : Check this method
 161
 162         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
 163
 164         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 165         if (portMap == null) {
 166             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 167                 + " logical connection port %s", nodeId, logicalConnPoint));
 168         }
 169
 170         //TODO : Check this method
 171         InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
 172             NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc");
 173         nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc");
 174
 175         NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
 176
 177         nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
 178         nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
 179
 180         // Create Interface1 type object required for adding as augmentation
 181         org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019
 182             .Interface1Builder nmcCtpI1fBuilder = new org.opendaylight.yang.gen.v1.http
 183             .org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder();
 184         nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
 185         nmcInterfaceBldr.addAugmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.network
 186             .media.channel.interfaces.rev181019.Interface1.class,nmcCtpI1fBuilder.build());
 187
 188         // Post interface on the device
 189         openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
 190         return nmcInterfaceBldr.getName();
 191     }
 192
 193     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
 194         throws OpenRoadmInterfaceException {
 195         //TODO : Check this method
 196
 197         fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
 198
 199         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 200         if (portMap == null) {
 201             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
 202                 + " logical connection port %s", nodeId, logicalConnPoint));
 203         }
 204
 205         // OCH interface specific data
 206         OchBuilder ocIfBuilder = new OchBuilder();
 207
 208         ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
 209         //ocIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
 210         ocIfBuilder.setModulationFormat(ModulationFormat.DpQpsk);
 211         ocIfBuilder.setRate(R100G.class);
 212         ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
 213
 214         // Create generic interface
 215         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 216             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
 217         // Create Interface1 type object required for adding as augmentation
 218         // TODO look at imports of different versions of class
 219         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
 220                 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
 221                 .rev181019.Interface1Builder();
 222         ochInterfaceBldr.addAugmentation(
 223                 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
 224                 ochIf1Builder.setOch(ocIfBuilder.build()).build());
 225
 226         // Post interface on the device
 227         openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 228         return ochInterfaceBldr.getName();
 229     }
 230
 231     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 232             throws OpenRoadmInterfaceException {
 233         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 234         if (portMap == null) {
 235             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 236                 + " logical connection port %s", nodeId, logicalConnPoint));
 237         }
 238         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
 239                                                                           logicalConnPoint + "-ODU");
 240         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
 241
 242         // ODU interface specific data
 243         OduBuilder oduIfBuilder = new OduBuilder();
 244         oduIfBuilder.setRate(ODU4.class);
 245         oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
 246
 247         //Set Opu attributes
 248         OpuBuilder opuBldr = new OpuBuilder();
 249         opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
 250         opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
 251         oduIfBuilder.setOpu(opuBldr.build());
 252
 253
 254         // Create Interface1 type object required for adding as augmentation
 255         // TODO look at imports of different versions of class
 256         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder oduIf1Builder =
 257                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder();
 258         oduInterfaceBldr.addAugmentation(
 259                 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
 260                 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
 261
 262         // Post interface on the device
 263         openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
 264         return oduInterfaceBldr.getName();
 265     }
 266
 267     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 268             throws OpenRoadmInterfaceException {
 269         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 270         if (portMap == null) {
 271             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 272                 + " logical connection port %s", nodeId, logicalConnPoint));
 273         }
 274         // Create generic interface
 275         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
 276                                                                           logicalConnPoint + "-OTU");
 277         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
 278
 279         // OTU interface specific data
 280         OtuBuilder otuIfBuilder = new OtuBuilder();
 281         otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
 282         otuIfBuilder.setRate(OTU4.class);
 283
 284         // Create Interface1 type object required for adding as augmentation
 285         // TODO look at imports of different versions of class
 286         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder otuIf1Builder =
 287                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder();
 288         otuInterfaceBldr.addAugmentation(
 289                 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
 290                 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
 291
 292         // Post interface on the device
 293         openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
 294         return otuInterfaceBldr.getName();
 295     }
 296
 297     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
 298         return logicalConnectionPoint + "-" + waveNumber;
 299     }
 300
 301     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
 302                                                            String key) {
 303         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
 304         interfaceBuilder.setDescription("  TBD   ");
 305         interfaceBuilder.setCircuitId("   TBD    ");
 306         interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
 307         interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
 308         interfaceBuilder.setAdministrativeState(AdminStates.InService);
 309         interfaceBuilder.setType(type);
 310         interfaceBuilder.setName(key);
 311         interfaceBuilder.withKey(new InterfaceKey(key));
 312         return interfaceBuilder;
 313     }
 314
 315     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 316         if (mapping.getSupportingOms() == null) {
 317             // Create generic interface
 318             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
 319                 "OMS-" + mapping.getLogicalConnectionPoint());
 320             if (mapping.getSupportingOts() != null) {
 321                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
 322             } else {
 323                 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
 324                           mapping.getLogicalConnectionPoint());
 325                 return null;
 326             }
 327             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
 328             this.portMapping.updateMapping(nodeId, mapping);
 329             return omsInterfaceBldr.build().getName();
 330         } else {
 331             return mapping.getSupportingOms();
 332         }
 333     }
 334
 335     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 336         if (mapping.getSupportingOts() == null) {
 337             // Create generic interface
 338             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
 339                     + mapping.getLogicalConnectionPoint());
 340             // OTS interface augmentation specific data
 341             OtsBuilder otsIfBuilder = new OtsBuilder();
 342             otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
 343
 344             // Create Interface1 type object required for adding as
 345             // augmentation
 346             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019
 347                     .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org
 348                     .openroadm.optical.transport
 349                     .interfaces.rev181019.Interface1Builder();
 350             otsInterfaceBldr.addAugmentation(
 351                     org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019
 352                     .Interface1.class,
 353                     otsIf1Builder.setOts(otsIfBuilder.build()).build());
 354             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
 355             this.portMapping.updateMapping(nodeId, mapping);
 356             return otsInterfaceBldr.build().getName();
 357         } else {
 358             return mapping.getSupportingOts();
 359         }
 360     }
 361
 362 }