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.TopologyKey;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.common.RpcResult;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 import com.google.common.base.Preconditions;
  38 import com.google.common.util.concurrent.FutureCallback;
  39 import com.google.common.util.concurrent.Futures;
  40 import com.google.common.util.concurrent.JdkFutureAdapters;
  41
  42 public abstract class AbstractTopologyBuilder<T extends Route> implements AutoCloseable, DataChangeListener, LocRIBListener,
  43 TopologyReference {
  44         private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  45         private final LocRibReference locRibReference;
  46         private final InstanceIdentifier<Topology> topology;
  47         private final DataProviderService dataProvider;
  48         private final Class<T> idClass;
  49
  50         protected AbstractTopologyBuilder(final DataProviderService dataProvider, final LocRibReference locRibReference, final TopologyId topologyId, final Class<T> idClass) {
  51                 this.dataProvider = Preconditions.checkNotNull(dataProvider);
  52                 this.locRibReference = Preconditions.checkNotNull(locRibReference);
  53                 this.topology = InstanceIdentifier.builder(Topology.class, new TopologyKey(Preconditions.checkNotNull(topologyId))).toInstance();
  54                 this.idClass = Preconditions.checkNotNull(idClass);
  55         }
  56
  57         public final InstanceIdentifier<Tables> tableInstanceIdentifier(final Class<? extends AddressFamily> afi, final Class<? extends SubsequentAddressFamily> safi) {
  58                 return InstanceIdentifier.builder(locRibReference.getInstanceIdentifier()).child(Tables.class, new TablesKey(afi, safi)).toInstance();
  59         }
  60
  61         protected abstract void createObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  62
  63         protected abstract void removeObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  64
  65         public final DataProviderService getDataProvider() {
  66                 return this.dataProvider;
  67         }
  68
  69         @Override
  70         public final InstanceIdentifier<Topology> getInstanceIdentifier() {
  71                 return this.topology;
  72         }
  73
  74         @Override
  75         public final void onLocRIBChange(final DataModification<InstanceIdentifier<?>, DataObject> trans,
  76                         final DataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
  77                 LOG.debug("Received data change {} event with transaction {}", event, trans);
  78
  79                 final Set<InstanceIdentifier<T>> ids = new HashSet<>();
  80                 for (final InstanceIdentifier<?> i : event.getRemovedOperationalData()) {
  81                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
  82                 }
  83                 for (final InstanceIdentifier<?> i : event.getUpdatedOperationalData().keySet()) {
  84                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
  85                 }
  86                 for (final InstanceIdentifier<?> i : event.getCreatedOperationalData().keySet()) {
  87                         ids.add(Preconditions.checkNotNull(i.firstIdentifierOf(this.idClass)));
  88                 }
  89
  90                 final Map<InstanceIdentifier<?>, DataObject> o = event.getOriginalOperationalData();
  91                 final Map<InstanceIdentifier<?>, DataObject> n = event.getUpdatedOperationalData();
  92                 for (final InstanceIdentifier<T> i : ids) {
  93                         final T oldValue = this.idClass.cast(o.get(i));
  94                         final T newValue = this.idClass.cast(n.get(i));
  95
  96                         LOG.debug("Updating object {} value {} -> {}", i, oldValue, newValue);
  97                         if (oldValue != null) {
  98                                 removeObject(trans, i, oldValue);
  99                         }
 100                         if (newValue != null) {
 101                                 createObject(trans, i, newValue);
 102                         }
 103                 }
 104
 105                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 106                         @Override
 107                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 108                                 LOG.trace("Change committed successfully");
 109                         }
 110
 111                         @Override
 112                         public void onFailure(final Throwable t) {
 113                                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this);
 114                         }
 115                 });
 116         }
 117
 118         @Override
 119         public final void close() throws InterruptedException, ExecutionException {
 120                 LOG.info("Shutting down builder for {}", getInstanceIdentifier());
 121                 final DataModificationTransaction trans = this.dataProvider.beginTransaction();
 122                 trans.removeOperationalData(getInstanceIdentifier());
 123                 trans.commit().get();
 124         }
 125
 126         @Override
 127         public final void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 128                 final DataModificationTransaction trans = this.dataProvider.beginTransaction();
 129
 130                 try {
 131                         onLocRIBChange(trans, change);
 132                 } catch (final RuntimeException e) {
 133                         LOG.info("Data change {} was not completely propagated to listener {}", change, this, e);
 134                         return;
 135                 }
 136
 137                 switch (trans.getStatus()) {
 138                 case COMMITED:
 139                 case SUBMITED:
 140                         break;
 141                 case NEW:
 142                         LOG.warn("Data change {} transaction {} was not committed by builder {}", change, trans, this);
 143                         break;
 144                 case CANCELED:
 145                 case FAILED:
 146                         LOG.error("Data change {} transaction {} failed to commit", change, trans);
 147                         break;
 148                 }
 149         }
 150 }