Rename multiprotocol augmentations
[bgpcep.git] / bgp / rib-spi / src / main / java / org / opendaylight / protocol / bgp / rib / spi / AbstractRIBSupport.java
index 5179b8ebb33d7ce2d859e3ba9671f891cec3ab66..cea5d151c8c82da7c5e550c645897f4a425dc910 100644 (file)
  */
 package org.opendaylight.protocol.bgp.rib.spi;
 
+import static com.google.common.base.Verify.verify;
+import static com.google.common.base.Verify.verifyNotNull;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.BGPRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.LOCRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.RIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ROUTES_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBQNames.AFI_QNAME;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBQNames.SAFI_QNAME;
+
 import com.google.common.annotations.Beta;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
+import com.google.common.collect.ImmutableList;
 import java.util.Collection;
 import java.util.Collections;
-import javax.annotation.Nonnull;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.DestinationType;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
+import java.util.List;
+import java.util.Optional;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.UpdateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesReachBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreachBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisher;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisherBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.SubsequentAddressFamily;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.CNextHop;
+import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
+import org.opendaylight.yangtools.yang.binding.ChildOf;
+import org.opendaylight.yangtools.yang.binding.ChoiceIn;
 import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
+import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.Uint32;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
+import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @Beta
-public abstract class AbstractRIBSupport implements RIBSupport {
+public abstract class AbstractRIBSupport<
+        C extends Routes & DataObject & ChoiceIn<Tables>,
+        S extends ChildOf<? super C>,
+        R extends Route & ChildOf<? super S> & Identifiable<?>>
+        implements RIBSupport<C, S> {
+    public static final String ROUTE_KEY = "route-key";
     private static final Logger LOG = LoggerFactory.getLogger(AbstractRIBSupport.class);
-    private static final NodeIdentifier ADVERTIZED_ROUTES = new NodeIdentifier(AdvertizedRoutes.QNAME);
-    private static final NodeIdentifier WITHDRAWN_ROUTES = new NodeIdentifier(WithdrawnRoutes.QNAME);
-    private static final NodeIdentifier DESTINATION_TYPE = new NodeIdentifier(DestinationType.QNAME);
-    protected static final NodeIdentifier ROUTES = new NodeIdentifier(Routes.QNAME);
+    private static final NodeIdentifier ADVERTISED_ROUTES = NodeIdentifier.create(AdvertizedRoutes.QNAME);
+    private static final NodeIdentifier WITHDRAWN_ROUTES = NodeIdentifier.create(WithdrawnRoutes.QNAME);
+    private static final NodeIdentifier DESTINATION_TYPE = NodeIdentifier.create(DestinationType.QNAME);
+    private static final InstanceIdentifier<Tables> TABLES_II = InstanceIdentifier.builder(BgpRib.class)
+            .child(Rib.class).child(LocRib.class).child(Tables.class).build();
+    private static final ApplyRoute DELETE_ROUTE = new DeleteRoute();
+    private static final ImmutableOffsetMapTemplate<QName> TABLES_KEY_TEMPLATE = ImmutableOffsetMapTemplate.ordered(
+        ImmutableList.of(AFI_QNAME, SAFI_QNAME));
 
+    // Instance identifier to table/(choice routes)/(map of route)
+    private final LoadingCache<YangInstanceIdentifier, YangInstanceIdentifier> routesPath = CacheBuilder.newBuilder()
+            .weakValues().build(new CacheLoader<YangInstanceIdentifier, YangInstanceIdentifier>() {
+                @Override
+                public YangInstanceIdentifier load(final YangInstanceIdentifier routesTablePaths) {
+                    return routesTablePaths.node(routesContainerIdentifier()).node(routeQName());
+                }
+            });
     private final NodeIdentifier routesContainerIdentifier;
     private final NodeIdentifier routesListIdentifier;
     private final NodeIdentifier routeAttributesIdentifier;
-    private final Class<? extends Routes> cazeClass;
-    private final Class<? extends DataObject> containerClass;
-    private final Class<? extends Route> listClass;
+    private final Class<C> cazeClass;
 
+    private final Class<S> containerClass;
+    private final Class<R> listClass;
+    private final ApplyRoute putRoute = new PutRoute();
+    private final MapEntryNode emptyTable;
+    private final QName routeQname;
+    private final QName routeKeyQname;
+    private final Class<? extends AddressFamily> afiClass;
+    private final Class<? extends SubsequentAddressFamily> safiClass;
+    private final NodeIdentifier destinationNid;
+    private final NodeIdentifier pathIdNid;
+    private final NodeIdentifier prefixTypeNid;
+    private final NodeIdentifier rdNid;
+    protected final BindingNormalizedNodeSerializer mappingService;
+    protected final YangInstanceIdentifier routeDefaultYii;
+    private final TablesKey tk;
+    private final NodeIdentifierWithPredicates tablesKey;
+    private final ImmutableList<PathArgument> relativeRoutesPath;
+    private final ImmutableOffsetMapTemplate<QName> routeKeyTemplate;
 
     /**
      * Default constructor. Requires the QName of the container augmented under the routes choice
@@ -55,42 +141,149 @@ public abstract class AbstractRIBSupport implements RIBSupport {
      * the same model which populates it with route grouping instantiation, and by extension with
      * the route attributes container.
      *
-     * @param cazeClass Binding class of the AFI/SAFI-specific case statement, must not be null
-     * @param containerClass Binding class of the container in routes choice, must not be null.
-     * @param listClass Binding class of the route list, nust not be null;
+     * @param mappingService   Serialization service
+     * @param cazeClass        Binding class of the AFI/SAFI-specific case statement, must not be null
+     * @param containerClass   Binding class of the container in routes choice, must not be null.
+     * @param listClass        Binding class of the route list, nust not be null;
+     * @param afiClass         address Family Class
+     * @param safiClass        SubsequentAddressFamily
+     * @param destContainerQname destination Container Qname
      */
-    protected AbstractRIBSupport(final Class<? extends Routes> cazeClass, final Class<? extends DataObject> containerClass, final Class<? extends Route> listClass) {
-        final QName qname = BindingReflections.findQName(containerClass);
-        this.routesContainerIdentifier = new NodeIdentifier(qname);
-        this.routeAttributesIdentifier = new NodeIdentifier(QName.cachedReference(QName.create(qname, Attributes.QNAME.getLocalName())));
-        this.cazeClass = Preconditions.checkNotNull(cazeClass);
-        this.containerClass = Preconditions.checkNotNull(containerClass);
-        this.listClass = Preconditions.checkNotNull(listClass);
-        this.routesListIdentifier = new NodeIdentifier(BindingReflections.findQName(listClass));
+    protected AbstractRIBSupport(
+            final BindingNormalizedNodeSerializer mappingService,
+            final Class<C> cazeClass,
+            final Class<S> containerClass,
+            final Class<R> listClass,
+            final Class<? extends AddressFamily> afiClass,
+            final Class<? extends SubsequentAddressFamily> safiClass,
+            final QName destContainerQname) {
+        final QNameModule module = BindingReflections.getQNameModule(cazeClass);
+        this.routesContainerIdentifier = NodeIdentifier.create(
+            BindingReflections.findQName(containerClass).bindTo(module));
+        this.routeAttributesIdentifier = NodeIdentifier.create(Attributes.QNAME.bindTo(module));
+        this.cazeClass = requireNonNull(cazeClass);
+        this.mappingService = requireNonNull(mappingService);
+        this.containerClass = requireNonNull(containerClass);
+        this.listClass = requireNonNull(listClass);
+        this.routeQname = BindingReflections.findQName(listClass).bindTo(module);
+        this.routeKeyQname = QName.create(module, ROUTE_KEY).intern();
+        this.routesListIdentifier = NodeIdentifier.create(routeQname);
+        this.tk = new TablesKey(afiClass, safiClass);
+        this.tablesKey = NodeIdentifierWithPredicates.of(Tables.QNAME, TABLES_KEY_TEMPLATE.instantiateWithValues(
+            BindingReflections.findQName(afiClass), BindingReflections.findQName(safiClass)));
+
+        this.emptyTable = (MapEntryNode) this.mappingService
+                .toNormalizedNode(TABLES_II, new TablesBuilder().withKey(tk)
+                        .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
+                                .rev180329.rib.tables.AttributesBuilder().build()).build()).getValue();
+        this.afiClass = afiClass;
+        this.safiClass = safiClass;
+        this.destinationNid = NodeIdentifier.create(destContainerQname);
+        this.pathIdNid = NodeIdentifier.create(QName.create(routeQName(), "path-id").intern());
+        this.prefixTypeNid = NodeIdentifier.create(QName.create(destContainerQname, "prefix").intern());
+        this.rdNid = NodeIdentifier.create(QName.create(destContainerQname, "route-distinguisher").intern());
+        this.routeDefaultYii = YangInstanceIdentifier.create(BGPRIB_NID, RIB_NID, RIB_NID, LOCRIB_NID,
+            TABLES_NID, TABLES_NID, ROUTES_NID, routesContainerIdentifier, routesListIdentifier, routesListIdentifier);
+        this.relativeRoutesPath = ImmutableList.of(routesContainerIdentifier, routesListIdentifier);
+        this.routeKeyTemplate = ImmutableOffsetMapTemplate.ordered(
+            ImmutableList.of(this.pathIdNid.getNodeType(), routeKeyQname));
+    }
+
+    @Override
+    public final TablesKey getTablesKey() {
+        return tk;
     }
 
     @Override
-    public final Class<? extends Routes> routesCaseClass() {
-        return this.cazeClass;
+    public final NodeIdentifierWithPredicates tablesKey() {
+        return tablesKey;
     }
 
     @Override
-    public final Class<? extends DataObject> routesContainerClass() {
-        return this.containerClass;
+    public final Class<C> routesCaseClass() {
+        return cazeClass;
     }
 
     @Override
-    public final Class<? extends Route> routesListClass() {
-        return this.listClass;
+    public final Class<S> routesContainerClass() {
+        return containerClass;
+    }
+
+    @Override
+    public final Class<R> routesListClass() {
+        return listClass;
+    }
+
+    @Override
+    public final MapEntryNode emptyTable() {
+        return emptyTable;
+    }
+
+    public final QName routeQName() {
+        return routeQname;
+    }
+
+    protected final NodeIdentifier prefixNid() {
+        return prefixTypeNid;
+    }
+
+    protected final NodeIdentifier routeNid() {
+        return routesListIdentifier;
+    }
+
+    @Override
+    public final Class<? extends AddressFamily> getAfi() {
+        return afiClass;
+    }
+
+    @Override
+    public final Class<? extends SubsequentAddressFamily> getSafi() {
+        return safiClass;
+    }
+
+    /**
+     * Build MpReachNlri object from DOM representation.
+     *
+     * @param routes Collection of MapEntryNode DOM representation of routes
+     * @param hop    CNextHop as it was parsed from Attributes, to be included in MpReach object
+     * @return MpReachNlri
+     */
+    private MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
+        return new MpReachNlriBuilder()
+            .setAfi(getAfi())
+            .setSafi(getSafi())
+            .setCNextHop(hop)
+            .setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(buildDestination(routes)).build())
+            .build();
     }
 
+    /**
+     * Build MpUnReachNlri object from DOM representation.
+     *
+     * @param routes Collection of MapEntryNode DOM representation of routes
+     * @return MpUnreachNlri
+     */
+    private MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
+        return new MpUnreachNlriBuilder()
+            .setAfi(getAfi())
+            .setSafi(getSafi())
+            .setWithdrawnRoutes(new WithdrawnRoutesBuilder()
+                .setDestinationType(buildWithdrawnDestination(routes))
+                .build())
+            .build();
+    }
+
+    protected abstract DestinationType buildDestination(Collection<MapEntryNode> routes);
+
+    protected abstract DestinationType buildWithdrawnDestination(Collection<MapEntryNode> routes);
+
     /**
      * Return the {@link NodeIdentifier} of the AFI/SAFI-specific container under
      * the RIB routes.
      *
      * @return Container identifier, may not be null.
      */
-    protected final NodeIdentifier routesContainerIdentifier() {
+    public final NodeIdentifier routesContainerIdentifier() {
         return this.routesContainerIdentifier;
     }
 
@@ -100,53 +293,71 @@ public abstract class AbstractRIBSupport implements RIBSupport {
      *
      * @return Container identifier, may not be null.
      */
-    @Nonnull protected abstract NodeIdentifier destinationContainerIdentifier();
+    private NodeIdentifier destinationContainerIdentifier() {
+        return this.destinationNid;
+    }
 
     /**
      * Given the destination as ContainerNode, implementation needs to parse the DOM model
      * from this point onward:
      *
-     * {@code /bgp-mp:mp-unreach-nlri/bgp-mp:withdrawn-routes/bgp-mp:destination-type }
-     *
+     * {@code /bgp-mp:mp-unreach-nlri/bgp-mp:withdrawn-routes/bgp-mp:destination-type}
      * and delete the routes from its RIBs.
      *
-     * @param tx DOMDataWriteTransaction to be passed into implementation
-     * @param tablePath YangInstanceIdentifier to be passed into implementation
-     * @param destination ContainerNode DOM representation of NLRI in Update message
+     * @param tx           DOMDataWriteTransaction to be passed into implementation
+     * @param tablePath    YangInstanceIdentifier to be passed into implementation
+     * @param destination  ContainerNode DOM representation of NLRI in Update message
+     * @param routesNodeId NodeIdentifier
      */
-    protected abstract void deleteDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination);
+    private void deleteDestinationRoutes(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier tablePath,
+            final ContainerNode destination, final NodeIdentifier routesNodeId) {
+        processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
+    }
 
     /**
      * Given the destination as ContainerNode, implementation needs to parse the DOM model
      * from this point onward:
      *
-     * {@code /bgp-mp:mp-reach-nlri/bgp-mp:advertized-routes/bgp-mp:destination-type }
-     *
+     * {@code /bgp-mp:mp-reach-nlri/bgp-mp:advertized-routes/bgp-mp:destination-type}
      * and put the routes to its RIBs.
      *
-     * @param tx DOMDataWriteTransaction to be passed into implementation
-     * @param tablePath YangInstanceIdentifier to be passed into implementation
-     * @param destination ContainerNode DOM representation of NLRI in Update message
-     * @param attributes ContainerNode to be passed into implementation
+     * @param tx           DOMDataWriteTransaction to be passed into implementation
+     * @param tablePath    YangInstanceIdentifier to be passed into implementation
+     * @param destination  ContainerNode DOM representation of NLRI in Update message
+     * @param attributes   ContainerNode to be passed into implementation
+     * @param routesNodeId NodeIdentifier
+     * @return List of processed route identifiers
      */
-    protected abstract void putDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination, ContainerNode attributes);
+    private Collection<NodeIdentifierWithPredicates> putDestinationRoutes(final DOMDataTreeWriteTransaction tx,
+            final YangInstanceIdentifier tablePath, final ContainerNode destination, final ContainerNode attributes,
+            final NodeIdentifier routesNodeId) {
+        return processDestination(tx, tablePath.node(routesNodeId), destination, attributes, this.putRoute);
+    }
+
+    protected abstract Collection<NodeIdentifierWithPredicates> processDestination(DOMDataTreeWriteTransaction tx,
+            YangInstanceIdentifier routesPath, ContainerNode destination, ContainerNode attributes,
+            ApplyRoute applyFunction);
 
-    private static ContainerNode getDestination(final DataContainerChild<? extends PathArgument, ?> routes, final NodeIdentifier destinationId) {
+    private static ContainerNode getDestination(final DataContainerChild<? extends PathArgument, ?> routes,
+            final NodeIdentifier destinationId) {
         if (routes instanceof ContainerNode) {
-            final Optional<DataContainerChild<? extends PathArgument, ?>> maybeDestination = ((ContainerNode)routes).getChild(DESTINATION_TYPE);
+            final java.util.Optional<DataContainerChild<? extends PathArgument, ?>> maybeDestination =
+                    ((ContainerNode) routes).getChild(DESTINATION_TYPE);
             if (maybeDestination.isPresent()) {
                 final DataContainerChild<? extends PathArgument, ?> destination = maybeDestination.get();
                 if (destination instanceof ChoiceNode) {
-                    final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRet = ((ChoiceNode)destination).getChild(destinationId);
+                    final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRet =
+                            ((ChoiceNode) destination).getChild(destinationId);
                     if (maybeRet.isPresent()) {
                         final DataContainerChild<? extends PathArgument, ?> ret = maybeRet.get();
                         if (ret instanceof ContainerNode) {
-                            return (ContainerNode)ret;
-                        } else {
-                            LOG.debug("Specified node {} is not a container, ignoring it", ret);
+                            return (ContainerNode) ret;
                         }
+
+                        LOG.debug("Specified node {} is not a container, ignoring it", ret);
                     } else {
-                        LOG.debug("Specified container {} is not present in destination {}", destinationId, destination);
+                        LOG.debug("Specified container {} is not present in destination {}",
+                                destinationId, destination);
                     }
                 } else {
                     LOG.warn("Destination {} is not a choice, ignoring it", destination);
@@ -168,51 +379,214 @@ public abstract class AbstractRIBSupport implements RIBSupport {
 
     @Override
     public final Collection<DataTreeCandidateNode> changedRoutes(final DataTreeCandidateNode routes) {
-        LOG.trace("Changed routes called with {} identifier {}", routes, routes.getIdentifier());
-        final DataTreeCandidateNode myRoutes = routes.getModifiedChild(this.routesContainerIdentifier);
-        if (myRoutes == null) {
-            return Collections.emptySet();
-        }
-        LOG.trace("MyRoutes {} identifier {}", myRoutes, myRoutes.getIdentifier());
-        final DataTreeCandidateNode routesMap = myRoutes.getModifiedChild(this.routesListIdentifier);
-        if (routesMap == null) {
-            return Collections.emptySet();
+        return routes.getModifiedChild(this.routesContainerIdentifier)
+            .flatMap(myRoutes -> myRoutes.getModifiedChild(routeNid()))
+            // Well, given the remote possibility of augmentation, we should perform a filter here,
+            // to make sure the type matches what routeType() reports.
+            .map(DataTreeCandidateNode::getChildNodes)
+            .orElse(Collections.emptySet());
+    }
+
+    @Override
+    public final YangInstanceIdentifier routesPath(final YangInstanceIdentifier routesTablePaths) {
+        return routesYangInstanceIdentifier(routesTablePaths.node(ROUTES_NID));
+    }
+
+    @Override
+    public final List<PathArgument> relativeRoutesPath() {
+        return relativeRoutesPath;
+    }
+
+    @Override
+    public final YangInstanceIdentifier createRouteIdentifier(final YangInstanceIdentifier tablePath,
+            final NodeIdentifierWithPredicates newRouteKey) {
+        return routesPath(tablePath).node(newRouteKey);
+    }
+
+    @Override
+    public final MapEntryNode createRoute(final MapEntryNode route, final NodeIdentifierWithPredicates key,
+            final ContainerNode attributes) {
+        final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder;
+        if (route != null) {
+            builder = Builders.mapEntryBuilder(route);
+        } else {
+            builder = Builders.mapEntryBuilder();
         }
-        LOG.trace("RoutesMap {} identifier {}", routesMap, routesMap.getIdentifier());
-        // Well, given the remote possibility of augmentation, we should perform a filter here,
-        // to make sure the type matches what routeType() reports.
-        LOG.trace("Returning children {}", routesMap.getChildNodes());
-        return routesMap.getChildNodes();
+
+        return builder
+            .withNodeIdentifier(key)
+            .withChild(ImmutableNodes.leafNode(pathIdNid, extractPathId(key)))
+            .withChild(ImmutableNodes.leafNode(routeKeyQname, extractRouteKey(key)))
+            .withChild(attributes)
+            .build();
     }
 
     @Override
-    public final YangInstanceIdentifier routePath(final YangInstanceIdentifier routesPath, final PathArgument routeId) {
-        return routesPath.node(this.routesContainerIdentifier).node(this.routesListIdentifier).node(routeId);
+    public final NodeIdentifierWithPredicates createRouteListArgument(final Uint32 pathId, final String routeKey) {
+        return NodeIdentifierWithPredicates.of(routeQname, routeKeyTemplate.instantiateWithValues(pathId, routeKey));
     }
 
     @Override
-    public final void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode nlri) {
-        final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(WITHDRAWN_ROUTES);
+    public final void deleteRoutes(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier tablePath,
+            final ContainerNode nlri) {
+        deleteRoutes(tx, tablePath, nlri, ROUTES_NID);
+    }
+
+    @Override
+    public final Collection<NodeIdentifierWithPredicates> putRoutes(final DOMDataTreeWriteTransaction tx,
+                                                                    final YangInstanceIdentifier tablePath,
+                                                                    final ContainerNode nlri,
+                                                                    final ContainerNode attributes) {
+        return putRoutes(tx, tablePath, nlri, attributes, ROUTES_NID);
+    }
+
+    @Override
+    public final Collection<NodeIdentifierWithPredicates> putRoutes(final DOMDataTreeWriteTransaction tx,
+                                                                    final YangInstanceIdentifier tablePath,
+                                                                    final ContainerNode nlri,
+                                                                    final ContainerNode attributes,
+                                                                    final NodeIdentifier routesNodeId) {
+        final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(ADVERTISED_ROUTES);
         if (maybeRoutes.isPresent()) {
             final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
             if (destination != null) {
-                deleteDestinationRoutes(tx, tablePath, destination);
+                return putDestinationRoutes(tx, tablePath, destination, attributes, routesNodeId);
             }
         } else {
-            LOG.debug("Withdrawn routes are not present in NLRI {}", nlri);
+            LOG.debug("Advertized routes are not present in NLRI {}", nlri);
         }
+        return Collections.emptyList();
     }
 
     @Override
-    public final void putRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode nlri, final ContainerNode attributes) {
-        final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(ADVERTIZED_ROUTES);
+    public final Update buildUpdate(final Collection<MapEntryNode> advertised, final Collection<MapEntryNode> withdrawn,
+            final Attributes attr) {
+        final UpdateBuilder ub = new UpdateBuilder();
+        final AttributesBuilder ab = new AttributesBuilder(attr);
+        final CNextHop hop = ab.getCNextHop();
+
+        LOG.debug("cnextHop before={}", hop);
+        // do not preserve next hop in attributes if we are using MpReach
+        ab.setCNextHop(null);
+
+        if (!advertised.isEmpty()) {
+            final MpReachNlri mb = buildReach(advertised, hop);
+            ab.addAugmentation(new AttributesReachBuilder().setMpReachNlri(mb).build());
+            LOG.debug("mpreach nexthop={}", mb);
+        }
+        if (!withdrawn.isEmpty()) {
+            final MpUnreachNlri mb = buildUnreach(withdrawn);
+            ab.addAugmentation(new AttributesUnreachBuilder().setMpUnreachNlri(mb).build());
+            LOG.debug("mpunrach mb={}", mb);
+        }
+
+        ub.setAttributes(ab.build());
+        LOG.debug("update {}", ub.build());
+        return ub.build();
+    }
+
+    @Override
+    @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
+    public final void deleteRoutes(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier tablePath,
+            final ContainerNode nlri, final NodeIdentifier routesNodeId) {
+        final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(WITHDRAWN_ROUTES);
         if (maybeRoutes.isPresent()) {
             final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
             if (destination != null) {
-                putDestinationRoutes(tx, tablePath, destination, attributes);
+                deleteDestinationRoutes(tx, tablePath, destination, routesNodeId);
             }
         } else {
-            LOG.debug("Advertized routes are not present in NLRI {}", nlri);
+            LOG.debug("Withdrawn routes are not present in NLRI {}", nlri);
+        }
+    }
+
+    private static final class DeleteRoute implements ApplyRoute {
+        @Override
+        public void apply(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier base,
+                final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route,
+                final ContainerNode attributes) {
+            tx.delete(LogicalDatastoreType.OPERATIONAL, base.node(routeKey));
         }
     }
+
+    private final class PutRoute implements ApplyRoute {
+        @Override
+        public void apply(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier base,
+                final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route,
+                final ContainerNode attributes) {
+            // Build the DataContainer data
+            final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
+                    ImmutableNodes.mapEntryBuilder();
+            b.withNodeIdentifier(routeKey);
+
+            route.getValue().forEach(b::withChild);
+            // Add attributes
+            final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> cb =
+                    Builders.containerBuilder(attributes);
+            cb.withNodeIdentifier(routeAttributesIdentifier());
+            b.withChild(cb.build());
+            tx.put(LogicalDatastoreType.OPERATIONAL, base.node(routeKey), b.build());
+        }
+    }
+
+    protected final NodeIdentifier routePathIdNid() {
+        return pathIdNid;
+    }
+
+    protected final ImmutableOffsetMapTemplate<QName> routeKeyTemplate() {
+        return routeKeyTemplate;
+    }
+
+    protected final String extractPrefix(final DataContainerNode<? extends PathArgument> route) {
+        return (String) route.getChild(prefixTypeNid).get().getValue();
+    }
+
+    protected final RouteDistinguisher extractRouteDistinguisher(
+            // FIXME: remove ? extends
+            final DataContainerNode<? extends PathArgument> route) {
+        final Optional<DataContainerChild<?, ?>> child = route.getChild(rdNid);
+        return child.isPresent() ? RouteDistinguisherBuilder.getDefaultInstance((String) child.orElseThrow().getValue())
+            : null;
+
+    }
+
+    protected final YangInstanceIdentifier routesYangInstanceIdentifier(final YangInstanceIdentifier routesTablePaths) {
+        return routesPath.getUnchecked(routesTablePaths);
+    }
+
+    @Override
+    public R fromNormalizedNode(final YangInstanceIdentifier routePath, final NormalizedNode<?, ?> normalizedNode) {
+        final DataObject node = mappingService.fromNormalizedNode(routePath, normalizedNode).getValue();
+        verify(node instanceof Route, "node %s is not a Route", node);
+        return (R) node;
+    }
+
+    @Override
+    public Attributes attributeFromContainerNode(final ContainerNode advertisedAttrs) {
+        final YangInstanceIdentifier path = this.routeDefaultYii.node(routeAttributesIdentifier());
+        return (Attributes) verifyNotNull(mappingService.fromNormalizedNode(path, advertisedAttrs).getValue());
+    }
+
+    @Override
+    public ContainerNode attributeToContainerNode(final YangInstanceIdentifier attPath, final Attributes attributes) {
+        final InstanceIdentifier<DataObject> iid = this.mappingService.fromYangInstanceIdentifier(attPath);
+        return (ContainerNode) verifyNotNull(mappingService.toNormalizedNode(iid, attributes).getValue());
+    }
+
+    @Override
+    public final String extractRouteKey(final NodeIdentifierWithPredicates routeListKey) {
+        return verifyNotNull(routeListKey.getValue(routeKeyQname, String.class),
+            "Missing route key in %s", routeListKey);
+    }
+
+    @Override
+    public final Uint32 extractPathId(final NodeIdentifierWithPredicates routeListKey) {
+        return verifyNotNull(routeListKey.getValue(pathIdNid.getNodeType(), Uint32.class),
+            "Missing path ID in %s", routeListKey);
+    }
+
+    @Override
+    public final ContainerNode extractAttributes(final MapEntryNode value) {
+        return NormalizedNodes.findNode(value, routeAttributesIdentifier).map(ContainerNode.class::cast).orElse(null);
+    }
 }