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