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.Preconditions;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import java.util.Collection;
  14 import java.util.Collections;
  15 import javax.annotation.concurrent.GuardedBy;
  16 import org.opendaylight.bgpcep.topology.TopologyReference;
  17 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  20 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  21 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeService;
  22 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  23 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  30 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  31 import org.opendaylight.protocol.bgp.rib.RibReference;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  46 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 public abstract class AbstractTopologyBuilder<T extends Route> implements AutoCloseable, DataTreeChangeListener<T>, TopologyReference, TransactionChainListener {
  52     private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  53     private final InstanceIdentifier<Topology> topology;
  54     private final BindingTransactionChain chain;
  55     private final RibReference locRibReference;
  56
  57     @GuardedBy("this")
  58     private boolean closed = false;
  59
  60     protected AbstractTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
  61             final TopologyId topologyId, final TopologyTypes types) {
  62         this.locRibReference = Preconditions.checkNotNull(locRibReference);
  63         this.chain = dataProvider.createTransactionChain(this);
  64
  65         final TopologyKey tk = new TopologyKey(Preconditions.checkNotNull(topologyId));
  66         this.topology = InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class, tk).build();
  67
  68         LOG.debug("Initiating topology builder from {} at {}", locRibReference, this.topology);
  69
  70         final WriteTransaction t = this.chain.newWriteOnlyTransaction();
  71
  72         t.put(LogicalDatastoreType.OPERATIONAL, this.topology,
  73                 new TopologyBuilder().setKey(tk).setServerProvided(Boolean.TRUE).setTopologyTypes(types)
  74                     .setLink(Collections.<Link>emptyList()).setNode(Collections.<Node>emptyList()).build(), true);
  75         Futures.addCallback(t.submit(), new FutureCallback<Void>() {
  76             @Override
  77             public void onSuccess(final Void result) {
  78                 LOG.trace("Transaction {} committed successfully", t.getIdentifier());
  79             }
  80
  81             @Override
  82             public void onFailure(final Throwable t) {
  83                 LOG.error("Failed to initiate topology {} by listener {}", AbstractTopologyBuilder.this.topology,
  84                         AbstractTopologyBuilder.this, t);
  85             }
  86         });
  87     }
  88
  89     @Deprecated
  90     public final InstanceIdentifier<Tables> tableInstanceIdentifier(final Class<? extends AddressFamily> afi,
  91             final Class<? extends SubsequentAddressFamily> safi) {
  92         return this.locRibReference.getInstanceIdentifier().builder().child(LocRib.class).child(Tables.class, new TablesKey(afi, safi)).build();
  93     }
  94
  95     public final ListenerRegistration<AbstractTopologyBuilder<T>> start(final DataTreeChangeService service, final Class<? extends AddressFamily> afi,
  96             final Class<? extends SubsequentAddressFamily> safi) {
  97         final InstanceIdentifier<Tables> tablesId = this.locRibReference.getInstanceIdentifier().child(LocRib.class).child(Tables.class, new TablesKey(afi, safi));
  98         final DataTreeIdentifier<T> id = new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, getRouteWildcard(tablesId));
  99
 100         return service.registerDataTreeChangeListener(id, this);
 101     }
 102
 103     protected abstract InstanceIdentifier<T> getRouteWildcard(InstanceIdentifier<Tables> tablesId);
 104
 105     protected abstract void createObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
 106
 107     protected abstract void removeObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
 108
 109     @Override
 110     public final InstanceIdentifier<Topology> getInstanceIdentifier() {
 111         return this.topology;
 112     }
 113
 114     @Override
 115     public final synchronized void close() throws TransactionCommitFailedException {
 116         LOG.info("Shutting down builder for {}", getInstanceIdentifier());
 117         final WriteTransaction trans = this.chain.newWriteOnlyTransaction();
 118         trans.delete(LogicalDatastoreType.OPERATIONAL, getInstanceIdentifier());
 119         trans.submit().checkedGet();
 120         this.chain.close();
 121         this.closed = true;
 122     }
 123
 124     @Override
 125     public synchronized void onDataTreeChanged(final Collection<DataTreeModification<T>> changes) {
 126         if (this.closed) {
 127             LOG.trace("Transaction chain was already closed, skipping update.");
 128             return;
 129         }
 130         final ReadWriteTransaction trans = this.chain.newReadWriteTransaction();
 131         LOG.debug("Received data change {} event with transaction {}", changes, trans.getIdentifier());
 132         for (final DataTreeModification<T> change : changes) {
 133             try {
 134                 routeChanged(change, trans);
 135             } catch (final RuntimeException e) {
 136                 LOG.warn("Data change {} was not completely propagated to listener {}, aborting", change, this, e);
 137                 trans.cancel();
 138                 return;
 139             }
 140         }
 141         Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
 142             @Override
 143             public void onSuccess(final Void result) {
 144                 LOG.trace("Transaction {} committed successfully", trans.getIdentifier());
 145             }
 146
 147             @Override
 148             public void onFailure(final Throwable t) {
 149                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this, t);
 150             }
 151         });
 152     }
 153
 154     private void routeChanged(final DataTreeModification<T> change, final ReadWriteTransaction trans) {
 155         final DataObjectModification<T> root = change.getRootNode();
 156         switch (root.getModificationType()) {
 157         case DELETE:
 158             removeObject(trans, change.getRootPath().getRootIdentifier(), root.getDataBefore());
 159             break;
 160         case SUBTREE_MODIFIED:
 161         case WRITE:
 162             if (root.getDataBefore() != null) {
 163                 removeObject(trans, change.getRootPath().getRootIdentifier(), root.getDataBefore());
 164             }
 165             createObject(trans, change.getRootPath().getRootIdentifier(), root.getDataAfter());
 166             break;
 167         default:
 168             throw new IllegalArgumentException("Unhandled modification type " + root.getModificationType());
 169         }
 170     }
 171
 172     @Override
 173     public final void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 174         // TODO: restart?
 175         LOG.error("Topology builder for {} failed in transaction {}", getInstanceIdentifier(), transaction != null ? transaction.getIdentifier() : null, cause);
 176     }
 177
 178     @Override
 179     public final void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 180         LOG.info("Topology builder for {} shut down", getInstanceIdentifier());
 181     }
 182 }