pce/src/main/java/org/opendaylight/transportpce/pce/PcePathDescription.java

   1 /*
   2  * Copyright © 2017 AT&T, Inc. 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.pce;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.HashMap;
  12 import java.util.List;
  13 import java.util.Map;
  14 import org.opendaylight.transportpce.common.ResponseCodes;
  15 import org.opendaylight.transportpce.common.StringConstants;
  16 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
  17 import org.opendaylight.transportpce.pce.networkanalyzer.PceLink;
  18 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult;
  19 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.optical.channel.types.rev200529.FrequencyTHz;
  20 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
  21 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.ModulationFormat;
  22 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.AToZDirectionBuilder;
  23 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ZToADirectionBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZ;
  25 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZBuilder;
  26 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZKey;
  27 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToA;
  28 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToABuilder;
  29 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToAKey;
  30 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.Resource;
  31 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.ResourceBuilder;
  32 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.LinkBuilder;
  33 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.NodeBuilder;
  34 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.TerminationPoint;
  35 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.TerminationPointBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
  37 import org.opendaylight.yangtools.yang.common.Uint16;
  38 import org.opendaylight.yangtools.yang.common.Uint32;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 public class PcePathDescription {
  43     /* Logging. */
  44     private static final Logger LOG = LoggerFactory.getLogger(PcePathDescription.class);
  45
  46     private List<PceLink> pathAtoZ = null;
  47     private PceResult rc;
  48     private Map<LinkId, PceLink> allPceLinks = null;
  49
  50     public PcePathDescription(List<PceLink> pathAtoZ, Map<LinkId, PceLink> allPceLinks, PceResult rc) {
  51         super();
  52         this.allPceLinks = allPceLinks;
  53         this.pathAtoZ = pathAtoZ;
  54         this.rc = rc;
  55     }
  56
  57     public PceResult buildDescriptions() {
  58         LOG.info("In buildDescriptions: AtoZ =  {}", pathAtoZ);
  59         Map<AToZKey,AToZ> atozMap = new HashMap<>();
  60         if (pathAtoZ == null) {
  61             rc.setRC(ResponseCodes.RESPONSE_FAILED);
  62             LOG.error("In buildDescriptions: there is empty AtoZ path");
  63             return rc;
  64         }
  65
  66         buildAtoZ(atozMap, pathAtoZ);
  67         rc.setAtoZDirection(buildAtoZDirection(atozMap).build());
  68         List<PceLink> pathZtoA = ImmutableList.copyOf(pathAtoZ).reverse();
  69         LOG.info("In buildDescriptions: ZtoA {}", pathZtoA);
  70
  71         Map<ZToAKey,ZToA> ztoaMap = new HashMap<>();
  72         if (pathZtoA == null) {
  73             rc.setRC(ResponseCodes.RESPONSE_FAILED);
  74             LOG.error("In buildDescriptions: there is empty ZtoA path");
  75             return rc;
  76         }
  77         buildZtoA(ztoaMap, pathZtoA);
  78         rc.setZtoADirection(buildZtoADirection(ztoaMap).build());
  79
  80         return rc;
  81     }
  82
  83     /**
  84      * Create a builder for AtoZDirection object.
  85      * @param atozMap Map of AToZ object
  86      * @return a builder for AtoZDirection object
  87      */
  88     private AToZDirectionBuilder buildAtoZDirection(Map<AToZKey, AToZ> atozMap) {
  89         AToZDirectionBuilder atoZDirectionBldr = new AToZDirectionBuilder()
  90             .setRate(Uint32.valueOf(rc.getRate()))
  91             .setModulationFormat(GridConstant.RATE_MODULATION_FORMAT_MAP
  92                     .getOrDefault(Uint32.valueOf(rc.getRate()), ModulationFormat.DpQpsk).getName())
  93             .setAToZ(atozMap);
  94         switch (rc.getServiceType()) {
  95             case StringConstants.SERVICE_TYPE_100GE:
  96             case StringConstants.SERVICE_TYPE_OTU4:
  97                 atoZDirectionBldr.setAToZMaxFrequency(new FrequencyTHz(rc.getMaxFreq()));
  98                 atoZDirectionBldr.setAToZMinFrequency(new FrequencyTHz(rc.getMinFreq()));
  99                 atoZDirectionBldr.setAToZWavelengthNumber(Uint32.valueOf(rc.getResultWavelength()));
 100                 break;
 101             case StringConstants.SERVICE_TYPE_10GE:
 102             case StringConstants.SERVICE_TYPE_1GE:
 103             case StringConstants.SERVICE_TYPE_ODU4:
 104                 if (rc.getResultTribSlot() != null && rc.getResultTribPort() != null) {
 105                     @SuppressWarnings("unchecked")
 106                     List<Uint16> tribSlotList = (List<Uint16>) rc.getResultTribSlot().values().toArray()[0];
 107                     atoZDirectionBldr.setAToZWavelengthNumber(Uint32.valueOf(0))
 108                             .setTribPortNumber(Uint16.valueOf(rc.getResultTribPort().values().toArray()[0].toString()))
 109                             .setTribSlotNumber(tribSlotList.get(0));
 110                 } else {
 111                     LOG.error("Trib port and trib slot number should be present");
 112                     atoZDirectionBldr.setTribSlotNumber(Uint16.valueOf(0)).setTribPortNumber(Uint16.valueOf(0));
 113                 }
 114                 break;
 115             default:
 116                 break;
 117         }
 118         return atoZDirectionBldr;
 119     }
 120
 121     /**
 122      * Create a builder for ZtoADirection object.
 123      * @param ztoaMap Map of ZToA object
 124      * @return a builder for ZtoADirection object
 125      */
 126     private ZToADirectionBuilder buildZtoADirection(Map<ZToAKey, ZToA> ztoaMap) {
 127         ZToADirectionBuilder ztoADirectionBldr = new ZToADirectionBuilder().setRate(Uint32.valueOf(rc.getRate()))
 128                 .setModulationFormat(GridConstant.RATE_MODULATION_FORMAT_MAP
 129                         .getOrDefault(Uint32.valueOf(rc.getRate()), ModulationFormat.DpQpsk).getName())
 130                 .setZToA(ztoaMap);
 131         switch (rc.getServiceType()) {
 132             case StringConstants.SERVICE_TYPE_100GE:
 133             case StringConstants.SERVICE_TYPE_OTU4:
 134                 ztoADirectionBldr.setZToAMaxFrequency(new FrequencyTHz(rc.getMaxFreq()));
 135                 ztoADirectionBldr.setZToAMinFrequency(new FrequencyTHz(rc.getMinFreq()));
 136                 ztoADirectionBldr.setZToAWavelengthNumber(Uint32.valueOf(rc.getResultWavelength()));
 137                 break;
 138             case StringConstants.SERVICE_TYPE_10GE:
 139             case StringConstants.SERVICE_TYPE_1GE:
 140             case StringConstants.SERVICE_TYPE_ODU4:
 141                 if (rc.getResultTribSlot() != null && rc.getResultTribPort() != null) {
 142                     @SuppressWarnings("unchecked")
 143                     List<Uint16> tribSlotList = (List<Uint16>) rc.getResultTribSlot().values().toArray()[0];
 144                     ztoADirectionBldr.setZToAWavelengthNumber(Uint32.valueOf(0))
 145                             .setTribPortNumber(Uint16.valueOf(rc.getResultTribPort().values().toArray()[0].toString()))
 146                             .setTribSlotNumber(tribSlotList.get(0));
 147                 } else {
 148                     LOG.error("Trib port and trib slot number should be present");
 149                     ztoADirectionBldr.setTribSlotNumber(Uint16.valueOf(0)).setTribPortNumber(Uint16.valueOf(0));
 150                 }
 151                 break;
 152             default:
 153                 break;
 154         }
 155         return ztoADirectionBldr;
 156     }
 157
 158     @SuppressWarnings("java:S138")
 159     //sonar issue This method has 77 lines, which is greater than the 75 lines authorized. Split it into smaller
 160     //ignore as it's not relevant to split it from functional point
 161     private void buildAtoZ(Map<AToZKey, AToZ> atozMap, List<PceLink> path) {
 162         Integer index = 0;
 163         PceLink lastLink = null;
 164         AToZ lastResource = null;
 165
 166         // build A side Client TP
 167         String tpName = path.get(0).getClient();
 168         String xname = path.get(0).getSourceId().getValue();
 169         TerminationPoint stp = new TerminationPointBuilder()
 170                 .setTpId(tpName).setTpNodeId(xname)
 171                 .build();
 172
 173         AToZKey clientKey = new AToZKey(index.toString());
 174         Resource clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 175         AToZ firstResource = new AToZBuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
 176         atozMap.put(firstResource.key(),firstResource);
 177         index += 1;
 178         for (PceLink pcelink : path) {
 179             String srcName = pcelink.getSourceId().getValue();
 180             // Nodes
 181             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 182                 .resource.resource.resource.Node sourceNode = new NodeBuilder()
 183                 .setNodeId(srcName)
 184                 .build();
 185
 186             // Source Resource
 187             AToZKey sourceKey = new AToZKey(index.toString());
 188             Resource nodeResource1 = new ResourceBuilder().setResource(sourceNode).setState(State.InService).build();
 189             AToZ srcResource = new AToZBuilder().setId(srcName).withKey(sourceKey).setResource(nodeResource1).build();
 190             index += 1;
 191             atozMap.put(srcResource.key(),srcResource);
 192
 193             // source TP
 194             tpName = pcelink.getSourceTP().toString();
 195             stp = new TerminationPointBuilder()
 196                     .setTpNodeId(srcName).setTpId(tpName)
 197                     .build();
 198
 199             // Resource
 200             AToZKey srcTPKey = new AToZKey(index.toString());
 201             Resource tpResource1 = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 202             AToZ stpResource = new AToZBuilder().setId(tpName).withKey(srcTPKey).setResource(tpResource1).build();
 203             index += 1;
 204             atozMap.put(stpResource.key(),stpResource);
 205
 206             String linkName = pcelink.getLinkId().getValue();
 207             // Link
 208             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 209                 .resource.resource.resource.Link atozLink = new LinkBuilder()
 210                 .setLinkId(linkName)
 211                 .build();
 212
 213             // Link Resource
 214             AToZKey linkKey = new AToZKey(index.toString());
 215             Resource nodeResource2 = new ResourceBuilder().setResource(atozLink).setState(pcelink.getState()).build();
 216             AToZ linkResource = new AToZBuilder().setId(linkName).withKey(linkKey).setResource(nodeResource2).build();
 217             index += 1;
 218             atozMap.put(linkResource.key(),linkResource);
 219
 220             String destName = pcelink.getDestId().getValue();
 221             // target TP
 222             tpName = pcelink.getDestTP().toString();
 223             TerminationPoint dtp = new TerminationPointBuilder()
 224                 .setTpNodeId(destName).setTpId(tpName)
 225                 .build();
 226
 227             // Resource
 228             AToZKey destTPKey = new AToZKey(index.toString());
 229             Resource tpResource2 = new ResourceBuilder().setResource(dtp).setState(State.InService).build();
 230             AToZ ttpResource = new AToZBuilder().setId(tpName).withKey(destTPKey).setResource(tpResource2).build();
 231             index += 1;
 232             atozMap.put(ttpResource.key(),ttpResource);
 233
 234             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 235                 .resource.resource.resource.Node targetNode = new NodeBuilder()
 236                 .setNodeId(destName)
 237                 .build();
 238
 239             // Target Resource
 240             AToZKey targetKey = new AToZKey(index.toString());
 241             Resource nodeResource3 = new ResourceBuilder().setResource(targetNode).setState(State.InService).build();
 242             lastResource = new AToZBuilder().setId(destName).withKey(targetKey).setResource(nodeResource3).build();
 243
 244             lastLink = pcelink;
 245         }
 246
 247         if (lastResource != null) {
 248             atozMap.put(lastResource.key(),lastResource);
 249         }
 250
 251         // build Z side Client TP
 252         tpName = lastLink.getClient();
 253         xname = lastLink.getDestId().getValue();
 254         stp = new TerminationPointBuilder()
 255                 .setTpNodeId(xname).setTpId(tpName)
 256                 .build();
 257
 258         index += 1;
 259         clientKey = new AToZKey(index.toString());
 260         clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 261         lastResource = new AToZBuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
 262         atozMap.put(lastResource.key(),lastResource);
 263
 264     }
 265
 266     private void buildZtoA(Map<ZToAKey, ZToA> ztoaList, List<PceLink> path) {
 267         Integer index = 0;
 268         PceLink lastLink = null;
 269         ZToA lastResource = null;
 270
 271         // build Z size Client TP
 272         PceLink pcelink = this.allPceLinks.get(path.get(0).getOppositeLink());
 273         String tpName = pcelink.getClient();
 274         String xname = pcelink.getSourceId().getValue();
 275         TerminationPoint stp = new TerminationPointBuilder()
 276                 .setTpNodeId(xname).setTpId(tpName)
 277                 .build();
 278
 279         ZToAKey clientKey = new ZToAKey(index.toString());
 280         Resource clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 281         ZToA firstResource = new ZToABuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
 282         ztoaList.put(firstResource.key(),firstResource);
 283         index += 1;
 284
 285         for (PceLink pcelinkAtoZ : path) {
 286
 287             pcelink = this.allPceLinks.get(pcelinkAtoZ.getOppositeLink());
 288             LOG.debug("link to oppsite: {} to {}", pcelinkAtoZ, pcelink);
 289
 290             String srcName = pcelink.getSourceId().getValue();
 291
 292
 293             // Nodes
 294             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 295                 .resource.resource.resource.Node sourceNode = new NodeBuilder()
 296                 .setNodeId(srcName).build();
 297
 298
 299             // Source Resource
 300             ZToAKey sourceKey = new ZToAKey(index.toString());
 301             Resource nodeResource1 = new ResourceBuilder().setResource(sourceNode).setState(State.InService).build();
 302             ZToA srcResource = new ZToABuilder().setId(srcName).withKey(sourceKey).setResource(nodeResource1).build();
 303             index += 1;
 304             ztoaList.put(srcResource.key(),srcResource);
 305
 306             // source TP
 307             tpName = pcelink.getSourceTP().toString();
 308             stp = new TerminationPointBuilder()
 309                     .setTpNodeId(srcName).setTpId(tpName)
 310                     .build();
 311
 312             // Resource
 313             ZToAKey srcTPKey = new ZToAKey(index.toString());
 314             Resource tpResource1 = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 315             ZToA stpResource = new ZToABuilder().setId(tpName).withKey(srcTPKey).setResource(tpResource1).build();
 316             index += 1;
 317             ztoaList.put(stpResource.key(),stpResource);
 318
 319             String linkName = pcelink.getLinkId().getValue();
 320             // Link
 321             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 322                 .resource.resource.resource.Link ztoaLink = new LinkBuilder()
 323                 .setLinkId(linkName).build();
 324
 325             // Link Resource
 326             ZToAKey linkKey = new ZToAKey(index.toString());
 327             Resource nodeResource2 = new ResourceBuilder().setResource(ztoaLink).setState(State.InService).build();
 328             ZToA linkResource = new ZToABuilder().setId(linkName).withKey(linkKey).setResource(nodeResource2).build();
 329             index += 1;
 330             ztoaList.put(linkResource.key(),linkResource);
 331
 332             String destName = pcelink.getDestId().getValue();
 333             // target TP
 334             tpName = pcelink.getDestTP().toString();
 335             TerminationPoint ttp = new TerminationPointBuilder()
 336                     .setTpNodeId(destName).setTpId(tpName).build();
 337
 338             // Resource
 339             ZToAKey destTPKey = new ZToAKey(index.toString());
 340             Resource tpResource2 = new ResourceBuilder().setResource(ttp).setState(State.InService).build();
 341             ZToA ttpResource = new ZToABuilder().setId(tpName).withKey(destTPKey).setResource(tpResource2).build();
 342             index += 1;
 343             ztoaList.put(ttpResource.key(),ttpResource);
 344
 345
 346             org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
 347                 .resource.resource.resource.Node targetNode = new NodeBuilder()
 348                 .setNodeId(destName).build();
 349             // Target Resource
 350             ZToAKey targetKey = new ZToAKey(index.toString());
 351             Resource nodeResource3 = new ResourceBuilder().setResource(targetNode).setState(State.InService).build();
 352             lastResource = new ZToABuilder().setId(destName).withKey(targetKey).setResource(nodeResource3).build();
 353
 354             lastLink = pcelink;
 355         }
 356         if (lastResource != null) {
 357             ztoaList.put(lastResource.key(),lastResource);
 358         }
 359
 360         // build Z side Client TP
 361         tpName = lastLink.getClient();
 362         xname = lastLink.getDestId().getValue();
 363         stp = new TerminationPointBuilder()
 364                 .setTpNodeId(xname).setTpId(tpName).build();
 365
 366         index += 1;
 367         clientKey = new ZToAKey(index.toString());
 368         clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
 369         lastResource = new ZToABuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
 370         ztoaList.put(lastResource.key(),lastResource);
 371     }
 372
 373     public PceResult getReturnStructure() {
 374         return rc;
 375     }
 376 }