2 * Copyright © 2017 AT&T and others. All rights reserved.
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
9 package org.opendaylight.transportpce.renderer.openroadminterface;
11 import java.math.BigDecimal;
12 import java.util.ArrayList;
13 import java.util.List;
14 import java.util.Optional;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.transportpce.common.StringConstants;
18 import org.opendaylight.transportpce.common.Timeouts;
19 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
20 import org.opendaylight.transportpce.common.fixedflex.FixedFlexInterface;
21 import org.opendaylight.transportpce.common.mapping.PortMapping;
22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
23 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev190702.network.nodes.Mapping;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyGHz;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyTHz;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PowerDBm;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.R100G;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev171215.AdminStates;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.EthAttributes;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.Interface1Builder;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev181019.ethernet.container.EthernetBuilder;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.EthernetCsmacd;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.InterfaceType;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.MediaChannelTrailTerminationPoint;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.NetworkMediaChannelConnectionTerminationPoint;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpenROADMOpticalMultiplex;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalChannel;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalTransport;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOdu;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOtu;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.mc.ttp.container.McTtpBuilder;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.nmc.ctp.container.NmcCtpBuilder;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.och.container.OchBuilder;
51 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.OtsAttributes;
52 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.ots.container.OtsBuilder;
53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.ODU4;
54 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.OTU4;
55 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev171215.PayloadTypeDef;
56 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.OduAttributes;
57 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.odu.container.OduBuilder;
58 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.opu.OpuBuilder;
59 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.OtuAttributes;
60 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.otu.container.OtuBuilder;
61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
65 public class OpenRoadmInterface221 {
66 private final PortMapping portMapping;
67 private final OpenRoadmInterfaces openRoadmInterfaces;
68 private FixedFlexInterface fixedFlex;
69 private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfaceFactory.class);
71 public OpenRoadmInterface221(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces,
72 FixedFlexInterface fixedFlex) {
73 this.portMapping = portMapping;
74 this.openRoadmInterfaces = openRoadmInterfaces;
75 this.fixedFlex = fixedFlex;
78 public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
79 throws OpenRoadmInterfaceException {
80 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
81 if (portMap == null) {
82 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
83 + " logical connection port %s", nodeId, logicalConnPoint));
86 // Ethernet interface specific data
87 EthernetBuilder ethIfBuilder = new EthernetBuilder();
88 //ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
89 //ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
90 ethIfBuilder.setFec(EthAttributes.Fec.Off);
91 ethIfBuilder.setSpeed(100000L);
92 //ethIfBuilder.setMtu(9000L);
94 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
95 logicalConnPoint + "-ETHERNET");
96 // Create Interface1 type object required for adding as augmentation
97 Interface1Builder ethIf1Builder = new Interface1Builder();
98 ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
100 // Post interface on the device
101 openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
103 // Post the equipment-state change on the device circuit-pack
104 openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
106 return ethInterfaceBldr.getName();
110 * This methods creates an OCH interface on the given termination point on
113 * @param nodeId node ID
114 * @param logicalConnPoint logical connection point
115 * @param waveNumber wavelength number of the OCH interface.
117 * @return Name of the interface if successful, otherwise return null.
119 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
122 public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
123 throws OpenRoadmInterfaceException {
125 List<String> interfacesCreated = new ArrayList<>();
127 if (logicalConnPoint.contains("DEG")) {
128 String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
129 interfacesCreated.add(mcInterfaceCreated);
132 String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
133 interfacesCreated.add(nmcInterfaceCreated);
135 return interfacesCreated;
138 public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
139 throws OpenRoadmInterfaceException {
141 // TODO : Check this method
143 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
145 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
146 if (portMap == null) {
147 throw new OpenRoadmInterfaceException(
148 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
149 nodeId, logicalConnPoint));
152 // TODO : Check this method
154 InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
155 MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc" + "-" + waveNumber);
156 mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
158 McTtpBuilder mcTtpBuilder = new McTtpBuilder();
159 mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
160 mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
162 // Create Interface1 type object required for adding as augmentation
163 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
165 new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder();
166 interface1Builder.setMcTtp(mcTtpBuilder.build());
167 mcInterfaceBldr.addAugmentation(
168 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
169 interface1Builder.build());
171 // Post interface on the device
172 openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
173 return mcInterfaceBldr.getName();
176 public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
177 throws OpenRoadmInterfaceException {
179 // TODO : Check this method
181 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
183 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
184 if (portMap == null) {
185 throw new OpenRoadmInterfaceException(
186 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
187 nodeId, logicalConnPoint));
190 LOG.info(" Freq Start {} and Freq End {} and center-Freq {}",
191 String.valueOf(fixedFlex.getStart()), String.valueOf(fixedFlex.getStop()),
192 String.valueOf(fixedFlex.getCenterFrequency()));
193 //TODO : Check this method
194 InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
195 NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc" + "-" + waveNumber);
196 if (logicalConnPoint.contains("DEG")) {
197 nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc" + "-" + waveNumber);
200 NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
202 nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
203 nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance("40"));
205 // Create Interface1 type object required for adding as augmentation
206 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
207 nmcCtpI1fBuilder = new
208 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019
209 .Interface1Builder();
210 nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
211 nmcInterfaceBldr.addAugmentation(
212 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
213 nmcCtpI1fBuilder.build());
215 // Post interface on the device
216 openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
217 return nmcInterfaceBldr.getName();
220 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
221 throws OpenRoadmInterfaceException {
222 // TODO : Check this method
224 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
226 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
227 if (portMap == null) {
228 throw new OpenRoadmInterfaceException(
229 String.format("Unable to get mapping from PortMapping for node %s and logical connection port %s",
230 nodeId, logicalConnPoint));
233 // OCH interface specific data
234 OchBuilder ocIfBuilder = new OchBuilder();
236 ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
237 ocIfBuilder.setRate(R100G.class);
238 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
240 // Create generic interface
241 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
242 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
243 // Create Interface1 type object required for adding as augmentation
244 // TODO look at imports of different versions of class
245 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
246 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
247 .Interface1Builder();
248 ochInterfaceBldr.addAugmentation(
249 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
250 ochIf1Builder.setOch(ocIfBuilder.build()).build());
252 // Post interface on the device
253 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
255 // Post the equipment-state change on the device circuit-pack if xpdr node
256 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
257 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
260 return ochInterfaceBldr.getName();
263 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
264 throws OpenRoadmInterfaceException {
265 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
266 if (portMap == null) {
267 throw new OpenRoadmInterfaceException(
268 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
269 nodeId, logicalConnPoint));
271 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
272 logicalConnPoint + "-ODU");
273 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
275 // ODU interface specific data
276 OduBuilder oduIfBuilder = new OduBuilder();
277 oduIfBuilder.setRate(ODU4.class);
278 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
280 // Set Opu attributes
281 OpuBuilder opuBldr = new OpuBuilder();
282 opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
283 opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
284 oduIfBuilder.setOpu(opuBldr.build());
286 // Create Interface1 type object required for adding as augmentation
287 // TODO look at imports of different versions of class
288 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder oduIf1Builder =
289 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder();
290 oduInterfaceBldr.addAugmentation(
291 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
292 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
294 // Post interface on the device
295 openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
296 return oduInterfaceBldr.getName();
299 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
300 throws OpenRoadmInterfaceException {
301 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
302 if (portMap == null) {
303 throw new OpenRoadmInterfaceException(
304 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
305 nodeId, logicalConnPoint));
307 // Create generic interface
308 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
309 logicalConnPoint + "-OTU");
310 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
312 // OTU interface specific data
313 OtuBuilder otuIfBuilder = new OtuBuilder();
314 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
315 otuIfBuilder.setRate(OTU4.class);
317 // Create Interface1 type object required for adding as augmentation
318 // TODO look at imports of different versions of class
319 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder otuIf1Builder =
320 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder();
321 otuInterfaceBldr.addAugmentation(
322 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
323 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
325 // Post interface on the device
326 openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
327 return otuInterfaceBldr.getName();
330 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
331 return logicalConnectionPoint + "-" + waveNumber;
334 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
336 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
337 interfaceBuilder.setDescription(" TBD ");
338 interfaceBuilder.setCircuitId(" TBD ");
339 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
340 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
341 interfaceBuilder.setAdministrativeState(AdminStates.InService);
342 interfaceBuilder.setType(type);
343 interfaceBuilder.setName(key);
344 interfaceBuilder.withKey(new InterfaceKey(key));
345 return interfaceBuilder;
348 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
349 if (mapping.getSupportingOms() == null) {
350 // Create generic interface
351 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
352 "OMS-" + mapping.getLogicalConnectionPoint());
353 if (mapping.getSupportingOts() != null) {
354 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
356 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
357 mapping.getLogicalConnectionPoint());
360 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
361 this.portMapping.updateMapping(nodeId, mapping);
362 return omsInterfaceBldr.build().getName();
364 return mapping.getSupportingOms();
368 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
369 if (mapping.getSupportingOts() == null) {
370 // Create generic interface
371 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
372 + mapping.getLogicalConnectionPoint());
373 // OTS interface augmentation specific data
374 OtsBuilder otsIfBuilder = new OtsBuilder();
375 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
377 // Create Interface1 type object required for adding as
379 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
380 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
381 .rev181019.Interface1Builder();
382 otsInterfaceBldr.addAugmentation(
383 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
384 otsIf1Builder.setOts(otsIfBuilder.build()).build());
385 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
386 this.portMapping.updateMapping(nodeId, mapping);
387 return otsInterfaceBldr.build().getName();
389 return mapping.getSupportingOts();
393 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
394 DeviceTransactionManager deviceTransactionManager) {
395 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
396 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
397 LOG.info("reading xc {} in node {}", xc, nodeId);
398 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
399 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
400 if (crossconnection.isPresent()) {
401 RoadmConnections rc = crossconnection.get();
402 LOG.info("xd {} found", xc);
403 String supportedinter = null;
404 if (!interfaceName.contains("nmc")) {
405 supportedinter = interfaceName.replace("mc", "nmc");
407 if (rc.getSource().getSrcIf().equals(interfaceName)
408 || rc.getDestination().getDstIf().equals(interfaceName)
409 || rc.getSource().getSrcIf().equals(supportedinter)
410 || rc.getDestination().getDstIf().equals(supportedinter)) {
414 LOG.info("xd {} not found !", xc);