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 java.util.HashSet;
  11 import java.util.Map;
  12 import java.util.Set;
  13 import java.util.concurrent.ExecutionException;
  14
  15 import org.opendaylight.bgpcep.topology.TopologyReference;
  16 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  17 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  18 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
  19 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  20 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  21 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  22 import org.opendaylight.protocol.bgp.rib.LocRibReference;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  33 import org.opendaylight.yangtools.yang.binding.DataObject;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.common.RpcResult;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 import com.google.common.base.Preconditions;
  40 import com.google.common.util.concurrent.FutureCallback;
  41 import com.google.common.util.concurrent.Futures;
  42 import com.google.common.util.concurrent.JdkFutureAdapters;
  43
  44 public abstract class AbstractTopologyBuilder<T extends Route> implements AutoCloseable, DataChangeListener, LocRIBListener,
  45 TopologyReference {
  46         private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  47         private final LocRibReference locRibReference;
  48         private final InstanceIdentifier<Topology> topology;
  49         private final DataProviderService dataProvider;
  50         private final Class<T> idClass;
  51
  52         protected AbstractTopologyBuilder(final DataProviderService dataProvider, final LocRibReference locRibReference, 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(Topology.class, tk).toInstance();
  59
  60                 LOG.debug("Initiating topology builder from {} at {}", locRibReference, topology);
  61
  62                 DataModificationTransaction t = dataProvider.beginTransaction();
  63                 Object o = t.readOperationalData(topology);
  64                 Preconditions.checkState(o == null, "Data provider conflict detected on object {}", topology);
  65
  66                 t.putOperationalData(topology, new TopologyBuilder().setKey(tk).setServerProvided(Boolean.TRUE).setTopologyTypes(types).build());
  67                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(t.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
  68                         @Override
  69                         public void onSuccess(final RpcResult<TransactionStatus> result) {
  70                                 LOG.trace("Change committed successfully");
  71                         }
  72
  73                         @Override
  74                         public void onFailure(final Throwable t) {
  75                                 LOG.error("Failed to initiate topology {} by listener {}", topology, AbstractTopologyBuilder.this);
  76                         }
  77                 });
  78         }
  79
  80         public final InstanceIdentifier<Tables> tableInstanceIdentifier(final Class<? extends AddressFamily> afi, final Class<? extends SubsequentAddressFamily> safi) {
  81                 return InstanceIdentifier.builder(locRibReference.getInstanceIdentifier()).child(Tables.class, new TablesKey(afi, safi)).toInstance();
  82         }
  83
  84         protected abstract void createObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  85
  86         protected abstract void removeObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  87
  88         public final DataProviderService getDataProvider() {
  89                 return this.dataProvider;
  90         }
  91
  92         @Override
  93         public final InstanceIdentifier<Topology> getInstanceIdentifier() {
  94                 return this.topology;
  95         }
  96
  97         @Override
  98         public final void onLocRIBChange(final DataModification<InstanceIdentifier<?>, DataObject> trans,
  99                         final DataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 100                 LOG.debug("Received data change {} event with transaction {}", event, trans);
 101
 102                 final Set<InstanceIdentifier<T>> ids = new HashSet<>();
 103                 for (final InstanceIdentifier<?> i : event.getRemovedOperationalData()) {
 104                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
 105                 }
 106                 for (final InstanceIdentifier<?> i : event.getUpdatedOperationalData().keySet()) {
 107                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
 108                 }
 109                 for (final InstanceIdentifier<?> i : event.getCreatedOperationalData().keySet()) {
 110                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
 111                 }
 112
 113                 final Map<InstanceIdentifier<?>, DataObject> o = event.getOriginalOperationalData();
 114                 final Map<InstanceIdentifier<?>, DataObject> n = event.getUpdatedOperationalData();
 115                 for (final InstanceIdentifier<T> i : ids) {
 116                         final T oldValue = this.idClass.cast(o.get(i));
 117                         final T newValue = this.idClass.cast(n.get(i));
 118
 119                         LOG.debug("Updating object {} value {} -> {}", i, oldValue, newValue);
 120                         if (oldValue != null) {
 121                                 removeObject(trans, i, oldValue);
 122                         }
 123                         if (newValue != null) {
 124                                 createObject(trans, i, newValue);
 125                         }
 126                 }
 127
 128                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 129                         @Override
 130                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 131                                 LOG.trace("Change committed successfully");
 132                         }
 133
 134                         @Override
 135                         public void onFailure(final Throwable t) {
 136                                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this);
 137                         }
 138                 });
 139         }
 140
 141         @Override
 142         public final void close() throws InterruptedException, ExecutionException {
 143                 LOG.info("Shutting down builder for {}", getInstanceIdentifier());
 144                 final DataModificationTransaction trans = this.dataProvider.beginTransaction();
 145                 trans.removeOperationalData(getInstanceIdentifier());
 146                 trans.commit().get();
 147         }
 148
 149         @Override
 150         public final void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 151                 final DataModificationTransaction trans = this.dataProvider.beginTransaction();
 152
 153                 try {
 154                         onLocRIBChange(trans, change);
 155                 } catch (final RuntimeException e) {
 156                         LOG.info("Data change {} was not completely propagated to listener {}", change, this, e);
 157                         return;
 158                 }
 159
 160                 switch (trans.getStatus()) {
 161                 case COMMITED:
 162                 case SUBMITED:
 163                         break;
 164                 case NEW:
 165                         LOG.warn("Data change {} transaction {} was not committed by builder {}", change, trans, this);
 166                         break;
 167                 case CANCELED:
 168                 case FAILED:
 169                         LOG.error("Data change {} transaction {} failed to commit", change, trans);
 170                         break;
 171                 }
 172         }
 173 }