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.rev170228.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.
116 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
118 * @return Name of the interface if successful, otherwise return null.
121 public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
122 throws OpenRoadmInterfaceException {
124 List<String> interfacesCreated = new ArrayList<>();
126 if (logicalConnPoint.contains("DEG")) {
127 String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
128 interfacesCreated.add(mcInterfaceCreated);
131 String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
132 interfacesCreated.add(nmcInterfaceCreated);
134 return interfacesCreated;
137 public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
138 throws OpenRoadmInterfaceException {
140 // TODO : Check this method
142 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
144 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
145 if (portMap == null) {
146 throw new OpenRoadmInterfaceException(
147 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
148 nodeId, logicalConnPoint));
151 // TODO : Check this method
153 InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
154 MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc" + "-" + waveNumber);
155 mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
157 McTtpBuilder mcTtpBuilder = new McTtpBuilder();
158 mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
159 mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
161 // Create Interface1 type object required for adding as augmentation
162 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
164 new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder();
165 interface1Builder.setMcTtp(mcTtpBuilder.build());
166 mcInterfaceBldr.addAugmentation(
167 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
168 interface1Builder.build());
170 // Post interface on the device
171 openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
172 return mcInterfaceBldr.getName();
175 public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
176 throws OpenRoadmInterfaceException {
178 // TODO : Check this method
180 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
182 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
183 if (portMap == null) {
184 throw new OpenRoadmInterfaceException(
185 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
186 nodeId, logicalConnPoint));
189 LOG.info(" Freq Start {} and Freq End {} and center-Freq {}",
190 String.valueOf(fixedFlex.getStart()), String.valueOf(fixedFlex.getStop()),
191 String.valueOf(fixedFlex.getCenterFrequency()));
192 //TODO : Check this method
193 InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
194 NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc" + "-" + waveNumber);
195 if (logicalConnPoint.contains("DEG")) {
196 nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc" + "-" + waveNumber);
199 NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
201 nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
202 nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance("40"));
204 // Create Interface1 type object required for adding as augmentation
205 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
206 nmcCtpI1fBuilder = new
207 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019
208 .Interface1Builder();
209 nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
210 nmcInterfaceBldr.addAugmentation(
211 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
212 nmcCtpI1fBuilder.build());
214 // Post interface on the device
215 openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
216 return nmcInterfaceBldr.getName();
219 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
220 throws OpenRoadmInterfaceException {
221 // TODO : Check this method
223 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
225 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
226 if (portMap == null) {
227 throw new OpenRoadmInterfaceException(
228 String.format("Unable to get mapping from PortMapping for node %s and logical connection port %s",
229 nodeId, logicalConnPoint));
232 // OCH interface specific data
233 OchBuilder ocIfBuilder = new OchBuilder();
235 ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
236 ocIfBuilder.setRate(R100G.class);
237 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
239 // Create generic interface
240 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
241 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
242 // Create Interface1 type object required for adding as augmentation
243 // TODO look at imports of different versions of class
244 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
245 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
246 .Interface1Builder();
247 ochInterfaceBldr.addAugmentation(
248 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
249 ochIf1Builder.setOch(ocIfBuilder.build()).build());
251 // Post interface on the device
252 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
254 // Post the equipment-state change on the device circuit-pack if xpdr node
255 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
256 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
259 return ochInterfaceBldr.getName();
262 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
263 throws OpenRoadmInterfaceException {
264 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
265 if (portMap == null) {
266 throw new OpenRoadmInterfaceException(
267 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
268 nodeId, logicalConnPoint));
270 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
271 logicalConnPoint + "-ODU");
272 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
274 // ODU interface specific data
275 OduBuilder oduIfBuilder = new OduBuilder();
276 oduIfBuilder.setRate(ODU4.class);
277 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
279 // Set Opu attributes
280 OpuBuilder opuBldr = new OpuBuilder();
281 opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
282 opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
283 oduIfBuilder.setOpu(opuBldr.build());
285 // Create Interface1 type object required for adding as augmentation
286 // TODO look at imports of different versions of class
287 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder oduIf1Builder =
288 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder();
289 oduInterfaceBldr.addAugmentation(
290 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
291 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
293 // Post interface on the device
294 openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
295 return oduInterfaceBldr.getName();
298 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
299 throws OpenRoadmInterfaceException {
300 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
301 if (portMap == null) {
302 throw new OpenRoadmInterfaceException(
303 String.format("Unable to get mapping from PortMapping for node % and logical connection port %s",
304 nodeId, logicalConnPoint));
306 // Create generic interface
307 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
308 logicalConnPoint + "-OTU");
309 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
311 // OTU interface specific data
312 OtuBuilder otuIfBuilder = new OtuBuilder();
313 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
314 otuIfBuilder.setRate(OTU4.class);
316 // Create Interface1 type object required for adding as augmentation
317 // TODO look at imports of different versions of class
318 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder otuIf1Builder =
319 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder();
320 otuInterfaceBldr.addAugmentation(
321 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
322 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
324 // Post interface on the device
325 openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
326 return otuInterfaceBldr.getName();
329 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
330 return logicalConnectionPoint + "-" + waveNumber;
333 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
335 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
336 interfaceBuilder.setDescription(" TBD ");
337 interfaceBuilder.setCircuitId(" TBD ");
338 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
339 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
340 interfaceBuilder.setAdministrativeState(AdminStates.InService);
341 interfaceBuilder.setType(type);
342 interfaceBuilder.setName(key);
343 interfaceBuilder.withKey(new InterfaceKey(key));
344 return interfaceBuilder;
347 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
348 if (mapping.getSupportingOms() == null) {
349 // Create generic interface
350 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
351 "OMS-" + mapping.getLogicalConnectionPoint());
352 if (mapping.getSupportingOts() != null) {
353 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
355 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
356 mapping.getLogicalConnectionPoint());
359 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
360 this.portMapping.updateMapping(nodeId, mapping);
361 return omsInterfaceBldr.build().getName();
363 return mapping.getSupportingOms();
367 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
368 if (mapping.getSupportingOts() == null) {
369 // Create generic interface
370 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
371 + mapping.getLogicalConnectionPoint());
372 // OTS interface augmentation specific data
373 OtsBuilder otsIfBuilder = new OtsBuilder();
374 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
376 // Create Interface1 type object required for adding as
378 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
379 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
380 .rev181019.Interface1Builder();
381 otsInterfaceBldr.addAugmentation(
382 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
383 otsIf1Builder.setOts(otsIfBuilder.build()).build());
384 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
385 this.portMapping.updateMapping(nodeId, mapping);
386 return otsInterfaceBldr.build().getName();
388 return mapping.getSupportingOts();
392 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
393 DeviceTransactionManager deviceTransactionManager) {
394 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
395 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
396 LOG.info("reading xc {} in node {}", xc, nodeId);
397 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
398 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
399 if (crossconnection.isPresent()) {
400 RoadmConnections rc = crossconnection.get();
401 LOG.info("xd {} found", xc);
402 String supportedinter = null;
403 if (!interfaceName.contains("nmc")) {
404 supportedinter = interfaceName.replace("mc", "nmc");
406 if (rc.getSource().getSrcIf().equals(interfaceName)
407 || rc.getDestination().getDstIf().equals(interfaceName)
408 || rc.getSource().getSrcIf().equals(supportedinter)
409 || rc.getDestination().getDstIf().equals(supportedinter)) {
413 LOG.info("xd {} not found !", xc);