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,String serviceName)
  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",serviceName);
  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                                               String serviceName)
  98         throws OpenRoadmInterfaceException {
  99         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 100         if (portMap == null) {
 101             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
 102                 + " logical connection port %s", nodeId, logicalConnPoint));
 103         }
 104         // Create generic interface
 105         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 106             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber),serviceName);
 107
 108         // OCH interface specific data
 109         OchBuilder ocIfBuilder = new OchBuilder();
 110         ocIfBuilder.setWavelengthNumber(waveNumber);
 111
 112         // Add supporting OMS interface
 113         if (portMap.getSupportingOms() != null) {
 114             ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
 115         }
 116         // Create Interface1 type object required for adding as augmentation
 117         // TODO look at imports of different versions of class
 118         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 119             .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 120             .interfaces.rev161014.Interface1Builder();
 121         ochInterfaceBldr.addAugmentation(
 122             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
 123             ochIf1Builder.setOch(ocIfBuilder.build()).build());
 124
 125         // Post interface on the device
 126         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 127
 128         // Post the equipment-state change on the device circuit-pack if xpdr node
 129         if (portMap.getLogicalConnectionPoint().contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
 130             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 131         }
 132         return ochInterfaceBldr.getName();
 133     }
 134
 135     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber, Class<
 136         ? extends RateIdentity> rate, OchAttributes.ModulationFormat format,String serviceName)
 137         throws OpenRoadmInterfaceException {
 138         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 139         if (portMap == null) {
 140             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
 141                 + " logical connection port %s", nodeId, logicalConnPoint));
 142         }
 143
 144         // OCH interface specific data
 145         OchBuilder ocIfBuilder = new OchBuilder();
 146         ocIfBuilder.setWavelengthNumber(waveNumber);
 147         ocIfBuilder.setModulationFormat(format);
 148         ocIfBuilder.setRate(rate);
 149         ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
 150
 151         // Create Interface1 type object required for adding as augmentation
 152         // TODO look at imports of different versions of class
 153         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 154             .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 155             .interfaces.rev161014.Interface1Builder();
 156         // Create generic interface
 157         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 158             createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber),serviceName);
 159         ochInterfaceBldr.addAugmentation(
 160             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
 161             ochIf1Builder.setOch(ocIfBuilder.build()).build());
 162
 163         // Post interface on the device
 164         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 165
 166         // Post the equipment-state change on the device circuit-pack if xpdr node
 167         if (portMap.getLogicalConnectionPoint().contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
 168             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 169         }
 170         return ochInterfaceBldr.getName();
 171     }
 172
 173     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
 174         return logicalConnectionPoint + "-" + waveNumber;
 175     }
 176
 177     /**
 178      * This methods creates an ODU interface on the given termination point.
 179      *
 180      *
 181      * @return Name of the interface if successful, otherwise return null.
 182      */
 183
 184     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface,
 185                                                String serviceName)
 186         throws OpenRoadmInterfaceException {
 187         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 188         if (portMap == null) {
 189             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 190                 + " logical connection port %s", nodeId, logicalConnPoint));
 191         }
 192         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
 193             + "-ODU",serviceName);
 194         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
 195
 196         // ODU interface specific data
 197         OduBuilder oduIfBuilder = new OduBuilder();
 198         oduIfBuilder.setRate(ODU4.class);
 199         oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
 200
 201         // Set Opu attributes
 202         OpuBuilder opuBldr = new OpuBuilder();
 203         opuBldr.setPayloadType("07");
 204         opuBldr.setExpPayloadType("07");
 205         oduIfBuilder.setOpu(opuBldr.build());
 206
 207         // Create Interface1 type object required for adding as augmentation
 208         // TODO look at imports of different versions of class
 209         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
 210             new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
 211         oduInterfaceBldr.addAugmentation(
 212             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1.class, oduIf1Builder
 213                 .setOdu(oduIfBuilder.build()).build());
 214
 215         // Post interface on the device
 216         this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
 217         return oduInterfaceBldr.getName();
 218     }
 219
 220     /**
 221      * This methods creates an OTU interface on the given termination point.
 222      *
 223      *
 224      * @return Name of the interface if successful, otherwise return null.
 225      * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
 226      */
 227
 228     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface,
 229                                                String serviceName)
 230         throws OpenRoadmInterfaceException {
 231         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 232         if (portMap == null) {
 233             throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
 234                 + " logical connection port %s", nodeId, logicalConnPoint));
 235         }
 236         // Create generic interface
 237         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
 238             + "-OTU",serviceName);
 239         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
 240
 241         // OTU interface specific data
 242         OtuBuilder otuIfBuilder = new OtuBuilder();
 243         otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
 244         otuIfBuilder.setRate(OTU4.class);
 245
 246         // Create Interface1 type object required for adding as augmentation
 247         // TODO look at imports of different versions of class
 248         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
 249             new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
 250         otuInterfaceBldr.addAugmentation(
 251             org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1.class, otuIf1Builder
 252                 .setOtu(otuIfBuilder.build()).build());
 253
 254         // Post interface on the device
 255         this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
 256         return otuInterfaceBldr.getName();
 257     }
 258
 259     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 260         if (mapping.getSupportingOts() == null) {
 261             // Create generic interface
 262             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
 263                 + mapping.getLogicalConnectionPoint(),"");
 264             // OTS interface augmentation specific data
 265             OtsBuilder otsIfBuilder = new OtsBuilder();
 266             otsIfBuilder.setFiberType(FiberType.Smf);
 267
 268             // Create Interface1 type object required for adding as
 269             // augmentation
 270             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
 271                 .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport
 272                 .interfaces.rev161014.Interface1Builder();
 273             otsInterfaceBldr.addAugmentation(
 274                 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1.class,
 275                 otsIf1Builder.setOts(otsIfBuilder.build()).build());
 276             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
 277             this.portMapping.updateMapping(nodeId, mapping);
 278             return otsInterfaceBldr.build().getName();
 279         } else {
 280             return mapping.getSupportingOts();
 281         }
 282     }
 283
 284     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 285         if (mapping.getSupportingOms() == null) {
 286             // Create generic interface
 287             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
 288                 "OMS-" + mapping.getLogicalConnectionPoint(),"");
 289             if (mapping.getSupportingOts() != null) {
 290                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
 291             } else {
 292                 throw new OpenRoadmInterfaceException(String.format("Unable to get ots interface from mapping % - %",
 293                     nodeId, mapping.getLogicalConnectionPoint()));
 294             }
 295             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
 296             this.portMapping.updateMapping(nodeId, mapping);
 297             return omsInterfaceBldr.build().getName();
 298         } else {
 299             return mapping.getSupportingOms();
 300         }
 301     }
 302
 303     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
 304                                                            String key,String serviceName) {
 305         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
 306         interfaceBuilder.setDescription("  TBD   ");
 307         interfaceBuilder.setCircuitId(serviceName);
 308         interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
 309         interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
 310         interfaceBuilder.setAdministrativeState(AdminStates.InService);
 311         interfaceBuilder.setType(type);
 312         interfaceBuilder.setName(key);
 313         interfaceBuilder.withKey(new InterfaceKey(key));
 314         return interfaceBuilder;
 315     }
 316 }