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.setFec(EthAttributes.Fec.Off);
89 ethIfBuilder.setSpeed(100000L);
91 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
92 logicalConnPoint + "-ETHERNET");
93 // Create Interface1 type object required for adding as augmentation
94 Interface1Builder ethIf1Builder = new Interface1Builder();
95 ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
97 // Post interface on the device
98 openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
100 // Post the equipment-state change on the device circuit-pack
101 openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
103 return ethInterfaceBldr.getName();
107 * This methods creates an OCH interface on the given termination point on
110 * @param nodeId node ID
111 * @param logicalConnPoint logical connection point
112 * @param waveNumber wavelength number of the OCH interface.
114 * @return Name of the interface if successful, otherwise return null.
116 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
119 public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
120 throws OpenRoadmInterfaceException {
122 List<String> interfacesCreated = new ArrayList<>();
124 if (logicalConnPoint.contains("DEG")) {
125 String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
126 interfacesCreated.add(mcInterfaceCreated);
129 String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
130 interfacesCreated.add(nmcInterfaceCreated);
132 return interfacesCreated;
135 public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
136 throws OpenRoadmInterfaceException {
138 // TODO : Check this method
140 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
142 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
143 if (portMap == null) {
144 throw new OpenRoadmInterfaceException(
145 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
146 nodeId, logicalConnPoint));
149 // TODO : Check this method
151 InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
152 MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc" + "-" + waveNumber);
153 mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
155 McTtpBuilder mcTtpBuilder = new McTtpBuilder();
156 mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
157 mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
159 // Create Interface1 type object required for adding as augmentation
160 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
162 new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder();
163 interface1Builder.setMcTtp(mcTtpBuilder.build());
164 mcInterfaceBldr.addAugmentation(
165 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
166 interface1Builder.build());
168 // Post interface on the device
169 openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
170 return mcInterfaceBldr.getName();
173 public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
174 throws OpenRoadmInterfaceException {
176 // TODO : Check this method
178 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
180 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
181 if (portMap == null) {
182 throw new OpenRoadmInterfaceException(
183 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
184 nodeId, logicalConnPoint));
187 LOG.info(" Freq Start {} and Freq End {} and center-Freq {}",
188 String.valueOf(fixedFlex.getStart()), String.valueOf(fixedFlex.getStop()),
189 String.valueOf(fixedFlex.getCenterFrequency()));
190 //TODO : Check this method
191 InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
192 NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc" + "-" + waveNumber);
193 if (logicalConnPoint.contains("DEG")) {
194 nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc" + "-" + waveNumber);
197 NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
199 nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
200 nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance("40"));
202 // Create Interface1 type object required for adding as augmentation
203 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
204 nmcCtpI1fBuilder = new
205 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019
206 .Interface1Builder();
207 nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
208 nmcInterfaceBldr.addAugmentation(
209 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
210 nmcCtpI1fBuilder.build());
212 // Post interface on the device
213 openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
214 return nmcInterfaceBldr.getName();
217 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
218 throws OpenRoadmInterfaceException {
219 // TODO : Check this method
221 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
223 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
224 if (portMap == null) {
225 throw new OpenRoadmInterfaceException(
226 String.format("Unable to get mapping from PortMapping for node %s and logical connection port %s",
227 nodeId, logicalConnPoint));
230 // OCH interface specific data
231 OchBuilder ocIfBuilder = new OchBuilder();
233 ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
234 ocIfBuilder.setRate(R100G.class);
235 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
237 // Create generic interface
238 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
239 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
240 // Create Interface1 type object required for adding as augmentation
241 // TODO look at imports of different versions of class
242 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
243 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
244 .Interface1Builder();
245 ochInterfaceBldr.addAugmentation(
246 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
247 ochIf1Builder.setOch(ocIfBuilder.build()).build());
249 // Post interface on the device
250 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
252 // Post the equipment-state change on the device circuit-pack if xpdr node
253 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
254 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
257 return ochInterfaceBldr.getName();
260 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
261 throws OpenRoadmInterfaceException {
262 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
263 if (portMap == null) {
264 throw new OpenRoadmInterfaceException(
265 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
266 nodeId, logicalConnPoint));
268 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
269 logicalConnPoint + "-ODU");
270 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
272 // ODU interface specific data
273 OduBuilder oduIfBuilder = new OduBuilder();
274 oduIfBuilder.setRate(ODU4.class);
275 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
277 // Set Opu attributes
278 OpuBuilder opuBldr = new OpuBuilder();
279 opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
280 opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
281 oduIfBuilder.setOpu(opuBldr.build());
283 // Create Interface1 type object required for adding as augmentation
284 // TODO look at imports of different versions of class
285 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder oduIf1Builder =
286 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder();
287 oduInterfaceBldr.addAugmentation(
288 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
289 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
291 // Post interface on the device
292 openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
293 return oduInterfaceBldr.getName();
296 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
297 throws OpenRoadmInterfaceException {
298 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
299 if (portMap == null) {
300 throw new OpenRoadmInterfaceException(
301 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
302 nodeId, logicalConnPoint));
304 // Create generic interface
305 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
306 logicalConnPoint + "-OTU");
307 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
309 // OTU interface specific data
310 OtuBuilder otuIfBuilder = new OtuBuilder();
311 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
312 otuIfBuilder.setRate(OTU4.class);
314 // Create Interface1 type object required for adding as augmentation
315 // TODO look at imports of different versions of class
316 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder otuIf1Builder =
317 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder();
318 otuInterfaceBldr.addAugmentation(
319 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
320 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
322 // Post interface on the device
323 openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
324 return otuInterfaceBldr.getName();
327 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
328 return logicalConnectionPoint + "-" + waveNumber;
331 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
333 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
334 interfaceBuilder.setDescription(" TBD ");
335 interfaceBuilder.setCircuitId(" TBD ");
336 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
337 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
338 interfaceBuilder.setAdministrativeState(AdminStates.InService);
339 interfaceBuilder.setType(type);
340 interfaceBuilder.setName(key);
341 interfaceBuilder.withKey(new InterfaceKey(key));
342 return interfaceBuilder;
345 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
346 if (mapping.getSupportingOms() == null) {
347 // Create generic interface
348 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
349 "OMS-" + mapping.getLogicalConnectionPoint());
350 if (mapping.getSupportingOts() != null) {
351 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
353 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
354 mapping.getLogicalConnectionPoint());
357 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
358 this.portMapping.updateMapping(nodeId, mapping);
359 return omsInterfaceBldr.build().getName();
361 return mapping.getSupportingOms();
365 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
366 if (mapping.getSupportingOts() == null) {
367 // Create generic interface
368 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
369 + mapping.getLogicalConnectionPoint());
370 // OTS interface augmentation specific data
371 OtsBuilder otsIfBuilder = new OtsBuilder();
372 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
374 // Create Interface1 type object required for adding as
376 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
377 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
378 .rev181019.Interface1Builder();
379 otsInterfaceBldr.addAugmentation(
380 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
381 otsIf1Builder.setOts(otsIfBuilder.build()).build());
382 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
383 this.portMapping.updateMapping(nodeId, mapping);
384 return otsInterfaceBldr.build().getName();
386 return mapping.getSupportingOts();
390 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
391 DeviceTransactionManager deviceTransactionManager) {
392 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
393 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
394 LOG.info("reading xc {} in node {}", xc, nodeId);
395 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
396 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
397 if (crossconnection.isPresent()) {
398 RoadmConnections rc = crossconnection.get();
399 LOG.info("xd {} found", xc);
400 String supportedinter = null;
401 if (!interfaceName.contains("nmc")) {
402 supportedinter = interfaceName.replace("mc", "nmc");
404 if (rc.getSource().getSrcIf().equals(interfaceName)
405 || rc.getDestination().getDstIf().equals(interfaceName)
406 || rc.getSource().getSrcIf().equals(supportedinter)
407 || rc.getDestination().getDstIf().equals(supportedinter)) {
411 LOG.info("xd {} not found !", xc);