tapi/src/main/java/org/opendaylight/transportpce/tapi/topology/TapiNetworkUtilsImpl.java

   1 /*
   2  * Copyright © 2021 Nokia, 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.tapi.topology;
   9
  10 import com.google.common.collect.ImmutableClassToInstanceMap;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.nio.charset.Charset;
  13 import java.util.Map;
  14 import java.util.Set;
  15 import java.util.UUID;
  16 import java.util.concurrent.ExecutionException;
  17 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  19 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  20 import org.opendaylight.transportpce.tapi.TapiStringConstants;
  21 import org.opendaylight.transportpce.tapi.utils.TapiLink;
  22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.DeleteTapiLinkInput;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.DeleteTapiLinkOutput;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.DeleteTapiLinkOutputBuilder;
  25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitRoadmRoadmTapiLinkInput;
  26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitRoadmRoadmTapiLinkOutput;
  27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitRoadmRoadmTapiLinkOutputBuilder;
  28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitXpdrRdmTapiLinkInput;
  29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitXpdrRdmTapiLinkOutput;
  30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.InitXpdrRdmTapiLinkOutputBuilder;
  31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev230728.TransportpceTapinetworkutilsService;
  32 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Context;
  33 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.LayerProtocolName;
  34 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Uuid;
  35 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.Context1;
  36 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.context.TopologyContext;
  37 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link;
  38 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkKey;
  39 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.Topology;
  40 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyKey;
  42 import org.opendaylight.yangtools.concepts.Registration;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.binding.Rpc;
  45 import org.opendaylight.yangtools.yang.common.ErrorType;
  46 import org.opendaylight.yangtools.yang.common.RpcResult;
  47 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  48 import org.osgi.service.component.annotations.Activate;
  49 import org.osgi.service.component.annotations.Component;
  50 import org.osgi.service.component.annotations.Deactivate;
  51 import org.osgi.service.component.annotations.Reference;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 @Component
  56 public class TapiNetworkUtilsImpl implements TransportpceTapinetworkutilsService {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(TapiNetworkUtilsImpl.class);
  59     private final Uuid tapiTopoUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.T0_FULL_MULTILAYER
  60             .getBytes(Charset.forName("UTF-8"))).toString());
  61     private final NetworkTransactionService networkTransactionService;
  62     private final TapiLink tapiLink;
  63     private Registration reg;
  64
  65     @Activate
  66     public TapiNetworkUtilsImpl(@Reference RpcProviderService rpcProviderService,
  67             @Reference NetworkTransactionService networkTransactionService, @Reference TapiLink tapiLink) {
  68         this.networkTransactionService = networkTransactionService;
  69         this.tapiLink = tapiLink;
  70         this.reg = rpcProviderService.registerRpcImplementations(ImmutableClassToInstanceMap.<Rpc<?, ?>>builder()
  71             .put(InitRoadmRoadmTapiLink.class, this::initRoadmRoadmTapiLink)
  72             .put(InitXpdrRdmTapiLink.class, this::initXpdrRdmTapiLink)
  73             .put(DeleteTapiLink.class, this::deleteTapiLink)
  74             .build());
  75         LOG.info("TapiNetworkUtilsImpl instantiated");
  76     }
  77
  78     @Deactivate
  79     public void close() {
  80         this.reg.close();
  81         LOG.info("TapiNetworkUtilsImpl Closed");
  82     }
  83
  84     @Override
  85     public final ListenableFuture<RpcResult<InitRoadmRoadmTapiLinkOutput>> initRoadmRoadmTapiLink(
  86             InitRoadmRoadmTapiLinkInput input) {
  87         // TODO --> need to check if the nodes and neps exist in the topology
  88         String sourceNode = input.getRdmANode();
  89         String sourceTp = input.getDegATp();
  90         String destNode = input.getRdmZNode();
  91         String destTp = input.getDegZTp();
  92         Link link = this.tapiLink.createTapiLink(sourceNode, sourceTp, destNode, destTp,
  93             TapiStringConstants.OMS_RDM_RDM_LINK, TapiStringConstants.PHTNC_MEDIA, TapiStringConstants.PHTNC_MEDIA,
  94             TapiStringConstants.PHTNC_MEDIA, TapiStringConstants.PHTNC_MEDIA,
  95             this.tapiLink.getAdminState(sourceNode, sourceTp, destNode, destTp),
  96             this.tapiLink.getOperState(sourceNode, sourceTp, destNode, destTp),
  97             Set.of(LayerProtocolName.PHOTONICMEDIA), Set.of(LayerProtocolName.PHOTONICMEDIA.getName()), tapiTopoUuid);
  98         InitRoadmRoadmTapiLinkOutputBuilder output = new InitRoadmRoadmTapiLinkOutputBuilder();
  99         if (link == null) {
 100             LOG.error("Error creating link object");
 101             return RpcResultBuilder.<InitRoadmRoadmTapiLinkOutput>failed()
 102                 .withError(ErrorType.RPC, "Failed to create link in topology")
 103                 .buildFuture();
 104         }
 105         if (putLinkInTopology(link)) {
 106             output = new InitRoadmRoadmTapiLinkOutputBuilder()
 107                 .setResult("Link created in tapi topology. Link-uuid = " + link.getUuid());
 108         }
 109         return RpcResultBuilder.success(output.build()).buildFuture();
 110     }
 111
 112     @Override
 113     public final ListenableFuture<RpcResult<InitXpdrRdmTapiLinkOutput>> initXpdrRdmTapiLink(
 114             InitXpdrRdmTapiLinkInput input) {
 115         // TODO --> need to check if the nodes and neps exist in the topology
 116         String destNode = input.getRdmNode();
 117         String destTp = input.getAddDropTp();
 118         String sourceNode = input.getXpdrNode();
 119         String sourceTp = input.getNetworkTp();
 120         Link link = this.tapiLink.createTapiLink(sourceNode, sourceTp, destNode, destTp,
 121             TapiStringConstants.OMS_XPDR_RDM_LINK, TapiStringConstants.OTSI, TapiStringConstants.PHTNC_MEDIA,
 122             TapiStringConstants.PHTNC_MEDIA, TapiStringConstants.PHTNC_MEDIA,
 123             this.tapiLink.getAdminState(sourceNode, sourceTp, destNode, destTp),
 124             this.tapiLink.getOperState(sourceNode, sourceTp, destNode, destTp),
 125             Set.of(LayerProtocolName.PHOTONICMEDIA), Set.of(LayerProtocolName.PHOTONICMEDIA.getName()), tapiTopoUuid);
 126         InitXpdrRdmTapiLinkOutputBuilder output = new InitXpdrRdmTapiLinkOutputBuilder();
 127         if (link == null) {
 128             LOG.error("Error creating link object");
 129             return RpcResultBuilder.<InitXpdrRdmTapiLinkOutput>failed()
 130                 .withError(ErrorType.RPC, "Failed to create link in topology")
 131                 .buildFuture();
 132         }
 133         if (putLinkInTopology(link)) {
 134             output = new InitXpdrRdmTapiLinkOutputBuilder()
 135                 .setResult("Link created in tapi topology. Link-uuid = " + link.getUuid());
 136         }
 137         return RpcResultBuilder.success(output.build()).buildFuture();
 138     }
 139
 140     @Override
 141     public final ListenableFuture<RpcResult<DeleteTapiLinkOutput>> deleteTapiLink(DeleteTapiLinkInput input) {
 142         // TODO: check if this IID is correct
 143         // TODO --> need to check if the link exists in the topology
 144         try {
 145             InstanceIdentifier<Link> linkIID = InstanceIdentifier.builder(Context.class)
 146                 .augmentation(Context1.class).child(TopologyContext.class).child(Topology.class,
 147                         new TopologyKey(tapiTopoUuid)).child(Link.class, new LinkKey(input.getUuid())).build();
 148             this.networkTransactionService.delete(LogicalDatastoreType.OPERATIONAL, linkIID);
 149             this.networkTransactionService.commit().get();
 150             LOG.info("TAPI link deleted successfully.");
 151             return RpcResultBuilder.success(new DeleteTapiLinkOutputBuilder()
 152                 .setResult("Link successfully deleted from tapi topology").build()).buildFuture();
 153         } catch (InterruptedException | ExecutionException e) {
 154             LOG.error("Failed to delete TAPI link", e);
 155             return RpcResultBuilder.<DeleteTapiLinkOutput>failed()
 156                 .withError(ErrorType.RPC, "Failed to delete link from topology")
 157                 .buildFuture();
 158         }
 159     }
 160
 161     public Registration getRegisteredRpc() {
 162         return reg;
 163     }
 164
 165     private boolean putLinkInTopology(Link tapLink) {
 166         // TODO is this merge correct? Should we just merge topology by changing the nodes map??
 167         // TODO: verify this is correct. Should we identify the context IID with the context UUID??
 168         LOG.info("Creating tapi node in TAPI topology context");
 169         InstanceIdentifier<Topology> topoIID = InstanceIdentifier.builder(Context.class)
 170             .augmentation(Context1.class).child(TopologyContext.class)
 171             .child(Topology.class, new TopologyKey(tapiTopoUuid))
 172             .build();
 173
 174         Topology topology = new TopologyBuilder().setUuid(tapiTopoUuid)
 175             .setLink(Map.of(tapLink.key(), tapLink)).build();
 176
 177         // merge in datastore
 178         this.networkTransactionService.merge(LogicalDatastoreType.OPERATIONAL, topoIID,
 179             topology);
 180         try {
 181             this.networkTransactionService.commit().get();
 182
 183         } catch (InterruptedException | ExecutionException e) {
 184             LOG.error("Error populating TAPI topology: ", e);
 185             return false;
 186         }
 187         LOG.info("TAPI Link added succesfully.");
 188         return true;
 189     }
 190 }