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