renderer/src/main/java/org/opendaylight/transportpce/renderer/ModelMappingUtils.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 package org.opendaylight.transportpce.renderer;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.ArrayList;
  12 import java.util.Iterator;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Optional;
  16 import java.util.TreeMap;
  17 import org.opendaylight.transportpce.common.NodeIdPair;
  18 import org.opendaylight.transportpce.common.StringConstants;
  19 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
  20 import org.opendaylight.transportpce.common.fixedflex.GridUtils;
  21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.device.renderer.rev210618.Action;
  22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.device.renderer.rev210618.OtnServicePathInput;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.device.renderer.rev210618.OtnServicePathInputBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.device.renderer.rev210618.ServicePathInput;
  25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.device.renderer.rev210618.ServicePathInputBuilder;
  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.ServicePowerSetupInputBuilder;
  28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210618.ServiceDeleteOutput;
  29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210618.ServiceDeleteOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210618.ServiceImplementationRequestInput;
  31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210618.ServiceImplementationRequestOutput;
  32 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210618.ServiceImplementationRequestOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.service.types.rev190531.configuration.response.common.ConfigurationResponseCommon;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.service.types.rev190531.configuration.response.common.ConfigurationResponseCommonBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyGHz;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.FrequencyTHz;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.ModulationFormat;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev190531.ServiceDeleteInput;
  39 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.PathDescription;
  40 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.path.description.AToZDirection;
  41 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.path.description.ZToADirection;
  42 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.path.description.atoz.direction.AToZ;
  43 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.path.description.ztoa.direction.ZToA;
  44 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.pce.resource.resource.Resource;
  45 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.pce.resource.resource.resource.TerminationPoint;
  46 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210618.optical.renderer.nodes.Nodes;
  47 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210618.optical.renderer.nodes.NodesBuilder;
  48 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210618.optical.renderer.nodes.NodesKey;
  49 import org.opendaylight.yangtools.yang.common.RpcResult;
  50 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  51 import org.opendaylight.yangtools.yang.common.Uint32;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55
  56
  57 public final class ModelMappingUtils {
  58
  59     private static final Logger LOG = LoggerFactory.getLogger(ModelMappingUtils.class);
  60     private static final String TERMINATION_POINT = "TerminationPoint";
  61     private static final String LINK = "Link";
  62
  63     private ModelMappingUtils() {
  64     }
  65
  66     public static ServicePowerSetupInput createServicePowerSetupInput(List<Nodes> olmList,
  67             ServiceImplementationRequestInput input) {
  68         ServicePowerSetupInputBuilder olmSetupBldr = new ServicePowerSetupInputBuilder().setNodes(olmList);
  69         if (input != null && input.getPathDescription() != null
  70                 && input.getPathDescription().getAToZDirection() != null) {
  71             AToZDirection atoZDirection = input.getPathDescription().getAToZDirection();
  72             olmSetupBldr.setWaveNumber(atoZDirection.getAToZWavelengthNumber());
  73             if (atoZDirection.getAToZMinFrequency() != null) {
  74                 olmSetupBldr.setLowerSpectralSlotNumber(Uint32
  75                         .valueOf(GridUtils
  76                                 .getLowerSpectralIndexFromFrequency(atoZDirection.getAToZMinFrequency().getValue())));
  77             }
  78             if (atoZDirection.getAToZMaxFrequency() != null) {
  79                 olmSetupBldr.setHigherSpectralSlotNumber(Uint32
  80                         .valueOf(GridUtils
  81                                 .getHigherSpectralIndexFromFrequency(atoZDirection.getAToZMaxFrequency().getValue())));
  82             }
  83         }
  84         return olmSetupBldr.build();
  85     }
  86
  87     public static ServiceImplementationRequestOutput createServiceImplResponse(String responseCode, String message) {
  88         return new ServiceImplementationRequestOutputBuilder()
  89                 .setConfigurationResponseCommon(createCommonResponse(responseCode, message))
  90                 .build();
  91     }
  92
  93     public static ServiceDeleteOutput createServiceDeleteResponse(String responseCode, String message) {
  94         return new ServiceDeleteOutputBuilder()
  95                 .setConfigurationResponseCommon(createCommonResponse(responseCode, message))
  96                 .build();
  97     }
  98
  99     public static ConfigurationResponseCommon createCommonResponse(String responseCode, String message) {
 100         return new ConfigurationResponseCommonBuilder()
 101                 .setResponseMessage(message)
 102                 .setResponseCode(responseCode)
 103                 .build();
 104     }
 105
 106     public static ListenableFuture<RpcResult<ServiceImplementationRequestOutput>>
 107             createServiceImplementationRpcResponse(ServiceImplementationRequestOutput payload) {
 108         return RpcResultBuilder.success(payload).buildFuture();
 109     }
 110
 111     public static ListenableFuture<RpcResult<ServiceDeleteOutput>>
 112             createServiceDeleteRpcResponse(ServiceDeleteOutput payload) {
 113         return RpcResultBuilder.success(payload).buildFuture();
 114     }
 115
 116     public static ServicePathInputData rendererCreateServiceInputAToZ(String serviceName,
 117             PathDescription pathDescription, Action operation) {
 118         int scale = GridConstant.FIXED_GRID_FREQUENCY_PRECISION;
 119         AToZDirection atoZDirection = pathDescription.getAToZDirection();
 120         LOG.info("Building ServicePathInputData for a to z direction {}", atoZDirection);
 121         NodeLists nodeLists = getNodesListAToZ(atoZDirection.nonnullAToZ().values().iterator());
 122         ServicePathInputBuilder servicePathInputBuilder = new ServicePathInputBuilder()
 123             .setServiceName(serviceName)
 124             .setOperation(operation)
 125             .setNodes(nodeLists.getRendererNodeList())
 126             .setWidth(new FrequencyGHz(GridConstant.WIDTH_40));
 127         if (atoZDirection.getAToZWavelengthNumber() != null) {
 128             servicePathInputBuilder
 129                 .setWaveNumber(atoZDirection.getAToZWavelengthNumber());
 130         }
 131         if (Uint32.valueOf(GridConstant.IRRELEVANT_WAVELENGTH_NUMBER)
 132                 .equals(atoZDirection.getAToZWavelengthNumber())) {
 133             scale = GridConstant.FLEX_GRID_FREQUENCY_PRECISION;
 134         }
 135         if (atoZDirection.getAToZMinFrequency() != null) {
 136             servicePathInputBuilder.setMinFreq(new FrequencyTHz(atoZDirection.getAToZMinFrequency().getValue()));
 137             servicePathInputBuilder.setLowerSpectralSlotNumber(Uint32
 138                     .valueOf(GridUtils
 139                             .getLowerSpectralIndexFromFrequency(atoZDirection.getAToZMinFrequency().getValue())));
 140         }
 141         if (atoZDirection.getAToZMaxFrequency() != null) {
 142             servicePathInputBuilder.setMaxFreq(new FrequencyTHz(atoZDirection.getAToZMaxFrequency().getValue()));
 143             servicePathInputBuilder.setHigherSpectralSlotNumber(
 144                     Uint32.valueOf(GridUtils
 145                             .getHigherSpectralIndexFromFrequency(atoZDirection.getAToZMaxFrequency().getValue())));
 146         }
 147         if (atoZDirection.getAToZMinFrequency() != null && atoZDirection.getAToZMaxFrequency() != null) {
 148             servicePathInputBuilder.setCenterFreq(
 149                     GridUtils.getCentralFrequencyWithPrecision(atoZDirection.getAToZMinFrequency().getValue(),
 150                             atoZDirection.getAToZMaxFrequency().getValue(), scale));
 151         }
 152         if (atoZDirection.getRate() != null && atoZDirection.getModulationFormat() != null) {
 153             Optional<ModulationFormat> optionalModulationFormat = ModulationFormat
 154                     .forName(atoZDirection.getModulationFormat());
 155             if (optionalModulationFormat.isPresent()
 156                     && GridConstant.FREQUENCY_WIDTH_TABLE
 157                     .contains(atoZDirection.getRate(), optionalModulationFormat.get())) {
 158                 servicePathInputBuilder
 159                     .setWidth(FrequencyGHz
 160                         .getDefaultInstance(GridConstant.FREQUENCY_WIDTH_TABLE.get(atoZDirection.getRate(),
 161                         optionalModulationFormat.get())));
 162             }
 163         }
 164         servicePathInputBuilder.setModulationFormat(atoZDirection.getModulationFormat());
 165         return new ServicePathInputData(servicePathInputBuilder.build(), nodeLists);
 166     }
 167
 168     public static ServicePathInputData rendererCreateServiceInputZToA(String serviceName,
 169             PathDescription pathDescription, Action operation) {
 170         int scale = GridConstant.FIXED_GRID_FREQUENCY_PRECISION;
 171         ZToADirection ztoADirection = pathDescription.getZToADirection();
 172         LOG.info("Building ServicePathInputData for z to a direction {}", ztoADirection);
 173         NodeLists nodeLists = getNodesListZtoA(pathDescription.getZToADirection().nonnullZToA().values().iterator());
 174         ServicePathInputBuilder servicePathInputBuilder = new ServicePathInputBuilder()
 175             .setOperation(operation)
 176             .setServiceName(serviceName)
 177             .setNodes(nodeLists.getRendererNodeList())
 178             .setWidth(new FrequencyGHz(GridConstant.WIDTH_40));
 179         if (ztoADirection.getZToAWavelengthNumber() != null) {
 180             servicePathInputBuilder
 181                 .setWaveNumber(ztoADirection.getZToAWavelengthNumber());
 182         }
 183         if (Uint32.valueOf(GridConstant.IRRELEVANT_WAVELENGTH_NUMBER)
 184                 .equals(ztoADirection.getZToAWavelengthNumber())) {
 185             scale = GridConstant.FLEX_GRID_FREQUENCY_PRECISION;
 186         }
 187         if (ztoADirection.getZToAMinFrequency() != null) {
 188             servicePathInputBuilder.setMinFreq(new FrequencyTHz(ztoADirection.getZToAMinFrequency().getValue()));
 189             servicePathInputBuilder.setLowerSpectralSlotNumber(Uint32
 190                     .valueOf(GridUtils
 191                             .getLowerSpectralIndexFromFrequency(ztoADirection.getZToAMinFrequency().getValue())));
 192         }
 193         if (ztoADirection.getZToAMaxFrequency() != null) {
 194             servicePathInputBuilder.setMaxFreq(new FrequencyTHz(ztoADirection.getZToAMaxFrequency().getValue()));
 195             servicePathInputBuilder.setHigherSpectralSlotNumber(
 196                     Uint32.valueOf(GridUtils
 197                             .getHigherSpectralIndexFromFrequency(ztoADirection.getZToAMaxFrequency().getValue())));
 198         }
 199         if (ztoADirection.getZToAMinFrequency() != null && ztoADirection.getZToAMaxFrequency() != null) {
 200             servicePathInputBuilder.setCenterFreq(
 201                     GridUtils.getCentralFrequencyWithPrecision(ztoADirection.getZToAMinFrequency().getValue(),
 202                             ztoADirection.getZToAMaxFrequency().getValue(), scale));
 203         }
 204         if (ztoADirection.getRate() != null && ztoADirection.getModulationFormat() != null) {
 205             Optional<ModulationFormat> optionalModulationFormat = ModulationFormat
 206                     .forName(ztoADirection.getModulationFormat());
 207             if (optionalModulationFormat.isPresent()
 208                     && GridConstant.FREQUENCY_WIDTH_TABLE
 209                     .contains(ztoADirection.getRate(), optionalModulationFormat.get())) {
 210                 servicePathInputBuilder.setWidth(FrequencyGHz
 211                         .getDefaultInstance(GridConstant.FREQUENCY_WIDTH_TABLE.get(ztoADirection.getRate(),
 212                                 optionalModulationFormat.get())));
 213             }
 214         }
 215         servicePathInputBuilder.setModulationFormat(ztoADirection.getModulationFormat());
 216         return new ServicePathInputData(servicePathInputBuilder.build(), nodeLists);
 217     }
 218
 219     // Adding createOtnServiceInputpath for A-Z and Z-A directions as one method
 220     public static OtnServicePathInput rendererCreateOtnServiceInput(String serviceName, Action operation,
 221         String serviceFormat, Uint32 serviceRate, PathDescription pathDescription, boolean asideToZside) {
 222         // If atoZ is set true use A-to-Z direction otherwise use Z-to-A
 223         List<org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210618.otn.renderer.nodes.Nodes> nodes =
 224             new ArrayList<>();
 225         NodeLists nodeLists =
 226             (asideToZside)
 227             ? getNodesListAToZ(pathDescription.getAToZDirection().nonnullAToZ().values().iterator())
 228             : getNodesListZtoA(pathDescription.getZToADirection().nonnullZToA().values().iterator());
 229         LOG.info("These are node-lists {}, {}", nodeLists.getRendererNodeList(), nodeLists.getOlmNodeList());
 230         for (Nodes node: nodeLists.getRendererNodeList()) {
 231             nodes.add(new org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210618.otn.renderer.nodes
 232                 .NodesBuilder()
 233                             .setNodeId(node.getNodeId())
 234                             .setClientTp(node.getSrcTp())
 235                             .setNetworkTp(node.getDestTp())
 236                             .build());
 237         }
 238         OtnServicePathInputBuilder otnServicePathInputBuilder = new OtnServicePathInputBuilder()
 239             .setServiceName(serviceName)
 240             .setOperation(operation)
 241             .setServiceFormat(serviceFormat)
 242             .setServiceRate(serviceRate)
 243             .setNodes(nodes);
 244
 245         // set the trib-slots and trib-ports for the lower oder odu
 246         if (serviceRate.intValue() == 1 || (serviceRate.intValue() == 10)) {
 247             Short tribPort = Short.valueOf(pathDescription.getAToZDirection().getMinTribSlot().getValue()
 248                 .split("\\.")[0]);
 249             Short minTribSlot = Short.valueOf(pathDescription.getAToZDirection().getMinTribSlot().getValue()
 250                 .split("\\.")[1]);
 251             otnServicePathInputBuilder
 252                 .setTribPortNumber(tribPort)
 253                 .setTribSlot(minTribSlot);
 254         }
 255         return otnServicePathInputBuilder.build();
 256     }
 257
 258     public static ServicePathInput rendererDeleteServiceInput(String serviceName,
 259             ServiceDeleteInput serviceDeleteInput) {
 260         //TODO: finish model-model mapping
 261         return new ServicePathInputBuilder().setServiceName(serviceName).build();
 262     }
 263
 264     private static NodeLists getNodesListZtoA(Iterator<ZToA> iterator) {
 265         Map<Integer, NodeIdPair> treeMap = new TreeMap<>();
 266         List<Nodes> olmList = new ArrayList<>();
 267         List<Nodes> list = new ArrayList<>();
 268
 269         while (iterator.hasNext()) {
 270             ZToA pathDesObj = iterator.next();
 271             try {
 272                 populateTreeMap(treeMap, pathDesObj.getResource().getResource(), pathDesObj.getId(), "ZtoA");
 273             } catch (IllegalArgumentException | SecurityException e) {
 274                 //TODO: Auto-generated catch block
 275                 LOG.error("Did not find the getResource method", e);
 276             }
 277         }
 278         populateNodeLists(treeMap, list, olmList, false);
 279         return new NodeLists(olmList, list);
 280     }
 281
 282     private static NodeLists getNodesListAToZ(Iterator<AToZ> iterator) {
 283         Map<Integer, NodeIdPair> treeMap = new TreeMap<>();
 284         List<Nodes> list = new ArrayList<>();
 285         List<Nodes> olmList = new ArrayList<>();
 286
 287         while (iterator.hasNext()) {
 288             AToZ pathDesObj = iterator.next();
 289             try {
 290                 populateTreeMap(treeMap, pathDesObj.getResource().getResource(), pathDesObj.getId(), "AtoZ");
 291             } catch (IllegalArgumentException | SecurityException e) {
 292                 //TODO: Auto-generated catch block
 293                 LOG.error("Did not find the getResource method", e);
 294             }
 295         }
 296         populateNodeLists(treeMap, list, olmList, true);
 297         return new NodeLists(olmList, list);
 298     }
 299
 300     private static void populateTreeMap(Map<Integer, NodeIdPair> treeMap, Resource rsrc, String sortId,
 301             String direction) {
 302         String resourceType = rsrc.implementedInterface().getSimpleName();
 303         LOG.info("Inside {} {}", direction, resourceType);
 304         switch (resourceType) {
 305             case TERMINATION_POINT:
 306                 TerminationPoint tp = (TerminationPoint) rsrc;
 307                 LOG.info(" TP is {} {}", tp.getTpId(), tp.getTpNodeId());
 308                 String tpID = tp.getTpId();
 309
 310                 //TODO: do not rely on ID to be in certain format
 311                 if (tpID.contains("CTP") || tpID.contains("CP")) {
 312                     return;
 313                 }
 314                 String nodeID = "";
 315                 if (tpID.contains(StringConstants.TTP_TOKEN)) {
 316                     nodeID = tp.getTpNodeId().split("-DEG")[0];
 317                 } else if (tpID.contains(StringConstants.PP_TOKEN)) {
 318                     nodeID = tp.getTpNodeId().split("-SRG")[0];
 319                 } else if (tpID.contains(StringConstants.NETWORK_TOKEN)
 320                         || tpID.contains(StringConstants.CLIENT_TOKEN) || tpID.isEmpty()) {
 321                     nodeID = tp.getTpNodeId().split("-XPDR")[0];
 322                 } else {
 323                     return;
 324                 }
 325                 int id = Integer.parseInt(sortId);
 326                 treeMap.put(id, new NodeIdPair(nodeID, tpID));
 327                 return;
 328             case LINK:
 329                 LOG.info("The type is link");
 330                 return;
 331             default:
 332                 LOG.info("The type is not identified: {}", resourceType);
 333                 return;
 334         }
 335     }
 336
 337     @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
 338         value = {"NP_LOAD_OF_KNOWN_NULL_VALUE","RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"},
 339         justification = "loop when value is not always null - "
 340                 + "TODO: check if something exists in Java lib")
 341     private static void populateNodeLists(Map<Integer, NodeIdPair> treeMap, List<Nodes> list, List<Nodes> olmList,
 342             boolean isAToz) {
 343         String desID = null;
 344         String srcID = null;
 345         LOG.info("treeMap values = {}", treeMap.values());
 346         for (NodeIdPair values : treeMap.values()) {
 347             if (srcID == null) {
 348                 srcID = values.getTpID();
 349             } else if (desID == null) {
 350                 desID = values.getTpID();
 351                 NodesBuilder olmNb = new NodesBuilder()
 352                     .setNodeId(values.getNodeID())
 353                     .setDestTp(desID)
 354                     .setSrcTp(srcID);
 355                 olmList.add(olmNb.build());
 356                 if (srcID.isEmpty()) {
 357                     srcID = null;
 358                 }
 359                 if (desID.isEmpty()) {
 360                     desID = new StringBuilder(srcID).toString();
 361                     srcID = null;
 362                 }
 363                 if (isAToz) {
 364                     NodesBuilder nb = new NodesBuilder()
 365                         .withKey(new NodesKey(values.getNodeID()))
 366                         .setDestTp(desID)
 367                         .setSrcTp(srcID);
 368                     if (srcID != null && desID != null && srcID.contains(StringConstants.NETWORK_TOKEN)) {
 369                         nb.setDestTp(srcID).setSrcTp(desID);
 370                     }
 371                     list.add(nb.build());
 372                 } else {
 373                     if (srcID != null && desID != null && !srcID.contains(StringConstants.NETWORK_TOKEN)
 374                         && !desID.contains(StringConstants.NETWORK_TOKEN)) {
 375                         NodesBuilder nb = new NodesBuilder()
 376                             .withKey(new NodesKey(values.getNodeID()))
 377                             .setDestTp(desID)
 378                             .setSrcTp(srcID);
 379                         list.add(nb.build());
 380                     }
 381                 }
 382                 srcID = null;
 383                 desID = null;
 384             } else {
 385                 LOG.warn("both, the source and destination id are not null!");
 386             }
 387         }
 388     }
 389
 390
 391     @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
 392             value = "PZLA_PREFER_ZERO_LENGTH_ARRAYS",
 393             justification = "not relevant to return a zero length array"
 394                     + " as we need real pos")
 395     public static int[] findTheLongestSubstring(String s1, String s2) {
 396         if ((s1 == null) || (s2 == null)) {
 397             return null;
 398         }
 399         int[][] dp = new int[s1.length() + 1][s2.length() + 1];
 400         int maxLen = 0;
 401         int endPos = 0;
 402         for (int i = 1; i < dp.length; i++) {
 403             for (int j = 1; j < dp[0].length; j++) {
 404                 char ch1 = s1.charAt(i - 1);
 405                 char ch2 = s2.charAt(j - 1);
 406                 if (ch1 == ch2) {
 407                     dp[i][j] = dp[i - 1][j - 1] + 1;
 408                     if (dp[i][j] >= maxLen) {
 409                         maxLen = dp[i][j];
 410                         endPos = i;
 411                     }
 412                 }
 413             }
 414         }
 415         return new int[] { endPos - maxLen, endPos };
 416     }
 417
 418 }