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