Abort power setup if setting gainloss fails
[transportpce.git] / olm / src / main / java / org / opendaylight / transportpce / olm / power / PowerMgmtImpl.java
1 /*
2  * Copyright © 2017 AT&T and others.  All rights reserved.
3  *
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
7  */
8
9 package org.opendaylight.transportpce.olm.power;
10
11 import java.math.BigDecimal;
12 import java.math.MathContext;
13 import java.math.RoundingMode;
14 import java.util.Arrays;
15 import java.util.HashMap;
16 import java.util.Locale;
17 import java.util.Map;
18 import java.util.Optional;
19 import java.util.stream.Collectors;
20 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
21 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
22 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
23 import org.opendaylight.transportpce.common.mapping.PortMapping;
24 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
25 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerSetupInput;
27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerTurndownInput;
28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.OpenroadmNodeVersion;
29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.mapping.Mapping;
30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.mapping.MappingKey;
31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.network.Nodes;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.OpticalControlMode;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1;
35 import org.opendaylight.yangtools.yang.common.Decimal64;
36 import org.osgi.service.component.annotations.Activate;
37 import org.osgi.service.component.annotations.Component;
38 import org.osgi.service.component.annotations.Reference;
39 import org.osgi.service.metatype.annotations.AttributeDefinition;
40 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43
44 @Component(configurationPid = "org.opendaylight.transportpce")
45 public class PowerMgmtImpl implements PowerMgmt {
46
47     @ObjectClassDefinition
48     public @interface Configuration {
49         @AttributeDefinition
50         long timer1() default 120000;
51         @AttributeDefinition
52         long timer2() default 20000;
53     }
54     private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtImpl.class);
55     private final OpenRoadmInterfaces openRoadmInterfaces;
56     private final CrossConnect crossConnect;
57     private final DeviceTransactionManager deviceTransactionManager;
58     private final PortMapping portMapping;
59     private static final BigDecimal DEFAULT_TPDR_PWR_100G = new BigDecimal(-5);
60     private static final BigDecimal DEFAULT_TPDR_PWR_400G = new BigDecimal(0);
61     private static final String INTERFACE_NOT_PRESENT = "Interface {} on node {} is not present!";
62     private static final double MC_WIDTH_GRAN = 2 * GridConstant.GRANULARITY;
63
64     private long timer1;
65     // openroadm spec value is 120000, functest value is 3000
66     private long timer2;
67     // openroadm spec value is 20000, functest value is 2000
68
69     @Activate
70     public PowerMgmtImpl(@Reference OpenRoadmInterfaces openRoadmInterfaces,
71             @Reference CrossConnect crossConnect,
72             @Reference DeviceTransactionManager deviceTransactionManager,
73             @Reference PortMapping portMapping, final Configuration configuration) {
74         this(openRoadmInterfaces, crossConnect, deviceTransactionManager, portMapping, configuration.timer1(),
75                 configuration.timer2());
76     }
77
78     public PowerMgmtImpl(OpenRoadmInterfaces openRoadmInterfaces,
79                          CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager,
80             PortMapping portMapping, long timer1, long timer2) {
81         this.openRoadmInterfaces = openRoadmInterfaces;
82         this.crossConnect = crossConnect;
83         this.deviceTransactionManager = deviceTransactionManager;
84         this.portMapping = portMapping;
85         try {
86             this.timer1 = Long.valueOf(timer1);
87         } catch (NumberFormatException e) {
88             this.timer1 = 120000;
89             LOG.warn("Failed to retrieve Olm timer1 value from configuration - using default value {}",
90                 this.timer1, e);
91         }
92         try {
93             this.timer2 = Long.valueOf(timer2);
94         } catch (NumberFormatException e) {
95             this.timer2 = 20000;
96             LOG.warn("Failed to retrieve Olm timer2 value from configuration - using default value {}",
97                 this.timer2, e);
98         }
99         LOG.debug("PowerMgmtImpl instantiated with olm timers = {} - {}", this.timer1, this.timer2);
100     }
101
102     /**
103      * This methods measures power requirement for turning up a WL
104      * from the Spanloss at OTS transmit direction and update
105      * roadm-connection target-output-power.
106      *
107      * @param input
108      *            Input parameter from the olm servicePowerSetup rpc
109      *
110      * @return true/false based on status of operation.
111      */
112     //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices
113     public Boolean setPower(ServicePowerSetupInput input) {
114         LOG.info("Olm-setPower initiated for input {}", input);
115         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
116                 input.getLowerSpectralSlotNumber().toString(),
117                 input.getHigherSpectralSlotNumber().toString());
118         if (input.getNodes() == null) {
119             LOG.error("No Nodes to configure");
120             return false;
121         }
122         for (int i = 0; i < input.getNodes().size(); i++) {
123             String nodeId = input.getNodes().get(i).getNodeId();
124             String destTpId = input.getNodes().get(i).getDestTp();
125             Nodes inputNode = this.portMapping.getNode(nodeId);
126             if (inputNode == null || inputNode.getNodeInfo() == null) {
127                 LOG.error("OLM-PowerMgmtImpl : Error retrieving mapping node for {}", nodeId);
128                 return false;
129             }
130             OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion();
131
132             switch (inputNode.getNodeInfo().getNodeType()) {
133                 case Xpdr:
134                     if (destTpId == null) {
135                         continue;
136                     }
137                     LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType());
138                     LOG.info("Getting mapping data for node is {}",
139                         inputNode.nonnullMapping().values().stream().filter(o -> o.key()
140                          .equals(new MappingKey(destTpId))).findFirst().toString());
141                     // If its not A-End transponder
142                     if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) {
143                         LOG.info("{} is a drop node. Net power settings needed", nodeId);
144                         continue;
145                     }
146
147                     BigDecimal powerVal = getXpdrPowerValue(
148                             inputNode, destTpId, nodeId, openroadmVersion.getIntValue(),
149                             input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId());
150                     if (powerVal == null) {
151                         return false;
152                     }
153
154                     String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
155                         destTpId, spectralSlotName);
156                     if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) {
157                         LOG.info("Transponder OCH connection: {} power update failed ", interfaceName);
158                         continue;
159                     }
160                     LOG.info("Transponder OCH connection: {} power updated ", interfaceName);
161                     try {
162                         LOG.info("Now going in sleep mode");
163                         Thread.sleep(timer1);
164                     } catch (InterruptedException e) {
165                         LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e);
166                         // FIXME shouldn't it be LOG.warn  or LOG.error?
167                         // or maybe this try/catch block can simply be removed
168                     }
169                     break;
170                 case Rdm:
171                     LOG.info("This is a roadm {} device", openroadmVersion.getName());
172                     String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
173                             input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
174                     LOG.info("Connection number is {}", connectionNumber);
175
176                     // If Drop node leave node is power mode
177                     if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
178                         LOG.info("Setting power at drop node");
179                         crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber);
180                         continue;
181                     }
182                     if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
183                         continue;
184                     }
185                     // If Degree is transmitting end then set power
186                     Optional<Mapping> mappingObjectOptional = inputNode.nonnullMapping()
187                             .values().stream().filter(o -> o.key()
188                             .equals(new MappingKey(destTpId))).findFirst();
189                     if (mappingObjectOptional.isEmpty()) {
190                         continue;
191                     }
192                     // TODO can it be return false rather than continue?
193                     // in that case, mappingObjectOptional could be moved inside method getSpanLossTx()
194                     LOG.info("Dest point is Degree {}", mappingObjectOptional.orElseThrow());
195                     BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.orElseThrow().getSupportingOts(),
196                         destTpId, nodeId, openroadmVersion.getIntValue());
197
198                     LOG.info("Spanloss TX is {}", spanLossTx);
199                     // TODO: The span-loss limits should be obtained from optical specifications
200                     if (spanLossTx == null || spanLossTx.intValue() < 0 || spanLossTx.intValue() > 27) {
201                         LOG.error("Power Value is null: spanLossTx null or out of openROADM range [0,27] {}",
202                             spanLossTx);
203                         return false;
204                     }
205                     Decimal64 powerValue = Decimal64.valueOf(getRdmPowerValue(spanLossTx, input));
206                     try {
207                         if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue,
208                                 connectionNumber)) {
209                             LOG.error("Set Power failed for Roadm-connection: {} on Node: {}",
210                                     connectionNumber, nodeId);
211                             return false;
212                         }
213                         LOG.info("Roadm-connection: {} updated ", connectionNumber);
214                         Thread.sleep(timer2);
215                         // TODO make this timer value configurable via OSGi blueprint
216                         // although the value recommended by the white paper is 20 seconds.
217                         // At least one vendor product needs 60 seconds
218                         // because it is not supporting GainLoss with target-output-power.
219
220                         if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue,
221                                 connectionNumber)) {
222                             LOG.error("Set GainLoss failed for Roadm-connection: {} on Node: {}",
223                                     connectionNumber, nodeId);
224                             return false;
225                         }
226                     } catch (InterruptedException e) {
227                         LOG.error("Olm-setPower wait failed :", e);
228                         return false;
229                     }
230                     break;
231                 default :
232                     LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId);
233                     break;
234             }
235         }
236         return true;
237     }
238
239     private Map<String, Double> getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId,
240             Integer openroadmVersion) {
241
242         Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
243                 .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst();
244         if (mappingObject.isEmpty()) {
245             LOG.info("Mapping object not found for nodeId: {}", nodeId);
246             // FIXME shouldn't it be LOG.error ?
247             return null;
248             // return null here means return false in setPower()
249             // TODO Align protections with getSRGRxPowerRangeMap
250         }
251
252         String circuitPackName = mappingObject.orElseThrow().getSupportingCircuitPackName();
253         String portName = mappingObject.orElseThrow().getSupportingPort();
254         switch (openroadmVersion) {
255             case 1:
256                 return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName,
257                     nodeId, deviceTransactionManager);
258             case 2:
259                 return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName,
260                     nodeId, deviceTransactionManager);
261             case 3:
262                 return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName,
263                     nodeId, deviceTransactionManager);
264             default:
265                 LOG.error("Unrecognized OpenRoadm version");
266                 return new HashMap<>();
267                 // FIXME shouldn't it lead to a return false in setPower()?
268         }
269     }
270
271
272     private Map<String, Double> getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) {
273
274         Nodes inputNode = this.portMapping.getNode(nodeId);
275         int rdmOpenroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion().getIntValue();
276         Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
277                 .filter(o -> o.key().equals(new MappingKey(srgId)))
278                 .findFirst();
279
280         if (mappingObject.isEmpty()) {
281             return new HashMap<>();
282             // FIXME shouldn't it lead to a return false in setPower() ?
283         }
284
285         String circuitPackName = mappingObject.orElseThrow().getSupportingCircuitPackName();
286         String portName = mappingObject.orElseThrow().getSupportingPort();
287         switch (rdmOpenroadmVersion) {
288             case 1:
289                 return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId,
290                         deviceTransactionManager, circuitPackName, portName);
291             case 2:
292                 return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId,
293                         deviceTransactionManager, circuitPackName, portName);
294             case 3:
295                 return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId,
296                         deviceTransactionManager, circuitPackName, portName);
297             default:
298                 LOG.error("Unrecognized OpenRoadm version");
299                 return null;
300                 //return null here means return false in setPower()
301                 // TODO Align protections with getTxPowerRangeMap
302         }
303     }
304
305     private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) {
306         try {
307             switch (openroadmVersion) {
308                 case 1:
309                     Optional<Interface> interfaceOpt =
310                         this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
311                     if (interfaceOpt.isEmpty()) {
312                         LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
313                         return null;
314                     }
315                     if (interfaceOpt.orElseThrow().augmentation(Interface1.class).getOts()
316                             .getSpanLossTransmit() == null) {
317                         LOG.error("interface {} has no spanloss value", interfaceOpt.orElseThrow().getName());
318                         return null;
319                     }
320                     return interfaceOpt.orElseThrow()
321                             .augmentation(Interface1.class)
322                             .getOts().getSpanLossTransmit().getValue().decimalValue();
323                 case 2:
324                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
325                             .interfaces.grp.Interface> interfaceOpt1 =
326                         this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
327                     if (interfaceOpt1.isEmpty()) {
328                         LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
329                         return null;
330                     }
331                     if (interfaceOpt1.orElseThrow().augmentation(org.opendaylight.yang.gen.v1.http.org
332                             .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts()
333                                 .getSpanLossTransmit() == null) {
334                         LOG.error("interface {} has no spanloss value", interfaceOpt1.orElseThrow().getName());
335                         return null;
336                     }
337                     return interfaceOpt1.orElseThrow()
338                             .augmentation(org.opendaylight.yang.gen.v1.http.org
339                                 .openroadm.optical.transport.interfaces.rev181019.Interface1.class)
340                             .getOts().getSpanLossTransmit().getValue().decimalValue();
341                 // TODO no case 3 ?
342                 default:
343                     return null;
344             }
345         } catch (OpenRoadmInterfaceException ex) {
346             LOG.error("Failed to get interface {} from node {}!",
347                 supportingOts, nodeId, ex);
348             return null;
349         } catch (IllegalArgumentException ex) {
350             LOG.error("Failed to get non existing interface {} from node {}!",
351                 supportingOts, nodeId);
352             return null;
353         }
354     }
355
356     private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion,
357             String srgId, String nextNodeId) {
358
359         Map<String, Double> txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion);
360         if (txPowerRangeMap == null) {
361             return null;
362             // return null here means return false in setPower()
363         }
364         BigDecimal powerVal =
365             openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G;
366         if (txPowerRangeMap.isEmpty()) {
367             LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId);
368             return powerVal;
369         }
370
371         Map<String, Double> rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion);
372         if (rxSRGPowerRangeMap == null) {
373             return null;
374             // return null here means return false in setPower()
375             // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed
376             // => confirm this behavior is OK
377         }
378         if (rxSRGPowerRangeMap.isEmpty()) {
379             LOG.info("SRG Power Range not found, setting the Transponder range to default");
380             return powerVal;
381         }
382
383         powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx"))
384             .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx")));
385         LOG.info("Calculated Transponder Power value is {}" , powerVal);
386         return powerVal;
387     }
388
389
390     private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) {
391         // TODO: These values will be obtained from the specifications
392         // power-value here refers to the Pin[50GHz]
393         BigDecimal powerValue;
394         if (spanLossTx.doubleValue()  >= 23.0) {
395             powerValue = BigDecimal.valueOf(2.0);
396         } else if (spanLossTx.doubleValue()  >= 8.0) {
397             powerValue = BigDecimal.valueOf(- (8.0 - spanLossTx.doubleValue()) / 3.0 - 3.0);
398         } else if (spanLossTx.doubleValue() >= 6.0) {
399             powerValue = BigDecimal.valueOf(-3.0);
400         } else {
401             powerValue = spanLossTx.subtract(BigDecimal.valueOf(9));
402         }
403         BigDecimal mcWidth = new BigDecimal(50);
404         // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz)
405         // 87.5 GHz channel width @-20dBm=75GHz
406         if (input.getMcWidth() != null) {
407             // Units of MC-width are in GHz, meaning it should be 40/50/87.5GHz
408             // TODO: Should we validate this units before proceeding?
409             LOG.debug("Input Grid size is {}", input.getMcWidth().getValue());
410
411             // We round-off the mc-width to the nearest grid-value based on the granularity of 12.5 GHz
412             double nbrMcSlots = Math.ceil(input.getMcWidth().getValue().doubleValue() / MC_WIDTH_GRAN);
413             LOG.debug("Nearest (ceil) number of slots {}", nbrMcSlots);
414             mcWidth = new BigDecimal(MC_WIDTH_GRAN * nbrMcSlots);
415             LOG.debug("Given mc-width={}, Rounded mc-width={}", input.getMcWidth().getValue(), mcWidth);
416
417             BigDecimal logVal = mcWidth.divide(new BigDecimal(50));
418             double pdsVal = 10 * Math.log10(logVal.doubleValue());
419             // Addition of PSD value will give Pin[87.5 GHz]
420             powerValue = powerValue.add(new BigDecimal(pdsVal, new MathContext(3, RoundingMode.HALF_EVEN)));
421         }
422         // FIXME compliancy with OpenROADM MSA and approximations used -- should be addressed with powermask update
423         // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494
424         powerValue = powerValue.setScale(2, RoundingMode.CEILING);
425         // target-output-power yang precision is 2, so we limit here to 2
426         LOG.info("The power value is P1[{}GHz]={} dB for spanloss {}", mcWidth, powerValue, spanLossTx);
427         return powerValue;
428     }
429
430     /**
431      * This methods turns down power a WL by performing
432      * following steps:
433      *
434      * <p>
435      * 1. Pull interfaces used in service and change
436      * status to outOfService
437      *
438      * <p>
439      * 2. For each of the ROADM node set target-output-power
440      * to -60dbm, wait for 20 seconds, turn power mode to off
441      *
442      * <p>
443      * 3. Turn down power in Z to A direction and A to Z
444      *
445      * @param input
446      *            Input parameter from the olm servicePowerTurndown rpc
447      *
448      * @return true/false based on status of operation
449      */
450     public Boolean powerTurnDown(ServicePowerTurndownInput input) {
451         LOG.info("Olm-powerTurnDown initiated for input {}", input);
452         /*Starting with last element into the list Z -> A for
453           turning down A -> Z */
454         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
455                 input.getLowerSpectralSlotNumber().toString(),
456                 input.getHigherSpectralSlotNumber().toString());
457         for (int i = input.getNodes().size() - 1; i >= 0; i--) {
458             String nodeId = input.getNodes().get(i).getNodeId();
459             String destTpId = input.getNodes().get(i).getDestTp();
460             String connectionNumber =  String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
461                     input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
462             try {
463                 if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
464                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(),
465                             Decimal64.valueOf("-60"), connectionNumber)) {
466                         LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber);
467                         return false;
468                     }
469                     Thread.sleep(timer2);
470                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
471                         LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
472                         return false;
473                     }
474                 } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
475                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
476                         LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
477                         // FIXME a return false would allow sync with DEG case but makes current Unit tests fail
478                     }
479                 }
480             } catch (InterruptedException e) {
481                 // TODO Auto-generated catch block
482                 LOG.error("Olm-powerTurnDown wait failed: ",e);
483                 return false;
484             }
485         }
486         return true;
487     }
488
489     /**
490      * This method retrieves transponder OCH interface and
491      * sets power.
492      *
493      * @param nodeId
494      *            Unique identifier for the mounted netconf- node
495      * @param interfaceName
496      *            OCH interface name carrying WL
497      * @param txPower
498      *            Calculated transmit power
499      * @param openroadmVersion
500      *            Version of openRoadm device software
501      * @return true/false based on status of operation
502      */
503     private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
504                                             OpenroadmNodeVersion openroadmVersion) {
505
506         boolean powerSetupResult = false;
507         try {
508             switch (openroadmVersion.getIntValue()) {
509                 case 1:
510                     Optional<Interface> interfaceOptional121 =
511                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
512                     if (interfaceOptional121.isEmpty()) {
513                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
514                         return false;
515                     }
516                     powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName,
517                             txPower, deviceTransactionManager, interfaceOptional121.orElseThrow());
518                     break;
519                 case 2:
520                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp
521                             .Interface> interfaceOptional221 =
522                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
523                     if (interfaceOptional221.isEmpty()) {
524                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
525                         return false;
526                     }
527                     powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName,
528                             txPower, deviceTransactionManager, interfaceOptional221.orElseThrow());
529                     break;
530                 case 3:
531                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp
532                             .Interface> interfaceOptional710 =
533                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
534                     if (interfaceOptional710.isEmpty()) {
535                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
536                         return false;
537                     }
538                     // Check the support-interface-cap type
539                     // Get the logical connection point name from the interface-name, by splitting it by "-"
540                     // and discard the last part. For instance XPDR1-NETWORK1-xxx:xxx
541                     String logicalConnectionPoint =
542                         Arrays.stream(interfaceName.split("-", 3)).limit(2).collect(Collectors.joining("-"));
543                     LOG.info("Logical connection point {} for Interface {}", logicalConnectionPoint, interfaceName);
544                     Mapping portMap = portMapping.getMapping(nodeId, logicalConnectionPoint);
545                     if (portMap == null) {
546                         throw new OpenRoadmInterfaceException(
547                                 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnectionPoint));
548                     }
549                     powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName,
550                         txPower, deviceTransactionManager, interfaceOptional710.orElseThrow(), portMap);
551                     break;
552                 default:
553                     LOG.error("Unrecognized OpenRoadm version");
554                     return false;
555             }
556         } catch (OpenRoadmInterfaceException ex) {
557             LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex);
558             return false;
559         }
560         if (!powerSetupResult) {
561             LOG.debug("Transponder power setup failed for nodeId {} on interface {}",
562                     nodeId, interfaceName);
563             return false;
564         }
565         LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}",
566                 nodeId,interfaceName);
567         return true;
568     }
569
570 }