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