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

   1 /*
   2  * Copyright (c) 2013 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 package org.opendaylight.bgpcep.bgp.topology.provider;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import java.util.HashSet;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.concurrent.ExecutionException;
  18 import org.opendaylight.bgpcep.topology.TopologyReference;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  26 import org.opendaylight.protocol.bgp.rib.RibReference;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public abstract class AbstractTopologyBuilder<T extends Route> implements AutoCloseable, DataChangeListener, LocRIBListener, TopologyReference {
  45     private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  46     private final RibReference locRibReference;
  47     private final InstanceIdentifier<Topology> topology;
  48     private final DataBroker dataProvider;
  49     private final Class<T> idClass;
  50
  51     protected AbstractTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
  52             final TopologyId topologyId, final TopologyTypes types, final Class<T> idClass) {
  53         this.dataProvider = Preconditions.checkNotNull(dataProvider);
  54         this.locRibReference = Preconditions.checkNotNull(locRibReference);
  55         this.idClass = Preconditions.checkNotNull(idClass);
  56
  57         final TopologyKey tk = new TopologyKey(Preconditions.checkNotNull(topologyId));
  58         this.topology = InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class, tk).toInstance();
  59
  60         LOG.debug("Initiating topology builder from {} at {}", locRibReference, this.topology);
  61
  62         final ReadWriteTransaction t = dataProvider.newReadWriteTransaction();
  63         final Optional<Topology> o;
  64         try {
  65             o = t.read(LogicalDatastoreType.OPERATIONAL, this.topology).get();
  66         } catch (InterruptedException | ExecutionException e) {
  67             throw new IllegalStateException("Failed to read topology " + topology, e);
  68         }
  69         Preconditions.checkState(!o.isPresent(), "Data provider conflict detected on object {}", this.topology);
  70
  71         t.put(LogicalDatastoreType.OPERATIONAL, this.topology,
  72                 new TopologyBuilder().setKey(tk).setServerProvided(Boolean.TRUE).setTopologyTypes(types).build());
  73         Futures.addCallback(t.submit(), new FutureCallback<Void>() {
  74             @Override
  75             public void onSuccess(final Void result) {
  76                 LOG.trace("Transaction {} committed successfully", t.getIdentifier());
  77             }
  78
  79             @Override
  80             public void onFailure(final Throwable t) {
  81                 LOG.error("Failed to initiate topology {} by listener {}", AbstractTopologyBuilder.this.topology,
  82                         AbstractTopologyBuilder.this, t);
  83             }
  84         });
  85     }
  86
  87     public final InstanceIdentifier<Tables> tableInstanceIdentifier(final Class<? extends AddressFamily> afi,
  88             final Class<? extends SubsequentAddressFamily> safi) {
  89         return this.locRibReference.getInstanceIdentifier().builder().child(LocRib.class).child(Tables.class, new TablesKey(afi, safi)).toInstance();
  90     }
  91
  92     protected abstract void createObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
  93
  94     protected abstract void removeObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
  95
  96     public final DataBroker getDataProvider() {
  97         return this.dataProvider;
  98     }
  99
 100     @Override
 101     public final InstanceIdentifier<Topology> getInstanceIdentifier() {
 102         return this.topology;
 103     }
 104
 105     private void addIdentifier(final InstanceIdentifier<?> i, final String set, final Set<InstanceIdentifier<T>> out) {
 106         final InstanceIdentifier<T> id = i.firstIdentifierOf(this.idClass);
 107         if (id != null) {
 108             out.add(id);
 109         } else {
 110             LOG.debug("Identifier {} in {} set does not contain listening class {}, ignoring it", i, set, this.idClass);
 111         }
 112     }
 113
 114     @Override
 115     public final void onLocRIBChange(final ReadWriteTransaction trans,
 116             final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 117         LOG.debug("Received data change {} event with transaction {}", event, trans.getIdentifier());
 118
 119         // FIXME: speed this up
 120         final Set<InstanceIdentifier<T>> ids = new HashSet<>();
 121         for (final InstanceIdentifier<?> i : event.getRemovedPaths()) {
 122             addIdentifier(i, "remove", ids);
 123         }
 124         for (final InstanceIdentifier<?> i : event.getUpdatedData().keySet()) {
 125             addIdentifier(i, "update", ids);
 126         }
 127         for (final InstanceIdentifier<?> i : event.getCreatedData().keySet()) {
 128             addIdentifier(i, "create", ids);
 129         }
 130
 131         final Map<InstanceIdentifier<?>, ? extends DataObject> o = event.getOriginalData();
 132         final Map<InstanceIdentifier<?>, DataObject> u = event.getUpdatedData();
 133         final Map<InstanceIdentifier<?>, DataObject> c = event.getCreatedData();
 134         for (final InstanceIdentifier<T> i : ids) {
 135             final T oldValue = this.idClass.cast(o.get(i));
 136             T newValue = this.idClass.cast(u.get(i));
 137             if (newValue == null) {
 138                 newValue = this.idClass.cast(c.get(i));
 139             }
 140
 141             LOG.debug("Updating object {} value {} -> {}", i, oldValue, newValue);
 142             if (oldValue != null) {
 143                 removeObject(trans, i, oldValue);
 144             }
 145             if (newValue != null) {
 146                 createObject(trans, i, newValue);
 147             }
 148         }
 149
 150         Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
 151             @Override
 152             public void onSuccess(final Void result) {
 153                 LOG.trace("Transaction {} committed successfully", trans.getIdentifier());
 154             }
 155
 156             @Override
 157             public void onFailure(final Throwable t) {
 158                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this);
 159             }
 160         });
 161     }
 162
 163     @Override
 164     public final void close() throws TransactionCommitFailedException {
 165         LOG.info("Shutting down builder for {}", getInstanceIdentifier());
 166         final WriteTransaction trans = this.dataProvider.newWriteOnlyTransaction();
 167         trans.delete(LogicalDatastoreType.OPERATIONAL, getInstanceIdentifier());
 168         trans.submit().checkedGet();
 169     }
 170
 171     @Override
 172     public final void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 173         final ReadWriteTransaction trans = this.dataProvider.newReadWriteTransaction();
 174
 175         try {
 176             onLocRIBChange(trans, change);
 177         } catch (final RuntimeException e) {
 178             LOG.warn("Data change {} was not completely propagated to listener {}", change, this, e);
 179             return;
 180         }
 181     }
 182 }