renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.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 org.opendaylight.transportpce.common.mapping.PortMapping;
  13 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  14 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
  15 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfacesImpl;
  16 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
  17 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
  18 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
  19 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
  20 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
  21 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpenROADMOpticalMultiplex;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalTransport;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.RateIdentity;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes.FiberType;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.portmapping.rev170228.network.nodes.Mapping;
  44
  45 public class OpenRoadmInterfaceFactory {
  46     private final PortMapping portMapping;
  47     private final OpenRoadmInterfaces openRoadmInterfaces;
  48
  49     public OpenRoadmInterfaceFactory(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
  50         this.portMapping = portMapping;
  51         this.openRoadmInterfaces = openRoadmInterfaces;
  52     }
  53
  54     public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
  55         throws OpenRoadmInterfaceException {
  56         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
  57         if (portMap == null) {
  58             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
  59                 + " logical connection port %s", nodeId, logicalConnPoint));
  60         }
  61
  62         // Ethernet interface specific data
  63         EthernetBuilder ethIfBuilder = new EthernetBuilder();
  64         ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
  65         ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
  66         ethIfBuilder.setFec(EthAttributes.Fec.Off);
  67         ethIfBuilder.setSpeed(100000L);
  68         ethIfBuilder.setMtu(9000L);
  69
  70         InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
  71             logicalConnPoint + "-ETHERNET");
  72
  73         // Create Interface1 type object required for adding as augmentation
  74         Interface1Builder ethIf1Builder = new Interface1Builder();
  75         ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
  76
  77         // Post interface on the device
  78         this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
  79
  80         // Post the equipment-state change on the device circuit-pack
  81         this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
  82
  83         return ethInterfaceBldr.getName();
  84     }
  85
  86     /**
  87      * This methods creates an OCH interface on the given termination point on
  88      * Roadm.
  89      *
  90      * @param waveNumber
  91      *            wavelength number of the OCH interface.
  92      *
  93      * @return Name of the interface if successful, otherwise return null.
  94      */
  95
  96     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
  97         throws OpenRoadmInterfaceException {
  98         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
  99         if (portMap == null) {
 100             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
 101                 + " logical connection port %s", nodeId, logicalConnPoint));
 102         }
 103         // Create generic interface
 104         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 105             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
 106
 107         // OCH interface specific data
 108         OchBuilder ocIfBuilder = new OchBuilder();
 109         ocIfBuilder.setWavelengthNumber(waveNumber);
 110
 111         // Add supporting OMS interface
 112         if (portMap.getSupportingOms() != null) {
 113             ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
 114         }
 115         // Create Interface1 type object required for adding as augmentation
 116         // TODO look at imports of different versions of class
 117         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 118             .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 119             .interfaces.rev161014.Interface1Builder();
 120         ochInterfaceBldr.addAugmentation(
 121             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
 122             ochIf1Builder.setOch(ocIfBuilder.build()).build());
 123
 124         // Post interface on the device
 125         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 126
 127         // Post the equipment-state change on the device circuit-pack if xpdr node
 128         if (portMap.getLogicalConnectionPoint().contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
 129             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 130         }
 131         return ochInterfaceBldr.getName();
 132     }
 133
 134     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber, Class<
 135         ? extends RateIdentity> rate, OchAttributes.ModulationFormat format) throws OpenRoadmInterfaceException {
 136         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 137         if (portMap == null) {
 138             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
 139                 + " logical connection port %s", nodeId, logicalConnPoint));
 140         }
 141
 142         // OCH interface specific data
 143         OchBuilder ocIfBuilder = new OchBuilder();
 144         ocIfBuilder.setWavelengthNumber(waveNumber);
 145         ocIfBuilder.setModulationFormat(format);
 146         ocIfBuilder.setRate(rate);
 147         ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
 148
 149         // Create Interface1 type object required for adding as augmentation
 150         // TODO look at imports of different versions of class
 151         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 152             .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 153             .interfaces.rev161014.Interface1Builder();
 154         // Create generic interface
 155         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 156             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
 157         ochInterfaceBldr.addAugmentation(
 158             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
 159             ochIf1Builder.setOch(ocIfBuilder.build()).build());
 160
 161         // Post interface on the device
 162         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 163
 164         // Post the equipment-state change on the device circuit-pack if xpdr node
 165         if (portMap.getLogicalConnectionPoint().contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
 166             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 167         }
 168         return ochInterfaceBldr.getName();
 169     }
 170
 171     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
 172         return logicalConnectionPoint + "-" + waveNumber;
 173     }
 174
 175     /**
 176      * This methods creates an ODU interface on the given termination point.
 177      *
 178      *
 179      * @return Name of the interface if successful, otherwise return null.
 180      */
 181
 182     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 183         throws OpenRoadmInterfaceException {
 184         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 185         if (portMap == null) {
 186             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 187                 + " logical connection port %s", nodeId, logicalConnPoint));
 188         }
 189         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
 190             + "-ODU");
 191         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
 192
 193         // ODU interface specific data
 194         OduBuilder oduIfBuilder = new OduBuilder();
 195         oduIfBuilder.setRate(ODU4.class);
 196         oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
 197
 198         // Set Opu attributes
 199         OpuBuilder opuBldr = new OpuBuilder();
 200         opuBldr.setPayloadType("07");
 201         opuBldr.setExpPayloadType("07");
 202         oduIfBuilder.setOpu(opuBldr.build());
 203
 204         // Create Interface1 type object required for adding as augmentation
 205         // TODO look at imports of different versions of class
 206         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
 207             new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
 208         oduInterfaceBldr.addAugmentation(
 209             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1.class, oduIf1Builder
 210                 .setOdu(oduIfBuilder.build()).build());
 211
 212         // Post interface on the device
 213         this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
 214         return oduInterfaceBldr.getName();
 215     }
 216
 217     /**
 218      * This methods creates an OTU interface on the given termination point.
 219      *
 220      *
 221      * @return Name of the interface if successful, otherwise return null.
 222      */
 223
 224     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 225         throws OpenRoadmInterfaceException {
 226         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 227         if (portMap == null) {
 228             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 229                 + " logical connection port %s", nodeId, logicalConnPoint));
 230         }
 231         // Create generic interface
 232         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
 233             + "-OTU");
 234         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
 235
 236         // OTU interface specific data
 237         OtuBuilder otuIfBuilder = new OtuBuilder();
 238         otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
 239         otuIfBuilder.setRate(OTU4.class);
 240
 241         // Create Interface1 type object required for adding as augmentation
 242         // TODO look at imports of different versions of class
 243         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
 244             new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
 245         otuInterfaceBldr.addAugmentation(
 246             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1.class, otuIf1Builder
 247                 .setOtu(otuIfBuilder.build()).build());
 248
 249         // Post interface on the device
 250         this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
 251         return otuInterfaceBldr.getName();
 252     }
 253
 254     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 255         if (mapping.getSupportingOts() == null) {
 256             // Create generic interface
 257             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
 258                 + mapping.getLogicalConnectionPoint());
 259             // OTS interface augmentation specific data
 260             OtsBuilder otsIfBuilder = new OtsBuilder();
 261             otsIfBuilder.setFiberType(FiberType.Smf);
 262
 263             // Create Interface1 type object required for adding as
 264             // augmentation
 265             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
 266                 .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport
 267                 .interfaces.rev161014.Interface1Builder();
 268             otsInterfaceBldr.addAugmentation(
 269                 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1.class,
 270                 otsIf1Builder.setOts(otsIfBuilder.build()).build());
 271             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
 272             this.portMapping.updateMapping(nodeId, mapping);
 273             return otsInterfaceBldr.build().getName();
 274         } else {
 275             return mapping.getSupportingOts();
 276         }
 277     }
 278
 279     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 280         if (mapping.getSupportingOms() == null) {
 281             // Create generic interface
 282             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
 283                 "OMS-" + mapping.getLogicalConnectionPoint());
 284             if (mapping.getSupportingOts() != null) {
 285                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
 286             } else {
 287                 throw new OpenRoadmInterfaceException(String.format("Unable to get ots interface from mapping % - %",
 288                     nodeId, mapping.getLogicalConnectionPoint()));
 289             }
 290             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
 291             this.portMapping.updateMapping(nodeId, mapping);
 292             return omsInterfaceBldr.build().getName();
 293         } else {
 294             return mapping.getSupportingOms();
 295         }
 296     }
 297
 298     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
 299         String key) {
 300         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
 301         interfaceBuilder.setDescription("  TBD   ");
 302         interfaceBuilder.setCircuitId("   TBD    ");
 303         interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
 304         interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
 305         interfaceBuilder.setAdministrativeState(AdminStates.InService);
 306         interfaceBuilder.setType(type);
 307         interfaceBuilder.setName(key);
 308         interfaceBuilder.withKey(new InterfaceKey(key));
 309         return interfaceBuilder;
 310     }
 311 }