pcep/tunnel/tunnel-provider/src/main/java/org/opendaylight/bgpcep/pcep/tunnel/provider/TunnelProviderDeployer.java

   1 /*
   2  * Copyright (c) 2017 AT&T Intellectual Property. 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.bgpcep.pcep.tunnel.provider;
   9
  10 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION;
  11
  12 import java.util.Collection;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.concurrent.TimeUnit;
  17 import java.util.stream.Collectors;
  18 import org.apache.commons.lang3.StringUtils;
  19 import org.checkerframework.checker.lock.qual.GuardedBy;
  20 import org.opendaylight.mdsal.binding.api.ClusteredDataTreeChangeListener;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  23 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  24 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  25 import org.opendaylight.mdsal.binding.api.RpcConsumerRegistry;
  26 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  27 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.config.rev181109.PcepTunnelTopologyConfig;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.TopologyTypes1;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  35 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.osgi.framework.BundleContext;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 public final class TunnelProviderDeployer implements ClusteredDataTreeChangeListener<Topology>, AutoCloseable {
  42
  43     private static final Logger LOG = LoggerFactory.getLogger(TunnelProviderDeployer.class);
  44
  45     private static final long TIMEOUT_NS = TimeUnit.SECONDS.toNanos(5);
  46     private final TunnelProviderDependencies dependencies;
  47     private final InstanceIdentifier<Topology> networTopology;
  48     @GuardedBy("this")
  49     private final Map<TopologyId, PCEPTunnelClusterSingletonService> pcepTunnelServices = new HashMap<>();
  50     @GuardedBy("this")
  51     private ListenerRegistration<TunnelProviderDeployer> listenerRegistration;
  52
  53     public TunnelProviderDeployer(
  54             final DataBroker dataBroker,
  55             final RpcProviderService rpcProviderRegistry,
  56             final RpcConsumerRegistry rpcConsumerRegistry,
  57             final BundleContext bundleContext,
  58             final ClusterSingletonServiceProvider cssp
  59     ) {
  60         LOG.info("Creating Tunnel Provider Deployer");
  61         this.dependencies = new TunnelProviderDependencies(dataBroker, cssp, rpcProviderRegistry, rpcConsumerRegistry,
  62                 bundleContext);
  63         this.networTopology = InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class).build();
  64     }
  65
  66     @SuppressWarnings("checkstyle:IllegalCatch")
  67     private static void closeTopology(final PCEPTunnelClusterSingletonService topology, final TopologyId topologyId) {
  68         if (topology != null) {
  69             try {
  70                 topology.closeServiceInstance().get(TIMEOUT_NS, TimeUnit.NANOSECONDS);
  71             } catch (final Exception e) {
  72                 LOG.error("Topology {} instance failed to close service instance", topologyId, e);
  73             }
  74             topology.close();
  75         }
  76     }
  77
  78     public synchronized void init() {
  79         LOG.info("Instantiate tunnel topology deployer");
  80         this.listenerRegistration = this.dependencies.getDataBroker().registerDataTreeChangeListener(
  81                 DataTreeIdentifier.create(CONFIGURATION, this.networTopology), this);
  82     }
  83
  84     @Override
  85     public synchronized void onDataTreeChanged(final Collection<DataTreeModification<Topology>> changes) {
  86         final List<DataObjectModification<Topology>> topoChanges = changes.stream()
  87                 .map(DataTreeModification::getRootNode)
  88                 .collect(Collectors.toList());
  89
  90         topoChanges.stream().iterator().forEachRemaining(this::handleTopologyChange);
  91     }
  92
  93     private synchronized void handleTopologyChange(final DataObjectModification<Topology> topo) {
  94         switch (topo.getModificationType()) {
  95             case SUBTREE_MODIFIED:
  96                 updateTunnelTopologyProvider(topo.getDataAfter());
  97                 break;
  98             case WRITE:
  99                 createTunnelTopologyProvider(topo.getDataAfter());
 100                 break;
 101             case DELETE:
 102                 removeTunnelTopologyProvider(topo.getDataBefore());
 103                 break;
 104             default:
 105         }
 106     }
 107
 108     private static boolean filterPcepTopologies(final TopologyTypes topologyTypes) {
 109         if (topologyTypes == null) {
 110             return false;
 111         }
 112         final TopologyTypes1 aug = topologyTypes.augmentation(TopologyTypes1.class);
 113         return aug != null && aug.getTopologyTunnelPcep() != null;
 114     }
 115
 116     private synchronized void createTunnelTopologyProvider(final Topology topology) {
 117         if (!filterPcepTopologies(topology.getTopologyTypes())) {
 118             return;
 119         }
 120         final TopologyId topologyId = topology.getTopologyId();
 121         if (this.pcepTunnelServices.containsKey(topology.getTopologyId())) {
 122             LOG.warn("Tunnel Topology {} already exist. New instance won't be created", topologyId);
 123             return;
 124         }
 125         LOG.debug("Create Tunnel Topology {}", topologyId);
 126
 127         final PcepTunnelTopologyConfig config = topology.augmentation(PcepTunnelTopologyConfig.class);
 128         final String pcepTopoID = StringUtils
 129                 .substringBetween(config.getPcepTopologyReference().getValue(), "=\"", "\"");
 130         final InstanceIdentifier<Topology> pcepTopoRef = InstanceIdentifier.builder(NetworkTopology.class)
 131                 .child(Topology.class, new TopologyKey(new TopologyId(pcepTopoID))).build();
 132
 133
 134         final PCEPTunnelClusterSingletonService tunnelTopoCss =
 135                 new PCEPTunnelClusterSingletonService(this.dependencies, pcepTopoRef, topologyId);
 136         this.pcepTunnelServices.put(topology.getTopologyId(), tunnelTopoCss);
 137     }
 138
 139     private synchronized void updateTunnelTopologyProvider(final Topology topology) {
 140         if (!filterPcepTopologies(topology.getTopologyTypes())) {
 141             return;
 142         }
 143         final TopologyId topologyId = topology.getTopologyId();
 144         final PCEPTunnelClusterSingletonService previous = this.pcepTunnelServices.remove(topology.getTopologyId());
 145         closeTopology(previous, topologyId);
 146         createTunnelTopologyProvider(topology);
 147     }
 148
 149     private synchronized void removeTunnelTopologyProvider(final Topology topo) {
 150         if (!filterPcepTopologies(topo.getTopologyTypes())) {
 151             return;
 152         }
 153         final TopologyId topologyId = topo.getTopologyId();
 154         final PCEPTunnelClusterSingletonService topology = this.pcepTunnelServices.remove(topologyId);
 155         closeTopology(topology, topologyId);
 156     }
 157
 158     @Override
 159     public synchronized void close() {
 160         LOG.info("Closing tunnel topology deployer");
 161         if (this.listenerRegistration != null) {
 162             this.listenerRegistration.close();
 163             this.listenerRegistration = null;
 164         }
 165         this.pcepTunnelServices.values().iterator().forEachRemaining(PCEPTunnelClusterSingletonService::close);
 166         this.pcepTunnelServices.clear();
 167     }
 168 }