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 waveNumber wavelength number of the OCH interface.
114 * @return Name of the interface if successful, otherwise return null.
117 public List<String> createFlexOCH(String nodeId, String logicalConnPoint, Long waveNumber)
118 throws OpenRoadmInterfaceException {
120 List<String> interfacesCreated = new ArrayList<>();
122 String nmcInterfaceCreated = createNMCInterface(nodeId, logicalConnPoint, waveNumber);
123 interfacesCreated.add(nmcInterfaceCreated);
125 String mcInterfaceCreated = createMCInterface(nodeId, logicalConnPoint, waveNumber);
126 interfacesCreated.add(mcInterfaceCreated);
128 return interfacesCreated;
131 public String createMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
132 throws OpenRoadmInterfaceException {
134 // TODO : Check this method
136 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
138 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
139 if (portMap == null) {
140 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
141 + " logical connection port %s", nodeId, logicalConnPoint));
144 // TODO : Check this method
146 InterfaceBuilder mcInterfaceBldr = createGenericInterfaceBuilder(portMap,
147 MediaChannelTrailTerminationPoint.class, logicalConnPoint + "-mc");
148 mcInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
150 McTtpBuilder mcTtpBuilder = new McTtpBuilder();
151 mcTtpBuilder.setMinFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStart())));
152 mcTtpBuilder.setMaxFreq(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getStop())));
154 // Create Interface1 type object required for adding as augmentation
155 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1Builder
156 interface1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019
157 .Interface1Builder();
158 interface1Builder.setMcTtp(mcTtpBuilder.build());
159 mcInterfaceBldr.addAugmentation(
160 org.opendaylight.yang.gen.v1.http.org.openroadm.media.channel.interfaces.rev181019.Interface1.class,
161 interface1Builder.build());
163 // Post interface on the device
164 openRoadmInterfaces.postInterface(nodeId, mcInterfaceBldr);
165 return mcInterfaceBldr.getName();
168 public String createNMCInterface(String nodeId, String logicalConnPoint, Long waveNumber)
169 throws OpenRoadmInterfaceException {
171 // TODO : Check this method
173 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
175 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
176 if (portMap == null) {
177 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
178 + " logical connection port %s", nodeId, logicalConnPoint));
181 // TODO : Check this method
182 InterfaceBuilder nmcInterfaceBldr = createGenericInterfaceBuilder(portMap,
183 NetworkMediaChannelConnectionTerminationPoint.class, logicalConnPoint + "-nmc");
184 nmcInterfaceBldr.setSupportingInterface(logicalConnPoint + "-mc");
185 NmcCtpBuilder nmcCtpIfBuilder = new NmcCtpBuilder();
187 nmcCtpIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
188 nmcCtpIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
189 // Create Interface1 type object required for adding as augmentation
190 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1Builder
191 nmcCtpI1fBuilder = new org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces
192 .rev181019.Interface1Builder();
193 nmcCtpI1fBuilder.setNmcCtp(nmcCtpIfBuilder.build());
194 nmcInterfaceBldr.addAugmentation(
195 org.opendaylight.yang.gen.v1.http.org.openroadm.network.media.channel.interfaces.rev181019.Interface1.class,
196 nmcCtpI1fBuilder.build());
197 // Post interface on the device
198 openRoadmInterfaces.postInterface(nodeId, nmcInterfaceBldr);
199 return nmcInterfaceBldr.getName();
202 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
203 throws OpenRoadmInterfaceException {
204 // TODO : Check this method
206 fixedFlex = fixedFlex.getFixedFlexWaveMapping(waveNumber.shortValue());
208 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
209 if (portMap == null) {
210 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
211 + " logical connection port %s", nodeId, logicalConnPoint));
214 // OCH interface specific data
215 OchBuilder ocIfBuilder = new OchBuilder();
217 ocIfBuilder.setFrequency(FrequencyTHz.getDefaultInstance(String.valueOf(fixedFlex.getCenterFrequency())));
218 // ocIfBuilder.setWidth(FrequencyGHz.getDefaultInstance(String.valueOf(fixedFlex.getWavelength())));
219 // ocIfBuilder.setModulationFormat(ModulationFormat.DpQpsk);
220 ocIfBuilder.setRate(R100G.class);
221 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
223 // Create generic interface
224 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
225 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
226 // Create Interface1 type object required for adding as augmentation
227 // TODO look at imports of different versions of class
228 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder
229 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019
230 .Interface1Builder();
231 ochInterfaceBldr.addAugmentation(
232 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1.class,
233 ochIf1Builder.setOch(ocIfBuilder.build()).build());
235 // Post interface on the device
236 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
238 // Post the equipment-state change on the device circuit-pack if xpdr node
239 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
240 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
243 return ochInterfaceBldr.getName();
246 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
247 throws OpenRoadmInterfaceException {
248 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
249 if (portMap == null) {
250 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
251 + " logical connection port %s", nodeId, logicalConnPoint));
253 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
254 logicalConnPoint + "-ODU");
255 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
257 // ODU interface specific data
258 OduBuilder oduIfBuilder = new OduBuilder();
259 oduIfBuilder.setRate(ODU4.class);
260 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
262 // Set Opu attributes
263 OpuBuilder opuBldr = new OpuBuilder();
264 opuBldr.setPayloadType(PayloadTypeDef.getDefaultInstance("07"));
265 opuBldr.setExpPayloadType(PayloadTypeDef.getDefaultInstance("07"));
266 oduIfBuilder.setOpu(opuBldr.build());
268 // Create Interface1 type object required for adding as augmentation
269 // TODO look at imports of different versions of class
270 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1Builder
271 oduIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019
272 .Interface1Builder();
273 oduInterfaceBldr.addAugmentation(
274 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev181019.Interface1.class,
275 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
277 // Post interface on the device
278 openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
279 return oduInterfaceBldr.getName();
282 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
283 throws OpenRoadmInterfaceException {
284 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
285 if (portMap == null) {
286 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
287 + " logical connection port %s", nodeId, logicalConnPoint));
289 // Create generic interface
290 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
291 logicalConnPoint + "-OTU");
292 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
294 // OTU interface specific data
295 OtuBuilder otuIfBuilder = new OtuBuilder();
296 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
297 otuIfBuilder.setRate(OTU4.class);
299 // Create Interface1 type object required for adding as augmentation
300 // TODO look at imports of different versions of class
301 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1Builder
302 otuIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019
303 .Interface1Builder();
304 otuInterfaceBldr.addAugmentation(
305 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev181019.Interface1.class,
306 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
308 // Post interface on the device
309 openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
310 return otuInterfaceBldr.getName();
313 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
314 return logicalConnectionPoint + "-" + waveNumber;
317 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
319 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
320 interfaceBuilder.setDescription(" TBD ");
321 interfaceBuilder.setCircuitId(" TBD ");
322 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
323 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
324 interfaceBuilder.setAdministrativeState(AdminStates.InService);
325 interfaceBuilder.setType(type);
326 interfaceBuilder.setName(key);
327 interfaceBuilder.withKey(new InterfaceKey(key));
328 return interfaceBuilder;
331 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
332 if (mapping.getSupportingOms() == null) {
333 // Create generic interface
334 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
335 "OMS-" + mapping.getLogicalConnectionPoint());
336 if (mapping.getSupportingOts() != null) {
337 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
339 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
340 mapping.getLogicalConnectionPoint());
343 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
344 this.portMapping.updateMapping(nodeId, mapping);
345 return omsInterfaceBldr.build().getName();
347 return mapping.getSupportingOms();
351 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
352 if (mapping.getSupportingOts() == null) {
353 // Create generic interface
354 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
355 + mapping.getLogicalConnectionPoint());
356 // OTS interface augmentation specific data
357 OtsBuilder otsIfBuilder = new OtsBuilder();
358 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
360 // Create Interface1 type object required for adding as
362 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1Builder
363 otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces
364 .rev181019.Interface1Builder();
365 otsInterfaceBldr.addAugmentation(
366 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev181019.Interface1.class,
367 otsIf1Builder.setOts(otsIfBuilder.build()).build());
368 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
369 this.portMapping.updateMapping(nodeId, mapping);
370 return otsInterfaceBldr.build().getName();
372 return mapping.getSupportingOts();
376 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
377 DeviceTransactionManager deviceTransactionManager) {
378 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
379 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
380 LOG.info("reading xc {} in node {}", xc, nodeId);
381 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
382 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
383 if (crossconnection.isPresent()) {
384 RoadmConnections rc = crossconnection.get();
385 LOG.info("xd {} found", xc);
386 String supportedinter = null;
387 if (!interfaceName.contains("nmc")) {
388 supportedinter = interfaceName.replace("mc", "nmc");
390 if (rc.getSource().getSrcIf().equals(interfaceName)
391 || rc.getDestination().getDstIf().equals(interfaceName)
392 || rc.getSource().getSrcIf().equals(supportedinter)
393 || rc.getDestination().getDstIf().equals(supportedinter)) {
397 LOG.info("xd {} not found !", xc);