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 String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
127 interfacesCreated.add(nmcInterfaceCreated);
129 String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
130 interfacesCreated.add(mcInterfaceCreated);
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(String.format("Unable to get mapping from PortMapping for node % and"
145 + " logical connection port %s", nodeId, logicalConnPoint));
148 // TODO : Check this method
150 InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
151 MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc");
152 mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
154 McTtpBuilder mcTtpBuilder = new McTtpBuilder();
155 mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
156 mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
158 // Create Interface1 type object required for adding as augmentation
159 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
160 interface1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019
161 .Interface1Builder();
162 interface1Builder.setMcTtp(mcTtpBuilder.build());
163 mcInterfaceBldr.addAugmentation(
164 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
165 interface1Builder.build());
167 // Post interface on the device
168 openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
169 return mcInterfaceBldr.getName();
172 public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
173 throws OpenRoadmInterfaceException {
175 // TODO : Check this method
177 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
179 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
180 if (portMap == null) {
181 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
182 + " logical connection port %s", nodeId, logicalConnPoint));
185 // TODO : Check this method
186 InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
187 NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc");
188 nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc");
189 NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
191 nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
192 nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
193 // Create Interface1 type object required for adding as augmentation
194 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
195 nmcCtpI1fBuilder = new org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces
196 .rev181019.Interface1Builder();
197 nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
198 nmcInterfaceBldr.addAugmentation(
199 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
200 nmcCtpI1fBuilder.build());
201 // Post interface on the device
202 openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
203 return nmcInterfaceBldr.getName();
206 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
207 throws OpenRoadmInterfaceException {
208 // TODO : Check this method
210 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
212 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
213 if (portMap == null) {
214 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
215 + " logical connection port %s", nodeId, logicalConnPoint));
218 // OCH interface specific data
219 OchBuilder ocIfBuilder = new OchBuilder();
221 ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
222 ocIfBuilder.setRate(R100G.class);
223 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
225 // Create generic interface
226 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
227 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
228 // Create Interface1 type object required for adding as augmentation
229 // TODO look at imports of different versions of class
230 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
231 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
232 .Interface1Builder();
233 ochInterfaceBldr.addAugmentation(
234 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
235 ochIf1Builder.setOch(ocIfBuilder.build()).build());
237 // Post interface on the device
238 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
240 // Post the equipment-state change on the device circuit-pack if xpdr node
241 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
242 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
245 return ochInterfaceBldr.getName();
248 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
249 throws OpenRoadmInterfaceException {
250 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
251 if (portMap == null) {
252 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
253 + " logical connection port %s", nodeId, logicalConnPoint));
255 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
256 logicalConnPoint + "-ODU");
257 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
259 // ODU interface specific data
260 OduBuilder oduIfBuilder = new OduBuilder();
261 oduIfBuilder.setRate(ODU4.class);
262 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
264 // Set Opu attributes
265 OpuBuilder opuBldr = new OpuBuilder();
266 opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
267 opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
268 oduIfBuilder.setOpu(opuBldr.build());
270 // Create Interface1 type object required for adding as augmentation
271 // TODO look at imports of different versions of class
272 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder
273 oduIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019
274 .Interface1Builder();
275 oduInterfaceBldr.addAugmentation(
276 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
277 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
279 // Post interface on the device
280 openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
281 return oduInterfaceBldr.getName();
284 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
285 throws OpenRoadmInterfaceException {
286 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
287 if (portMap == null) {
288 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
289 + " logical connection port %s", nodeId, logicalConnPoint));
291 // Create generic interface
292 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
293 logicalConnPoint + "-OTU");
294 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
296 // OTU interface specific data
297 OtuBuilder otuIfBuilder = new OtuBuilder();
298 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
299 otuIfBuilder.setRate(OTU4.class);
301 // Create Interface1 type object required for adding as augmentation
302 // TODO look at imports of different versions of class
303 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder
304 otuIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019
305 .Interface1Builder();
306 otuInterfaceBldr.addAugmentation(
307 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
308 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
310 // Post interface on the device
311 openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
312 return otuInterfaceBldr.getName();
315 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
316 return logicalConnectionPoint + "-" + waveNumber;
319 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
321 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
322 interfaceBuilder.setDescription(" TBD ");
323 interfaceBuilder.setCircuitId(" TBD ");
324 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
325 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
326 interfaceBuilder.setAdministrativeState(AdminStates.InService);
327 interfaceBuilder.setType(type);
328 interfaceBuilder.setName(key);
329 interfaceBuilder.withKey(new InterfaceKey(key));
330 return interfaceBuilder;
333 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
334 if (mapping.getSupportingOms() == null) {
335 // Create generic interface
336 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
337 "OMS-" + mapping.getLogicalConnectionPoint());
338 if (mapping.getSupportingOts() != null) {
339 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
341 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
342 mapping.getLogicalConnectionPoint());
345 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
346 this.portMapping.updateMapping(nodeId, mapping);
347 return omsInterfaceBldr.build().getName();
349 return mapping.getSupportingOms();
353 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
354 if (mapping.getSupportingOts() == null) {
355 // Create generic interface
356 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
357 + mapping.getLogicalConnectionPoint());
358 // OTS interface augmentation specific data
359 OtsBuilder otsIfBuilder = new OtsBuilder();
360 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
362 // Create Interface1 type object required for adding as
364 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
365 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
366 .rev181019.Interface1Builder();
367 otsInterfaceBldr.addAugmentation(
368 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
369 otsIf1Builder.setOts(otsIfBuilder.build()).build());
370 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
371 this.portMapping.updateMapping(nodeId, mapping);
372 return otsInterfaceBldr.build().getName();
374 return mapping.getSupportingOts();
378 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
379 DeviceTransactionManager deviceTransactionManager) {
380 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
381 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
382 LOG.info("reading xc {} in node {}", xc, nodeId);
383 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
384 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
385 if (crossconnection.isPresent()) {
386 RoadmConnections rc = crossconnection.get();
387 LOG.info("xd {} found", xc);
388 String supportedinter = null;
389 if (!interfaceName.contains("nmc")) {
390 supportedinter = interfaceName.replace("mc", "nmc");
392 if (rc.getSource().getSrcIf().equals(interfaceName)
393 || rc.getDestination().getDstIf().equals(interfaceName)
394 || rc.getSource().getSrcIf().equals(supportedinter)
395 || rc.getDestination().getDstIf().equals(supportedinter)) {
399 LOG.info("xd {} not found !", xc);