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