bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/bgp/topology/provider/config/BgpTopologyDeployerImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, 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
   9 package org.opendaylight.bgpcep.bgp.topology.provider.config;
  10
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.util.Collection;
  14 import java.util.Dictionary;
  15 import java.util.HashSet;
  16 import java.util.Hashtable;
  17 import java.util.Set;
  18 import java.util.function.Function;
  19 import java.util.stream.Collectors;
  20 import javax.annotation.concurrent.GuardedBy;
  21 import org.opendaylight.bgpcep.bgp.topology.provider.spi.BgpTopologyDeployer;
  22 import org.opendaylight.bgpcep.bgp.topology.provider.spi.BgpTopologyProvider;
  23 import org.opendaylight.bgpcep.bgp.topology.provider.spi.TopologyReferenceSingletonService;
  24 import org.opendaylight.bgpcep.topology.TopologyReference;
  25 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  28 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  29 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  30 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  32 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  33 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  34 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  35 import org.opendaylight.protocol.bgp.rib.spi.util.ClusterSingletonServiceRegistrationHelper;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  39 import org.opendaylight.yangtools.concepts.AbstractRegistration;
  40 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  43 import org.osgi.framework.BundleContext;
  44 import org.osgi.framework.ServiceRegistration;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 public final class BgpTopologyDeployerImpl implements AutoCloseable, ClusteredDataTreeChangeListener<Topology>, BgpTopologyDeployer {
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(BgpTopologyDeployerImpl.class);
  51     private static final InstanceIdentifier<Topology> TOPOLOGY_IID = InstanceIdentifier.create(NetworkTopology.class).child(Topology.class);
  52
  53     @GuardedBy("this")
  54     private final Set<BgpTopologyProvider> topologyProviders = new HashSet<>();
  55     private final DataBroker dataBroker;
  56     private final ListenerRegistration<BgpTopologyDeployerImpl> registration;
  57     private final BundleContext context;
  58     private final ClusterSingletonServiceProvider singletonProvider;
  59     @GuardedBy("this")
  60     private boolean closed;
  61
  62     public BgpTopologyDeployerImpl(final BundleContext context, final DataBroker dataBroker, final ClusterSingletonServiceProvider singletonProvider) {
  63         this.context = requireNonNull(context);
  64         this.dataBroker = requireNonNull(dataBroker);
  65         this.singletonProvider = requireNonNull(singletonProvider);
  66         this.registration =
  67             this.dataBroker.registerDataTreeChangeListener(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.create(NetworkTopology.class).child(Topology.class)), this);
  68         LOG.info("BGP topology deployer started.");
  69     }
  70
  71     @Override
  72     public synchronized void onDataTreeChanged(final Collection<DataTreeModification<Topology>> changes) {
  73         if (this.closed) {
  74             LOG.trace("BGP Topology Provider Deployer was already closed, skipping changes.");
  75             return;
  76         }
  77         for (final DataTreeModification<Topology> change : changes) {
  78             final DataObjectModification<Topology> rootNode = change.getRootNode();
  79             final Topology dataBefore = rootNode.getDataBefore();
  80             final Topology dataAfter = rootNode.getDataAfter();
  81             LOG.trace("BGP topology deployer configuration changed: modification type: [{}], data before:[{}], data after: [{}]", rootNode.getModificationType(), dataBefore, dataAfter);
  82             switch (rootNode.getModificationType()) {
  83             case DELETE:
  84                 filterTopologyBuilders(dataBefore).forEach(provider -> provider.onTopologyBuilderRemoved(dataBefore));
  85                 break;
  86             case SUBTREE_MODIFIED:
  87                 filterTopologyBuilders(dataBefore).forEach(provider -> provider.onTopologyBuilderRemoved(dataBefore));
  88                 filterTopologyBuilders(dataAfter).forEach(provider -> provider.onTopologyBuilderCreated(dataAfter, null));
  89                 break;
  90             case WRITE:
  91                 filterTopologyBuilders(dataAfter).forEach(provider -> provider.onTopologyBuilderCreated(dataAfter, null));
  92                 break;
  93             default:
  94                 break;
  95             }
  96         }
  97     }
  98
  99     @Override
 100     public synchronized AbstractRegistration registerTopologyProvider(final BgpTopologyProvider topologyBuilder) {
 101         this.topologyProviders.add(topologyBuilder);
 102         return new AbstractRegistration() {
 103             @Override
 104             protected void removeRegistration() {
 105                 synchronized (BgpTopologyDeployerImpl.this) {
 106                     BgpTopologyDeployerImpl.this.topologyProviders.remove(topologyBuilder);
 107                 }
 108             }
 109         };
 110     }
 111
 112     @Override
 113     public DataBroker getDataBroker() {
 114         return this.dataBroker;
 115     }
 116
 117     @Override
 118     public AbstractRegistration registerService(final TopologyReferenceSingletonService topologyProviderService) {
 119         final Dictionary<String, String> properties = new Hashtable<>();
 120         properties.put("topology-id", topologyProviderService.getInstanceIdentifier().firstKeyOf(Topology.class).getTopologyId().getValue());
 121         final ServiceRegistration<?> registerService = this.context.registerService(new String[]{TopologyReference.class.getName()}, topologyProviderService, properties);
 122         final ClusterSingletonServiceRegistration registerClusterSingletonService = registerSingletonService(topologyProviderService);
 123         return new AbstractRegistration() {
 124             @Override
 125             protected void removeRegistration() {
 126                 try {
 127                     registerClusterSingletonService.close();
 128                 } catch (final Exception e) {
 129                     LOG.warn("Failed to close ClusterSingletonServiceRegistration {} for TopologyBuilder {}",
 130                         registerClusterSingletonService, topologyProviderService.getInstanceIdentifier(), e);
 131                 }
 132                 registerService.unregister();
 133             }
 134         };
 135     }
 136
 137     @Override
 138     public void createInstance(final Topology topology) {
 139         final Function<Topology, Void> writeFunction = topology1 -> {
 140             final WriteTransaction wTx = this.dataBroker.newWriteOnlyTransaction();
 141             final KeyedInstanceIdentifier<Topology, TopologyKey> topologyIIdKeyed =
 142                 InstanceIdentifier.create(NetworkTopology.class).child(Topology.class, topology1.getKey());
 143             wTx.put(LogicalDatastoreType.CONFIGURATION, topologyIIdKeyed, topology1, true);
 144             wTx.submit();
 145             return null;
 146         };
 147
 148         filterTopologyBuilders(topology).forEach(provider -> provider.onTopologyBuilderCreated(topology, writeFunction));
 149     }
 150
 151     @Override
 152     public void removeInstance(final Topology topology) {
 153         filterTopologyBuilders(topology).forEach(provider -> provider.onTopologyBuilderRemoved(topology));
 154     }
 155
 156     @Override
 157     public InstanceIdentifier<Topology> getInstanceIdentifier() {
 158         return TOPOLOGY_IID;
 159     }
 160
 161     @Override
 162     public synchronized void close() {
 163         this.registration.close();
 164         LOG.info("BGP topology deployer stopped.");
 165         this.closed = true;
 166     }
 167
 168     private Iterable<BgpTopologyProvider> filterTopologyBuilders(final Topology topology) {
 169         return this.topologyProviders.stream().filter(input -> input.topologyTypeFilter(topology))
 170             .collect(Collectors.toList());
 171     }
 172
 173     private ClusterSingletonServiceRegistration registerSingletonService(
 174         final ClusterSingletonService clusterSingletonService) {
 175         return ClusterSingletonServiceRegistrationHelper
 176             .registerSingletonService(this.singletonProvider, clusterSingletonService);
 177     }
 178
 179 }