bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/topology/provider/bgp/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.topology.provider.bgp;
   9
  10 import java.util.HashSet;
  11 import java.util.Map;
  12 import java.util.Set;
  13
  14 import org.opendaylight.bgpcep.topology.TopologyReference;
  15 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  16 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  17 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
  18 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  19 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  20 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  21 import org.opendaylight.protocol.concepts.InstanceIdentifierUtil;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.LocRib;
  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, TopologyReference {
  43         private static final InstanceIdentifier<LocRib> locRIBPath = InstanceIdentifier.builder(LocRib.class).toInstance();
  44         private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  45         private final InstanceIdentifier<Topology> topology;
  46         private final DataProviderService dataProvider;
  47         private final Class<T> idClass;
  48
  49         protected AbstractTopologyBuilder(final DataProviderService dataProvider, final TopologyId topologyId, final Class<T> idClass) {
  50                 this.dataProvider = Preconditions.checkNotNull(dataProvider);
  51                 this.topology = InstanceIdentifier.builder(Topology.class, new TopologyKey(Preconditions.checkNotNull(topologyId))).toInstance();
  52                 this.idClass = Preconditions.checkNotNull(idClass);
  53         }
  54
  55         public static final InstanceIdentifier<Tables> tableInstanceIdentifier(
  56                         final Class<? extends AddressFamily> afi, final Class<? extends SubsequentAddressFamily> safi) {
  57                 return InstanceIdentifier.builder(locRIBPath).child(Tables.class, new TablesKey(afi, safi)).toInstance();
  58         }
  59
  60         protected abstract void createObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  61         protected abstract void removeObject(DataModification<InstanceIdentifier<?>, DataObject> trans, InstanceIdentifier<T> id, T value);
  62
  63         private InstanceIdentifier<T> changedObject(final InstanceIdentifier<?> id) {
  64                 return InstanceIdentifierUtil.firstIdentifierOf(id, idClass);
  65         }
  66
  67         public final DataProviderService getDataProvider() {
  68                 return dataProvider;
  69         }
  70
  71         @Override
  72         public final InstanceIdentifier<Topology> getInstanceIdentifier() {
  73                 return topology;
  74         }
  75
  76         @Override
  77         public final void onLocRIBChange(final DataModification<InstanceIdentifier<?>, DataObject> trans,
  78                         final DataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
  79
  80                 final Set<InstanceIdentifier<T>> ids = new HashSet<>();
  81                 for (final InstanceIdentifier<?> i : event.getRemovedOperationalData()) {
  82                         ids.add(Preconditions.checkNotNull(changedObject(i)));
  83                 }
  84                 for (final InstanceIdentifier<?> i : event.getUpdatedOperationalData().keySet()) {
  85                         ids.add(Preconditions.checkNotNull(changedObject(i)));
  86                 }
  87                 for (final InstanceIdentifier<?> i : event.getCreatedOperationalData().keySet()) {
  88                         ids.add(Preconditions.checkNotNull(changedObject(i)));
  89                 }
  90
  91                 final Map<InstanceIdentifier<?>, DataObject> o = event.getOriginalOperationalData();
  92                 final Map<InstanceIdentifier<?>, DataObject> n = event.getUpdatedOperationalData();
  93                 for (final InstanceIdentifier<T> i : ids) {
  94                         final T oldValue = idClass.cast(o.get(i));
  95                         final T newValue = idClass.cast(n.get(i));
  96
  97                         LOG.debug("Updating object {} value {} -> {}", i, oldValue, newValue);
  98                         if (oldValue != null) {
  99                                 removeObject(trans, i, oldValue);
 100                         }
 101                         if (newValue != null) {
 102                                 createObject(trans, i, newValue);
 103                         }
 104                 }
 105
 106                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()),
 107                                 new FutureCallback<RpcResult<TransactionStatus>>() {
 108                         @Override
 109                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 110                                 // Nothing to do
 111                         }
 112
 113                         @Override
 114                         public void onFailure(final Throwable t) {
 115                                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this);
 116                         }
 117                 });
 118         }
 119
 120         @Override
 121         public final void close() throws Exception {
 122                 final DataModificationTransaction trans = dataProvider.beginTransaction();
 123                 trans.removeOperationalData(getInstanceIdentifier());
 124                 trans.commit().get();
 125         }
 126
 127         @Override
 128         public final void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 129                 final DataModificationTransaction trans = dataProvider.beginTransaction();
 130
 131                 try {
 132                         onLocRIBChange(trans, change);
 133                 } catch (Exception e) {
 134                         LOG.info("Data change {} was not completely propagated to listener {}", change, this, e);
 135                 }
 136
 137                 // FIXME: abort the transaction if it's not committing?
 138         }
 139 }