bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/AbstractRIBSupport.java

   1 /*
   2  * Copyright (c) 2015 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.protocol.bgp.rib.spi;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.BGPRIB_NID;
  13 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.LOCRIB_NID;
  14 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.RIB_NID;
  15 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ROUTES_NID;
  16 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
  17
  18 import com.google.common.annotations.Beta;
  19 import com.google.common.cache.CacheBuilder;
  20 import com.google.common.cache.CacheLoader;
  21 import com.google.common.cache.LoadingCache;
  22 import com.google.common.collect.ImmutableList;
  23 import java.util.Collection;
  24 import java.util.Collections;
  25 import java.util.List;
  26 import java.util.Optional;
  27 import javax.annotation.Nonnull;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  31 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.UpdateBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1Builder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2Builder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutes;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.RouteDistinguisher;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.RouteDistinguisherBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
  62 import org.opendaylight.yangtools.yang.binding.ChildOf;
  63 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  64 import org.opendaylight.yangtools.yang.binding.DataObject;
  65 import org.opendaylight.yangtools.yang.binding.Identifiable;
  66 import org.opendaylight.yangtools.yang.binding.Identifier;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  69 import org.opendaylight.yangtools.yang.common.QName;
  70 import org.opendaylight.yangtools.yang.common.QNameModule;
  71 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  72 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  73 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  75 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  76 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  77 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  78 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  79 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  80 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  81 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  82 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  83 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  84 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  85 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  86 import org.slf4j.Logger;
  87 import org.slf4j.LoggerFactory;
  88
  89 @Beta
  90 public abstract class AbstractRIBSupport<
  91         C extends Routes & DataObject & ChoiceIn<Tables>,
  92         S extends ChildOf<? super C>,
  93         R extends Route & ChildOf<? super S> & Identifiable<I>,
  94         I extends Identifier<R>>
  95         implements RIBSupport<C, S, R, I> {
  96     public static final String ROUTE_KEY = "route-key";
  97     private static final Logger LOG = LoggerFactory.getLogger(AbstractRIBSupport.class);
  98     private static final NodeIdentifier ADVERTISED_ROUTES = NodeIdentifier.create(AdvertizedRoutes.QNAME);
  99     private static final NodeIdentifier WITHDRAWN_ROUTES = NodeIdentifier.create(WithdrawnRoutes.QNAME);
 100     private static final NodeIdentifier DESTINATION_TYPE = NodeIdentifier.create(DestinationType.QNAME);
 101     private static final InstanceIdentifier<Tables> TABLES_II = InstanceIdentifier.builder(BgpRib.class)
 102             .child(Rib.class).child(LocRib.class).child(Tables.class).build();
 103     private static final ApplyRoute DELETE_ROUTE = new DeleteRoute();
 104     // Instance identifier to table/(choice routes)/(map of route)
 105     private final LoadingCache<YangInstanceIdentifier, YangInstanceIdentifier> routesPath = CacheBuilder.newBuilder()
 106             .weakValues().build(new CacheLoader<YangInstanceIdentifier, YangInstanceIdentifier>() {
 107                 @Override
 108                 public YangInstanceIdentifier load(@Nonnull final YangInstanceIdentifier routesTablePaths) {
 109                     return routesTablePaths.node(routesContainerIdentifier()).node(routeQName());
 110                 }
 111             });
 112     private final NodeIdentifier routesContainerIdentifier;
 113     private final NodeIdentifier routesListIdentifier;
 114     private final NodeIdentifier routeAttributesIdentifier;
 115     private final Class<C> cazeClass;
 116     private final Class<S> containerClass;
 117     private final Class<R> listClass;
 118     private final ApplyRoute putRoute = new PutRoute();
 119     private final MapEntryNode emptyTable;
 120     private final QName routeQname;
 121     private final Class<? extends AddressFamily> afiClass;
 122     private final Class<? extends SubsequentAddressFamily> safiClass;
 123     private final NodeIdentifier destinationNid;
 124     private final QName pathIdQname;
 125     private final NodeIdentifier pathIdNid;
 126     private final QName routeKeyQname;
 127     private final NodeIdentifier prefixTypeNid;
 128     private final NodeIdentifier rdNid;
 129     protected final BindingNormalizedNodeSerializer mappingService;
 130     protected final YangInstanceIdentifier routeDefaultYii;
 131     private final TablesKey tk;
 132     private final ImmutableList<PathArgument> relativeRoutesPath;
 133
 134     /**
 135      * Default constructor. Requires the QName of the container augmented under the routes choice
 136      * node in instantiations of the rib grouping. It is assumed that this container is defined by
 137      * the same model which populates it with route grouping instantiation, and by extension with
 138      * the route attributes container.
 139      *
 140      * @param mappingService   Serialization service
 141      * @param cazeClass        Binding class of the AFI/SAFI-specific case statement, must not be null
 142      * @param containerClass   Binding class of the container in routes choice, must not be null.
 143      * @param listClass        Binding class of the route list, nust not be null;
 144      * @param afiClass         address Family Class
 145      * @param safiClass        SubsequentAddressFamily
 146      * @param destContainerQname destination Container Qname
 147      */
 148     protected AbstractRIBSupport(
 149             final BindingNormalizedNodeSerializer mappingService,
 150             final Class<C> cazeClass,
 151             final Class<S> containerClass,
 152             final Class<R> listClass,
 153             final Class<? extends AddressFamily> afiClass,
 154             final Class<? extends SubsequentAddressFamily> safiClass,
 155             final QName destContainerQname) {
 156         final QNameModule module = BindingReflections.getQNameModule(cazeClass);
 157         this.routesContainerIdentifier = NodeIdentifier.create(
 158             BindingReflections.findQName(containerClass).withModule(module));
 159         this.routeAttributesIdentifier = NodeIdentifier.create(Attributes.QNAME.withModule(module));
 160         this.cazeClass = requireNonNull(cazeClass);
 161         this.mappingService = requireNonNull(mappingService);
 162         this.containerClass = requireNonNull(containerClass);
 163         this.listClass = requireNonNull(listClass);
 164         this.routeQname = BindingReflections.findQName(listClass).withModule(module);
 165         this.routesListIdentifier = NodeIdentifier.create(this.routeQname);
 166         this.tk = new TablesKey(afiClass, safiClass);
 167         this.emptyTable = (MapEntryNode) this.mappingService
 168                 .toNormalizedNode(TABLES_II, new TablesBuilder().withKey(tk)
 169                         .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
 170                                 .rev180329.rib.tables.AttributesBuilder().build()).build()).getValue();
 171         this.afiClass = afiClass;
 172         this.safiClass = safiClass;
 173         this.destinationNid = NodeIdentifier.create(destContainerQname);
 174         this.pathIdQname = QName.create(routeQName(), "path-id").intern();
 175         this.pathIdNid = NodeIdentifier.create(this.pathIdQname);
 176         this.routeKeyQname = QName.create(routeQName(), ROUTE_KEY).intern();
 177         this.prefixTypeNid = NodeIdentifier.create(QName.create(destContainerQname, "prefix").intern());
 178         this.rdNid = NodeIdentifier.create(QName.create(destContainerQname, "route-distinguisher").intern());
 179         this.routeDefaultYii =
 180                 YangInstanceIdentifier.builder()
 181                         .node(BGPRIB_NID)
 182                         .node(RIB_NID)
 183                         .node(RIB_NID)
 184                         .node(LOCRIB_NID)
 185                         .node(TABLES_NID)
 186                         .node(TABLES_NID)
 187                         .node(ROUTES_NID)
 188                         .node(this.routesContainerIdentifier)
 189                         .node(this.routesListIdentifier)
 190                         .node(this.routesListIdentifier).build();
 191         this.relativeRoutesPath = ImmutableList.of(routesContainerIdentifier, routesListIdentifier);
 192     }
 193
 194     @Override
 195     public final TablesKey getTablesKey() {
 196         return this.tk;
 197     }
 198
 199     @Override
 200     public final Class<C> routesCaseClass() {
 201         return this.cazeClass;
 202     }
 203
 204     @Override
 205     public final Class<S> routesContainerClass() {
 206         return this.containerClass;
 207     }
 208
 209     @Override
 210     public final Class<R> routesListClass() {
 211         return this.listClass;
 212     }
 213
 214     @Override
 215     public final MapEntryNode emptyTable() {
 216         return this.emptyTable;
 217     }
 218
 219     public final QName routeQName() {
 220         return this.routeQname;
 221     }
 222
 223     protected final NodeIdentifier prefixNid() {
 224         return this.prefixTypeNid;
 225     }
 226
 227     protected final NodeIdentifier routeNid() {
 228         return this.routesListIdentifier;
 229     }
 230
 231     @Override
 232     public final Class<? extends AddressFamily> getAfi() {
 233         return this.afiClass;
 234     }
 235
 236     @Override
 237     public final Class<? extends SubsequentAddressFamily> getSafi() {
 238         return this.safiClass;
 239     }
 240
 241     /**
 242      * Build MpReachNlri object from DOM representation.
 243      *
 244      * @param routes Collection of MapEntryNode DOM representation of routes
 245      * @param hop    CNextHop as it was parsed from Attributes, to be included in MpReach object
 246      * @return MpReachNlri
 247      */
 248     private MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
 249         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
 250         mb.setAfi(this.getAfi());
 251         mb.setSafi(this.getSafi());
 252         mb.setCNextHop(hop);
 253         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(buildDestination(routes)).build());
 254         return mb.build();
 255     }
 256
 257     /**
 258      * Build MpUnReachNlri object from DOM representation.
 259      *
 260      * @param routes Collection of MapEntryNode DOM representation of routes
 261      * @return MpUnreachNlri
 262      */
 263     private MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 264         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 265         mb.setAfi(this.getAfi());
 266         mb.setSafi(this.getSafi());
 267         mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder()
 268                 .setDestinationType(buildWithdrawnDestination(routes)).build());
 269         return mb.build();
 270     }
 271
 272     protected abstract DestinationType buildDestination(Collection<MapEntryNode> routes);
 273
 274     protected abstract DestinationType buildWithdrawnDestination(Collection<MapEntryNode> routes);
 275
 276     /**
 277      * Return the {@link NodeIdentifier} of the AFI/SAFI-specific container under
 278      * the RIB routes.
 279      *
 280      * @return Container identifier, may not be null.
 281      */
 282     public final NodeIdentifier routesContainerIdentifier() {
 283         return this.routesContainerIdentifier;
 284     }
 285
 286     /**
 287      * Return the {@link NodeIdentifier} of the AFI/SAFI-specific container under
 288      * the NLRI destination.
 289      *
 290      * @return Container identifier, may not be null.
 291      */
 292     private NodeIdentifier destinationContainerIdentifier() {
 293         return this.destinationNid;
 294     }
 295
 296     /**
 297      * Given the destination as ContainerNode, implementation needs to parse the DOM model
 298      * from this point onward:
 299      *
 300      * {@code /bgp-mp:mp-unreach-nlri/bgp-mp:withdrawn-routes/bgp-mp:destination-type}
 301      * and delete the routes from its RIBs.
 302      *
 303      * @param tx           DOMDataWriteTransaction to be passed into implementation
 304      * @param tablePath    YangInstanceIdentifier to be passed into implementation
 305      * @param destination  ContainerNode DOM representation of NLRI in Update message
 306      * @param routesNodeId NodeIdentifier
 307      */
 308     private void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 309             final ContainerNode destination, final NodeIdentifier routesNodeId) {
 310         processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
 311     }
 312
 313     /**
 314      * Given the destination as ContainerNode, implementation needs to parse the DOM model
 315      * from this point onward:
 316      *
 317      * {@code /bgp-mp:mp-reach-nlri/bgp-mp:advertized-routes/bgp-mp:destination-type}
 318      * and put the routes to its RIBs.
 319      *
 320      * @param tx           DOMDataWriteTransaction to be passed into implementation
 321      * @param tablePath    YangInstanceIdentifier to be passed into implementation
 322      * @param destination  ContainerNode DOM representation of NLRI in Update message
 323      * @param attributes   ContainerNode to be passed into implementation
 324      * @param routesNodeId NodeIdentifier
 325      * @return List of processed route identifiers
 326      */
 327     private Collection<NodeIdentifierWithPredicates> putDestinationRoutes(final DOMDataWriteTransaction tx,
 328             final YangInstanceIdentifier tablePath, final ContainerNode destination, final ContainerNode attributes,
 329             final NodeIdentifier routesNodeId) {
 330         return processDestination(tx, tablePath.node(routesNodeId), destination, attributes, this.putRoute);
 331     }
 332
 333     protected abstract Collection<NodeIdentifierWithPredicates> processDestination(DOMDataWriteTransaction tx,
 334             YangInstanceIdentifier routesPath, ContainerNode destination, ContainerNode attributes,
 335             ApplyRoute applyFunction);
 336
 337     private static ContainerNode getDestination(final DataContainerChild<? extends PathArgument, ?> routes,
 338             final NodeIdentifier destinationId) {
 339         if (routes instanceof ContainerNode) {
 340             final java.util.Optional<DataContainerChild<? extends PathArgument, ?>> maybeDestination =
 341                     ((ContainerNode) routes).getChild(DESTINATION_TYPE);
 342             if (maybeDestination.isPresent()) {
 343                 final DataContainerChild<? extends PathArgument, ?> destination = maybeDestination.get();
 344                 if (destination instanceof ChoiceNode) {
 345                     final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRet =
 346                             ((ChoiceNode) destination).getChild(destinationId);
 347                     if (maybeRet.isPresent()) {
 348                         final DataContainerChild<? extends PathArgument, ?> ret = maybeRet.get();
 349                         if (ret instanceof ContainerNode) {
 350                             return (ContainerNode) ret;
 351                         }
 352
 353                         LOG.debug("Specified node {} is not a container, ignoring it", ret);
 354                     } else {
 355                         LOG.debug("Specified container {} is not present in destination {}",
 356                                 destinationId, destination);
 357                     }
 358                 } else {
 359                     LOG.warn("Destination {} is not a choice, ignoring it", destination);
 360                 }
 361             } else {
 362                 LOG.debug("Destination is not present in routes {}", routes);
 363             }
 364         } else {
 365             LOG.warn("Advertized routes {} are not a container, ignoring it", routes);
 366         }
 367
 368         return null;
 369     }
 370
 371     @Override
 372     public final NodeIdentifier routeAttributesIdentifier() {
 373         return this.routeAttributesIdentifier;
 374     }
 375
 376     @Override
 377     public final Collection<DataTreeCandidateNode> changedRoutes(final DataTreeCandidateNode routes) {
 378         final DataTreeCandidateNode myRoutes = routes.getModifiedChild(this.routesContainerIdentifier);
 379         if (myRoutes == null) {
 380             return Collections.emptySet();
 381         }
 382         final DataTreeCandidateNode routesMap = myRoutes.getModifiedChild(routeNid());
 383         if (routesMap == null) {
 384             return Collections.emptySet();
 385         }
 386         // Well, given the remote possibility of augmentation, we should perform a filter here,
 387         // to make sure the type matches what routeType() reports.
 388         return routesMap.getChildNodes();
 389     }
 390
 391     @Override
 392     public final YangInstanceIdentifier routesPath(final YangInstanceIdentifier routesTablePaths) {
 393         return routesYangInstanceIdentifier(routesTablePaths.node(ROUTES_NID));
 394     }
 395
 396     @Override
 397     public final List<PathArgument> relativeRoutesPath() {
 398         return relativeRoutesPath;
 399     }
 400
 401     @Override
 402     public final InstanceIdentifier<R> createRouteIdentifier(
 403             final KeyedInstanceIdentifier<Tables, TablesKey> tableIId, final I key) {
 404         //FIXME Cache
 405         return tableIId.child(routesCaseClass(), routesContainerClass()).child(routesListClass(), key);
 406     }
 407
 408     @Override
 409     public final void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 410             final ContainerNode nlri) {
 411         deleteRoutes(tx, tablePath, nlri, ROUTES_NID);
 412     }
 413
 414     @Override
 415     public final Collection<NodeIdentifierWithPredicates> putRoutes(final DOMDataWriteTransaction tx,
 416                                                                     final YangInstanceIdentifier tablePath,
 417                                                                     final ContainerNode nlri,
 418                                                                     final ContainerNode attributes) {
 419         return putRoutes(tx, tablePath, nlri, attributes, ROUTES_NID);
 420     }
 421
 422     @Override
 423     public final Update buildUpdate(final Collection<MapEntryNode> advertised, final Collection<MapEntryNode> withdrawn,
 424             final Attributes attr) {
 425         final UpdateBuilder ub = new UpdateBuilder();
 426         final AttributesBuilder ab = new AttributesBuilder(attr);
 427         final CNextHop hop = ab.getCNextHop();
 428
 429         LOG.debug("cnextHop before={}", hop);
 430         // do not preserve next hop in attributes if we are using MpReach
 431         ab.setCNextHop(null);
 432
 433         if (!advertised.isEmpty()) {
 434             final MpReachNlri mb = buildReach(advertised, hop);
 435             ab.addAugmentation(Attributes1.class, new Attributes1Builder().setMpReachNlri(mb).build());
 436             LOG.debug("mpreach nexthop={}", mb);
 437         }
 438         if (!withdrawn.isEmpty()) {
 439             final MpUnreachNlri mb = buildUnreach(withdrawn);
 440             ab.addAugmentation(Attributes2.class, new Attributes2Builder().setMpUnreachNlri(mb).build());
 441             LOG.debug("mpunrach mb={}", mb);
 442         }
 443
 444         ub.setAttributes(ab.build());
 445         LOG.debug("update {}", ub.build());
 446         return ub.build();
 447     }
 448
 449     @Override
 450     @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
 451     public final void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 452             final ContainerNode nlri, final NodeIdentifier routesNodeId) {
 453         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(WITHDRAWN_ROUTES);
 454         if (maybeRoutes.isPresent()) {
 455             final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
 456             if (destination != null) {
 457                 deleteDestinationRoutes(tx, tablePath, destination, routesNodeId);
 458             }
 459         } else {
 460             LOG.debug("Withdrawn routes are not present in NLRI {}", nlri);
 461         }
 462     }
 463
 464     @Override
 465     public final Collection<NodeIdentifierWithPredicates> putRoutes(final DOMDataWriteTransaction tx,
 466                                                              final YangInstanceIdentifier tablePath,
 467                                                              final ContainerNode nlri,
 468                                                              final ContainerNode attributes,
 469                                                              final NodeIdentifier routesNodeId) {
 470         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(ADVERTISED_ROUTES);
 471         if (maybeRoutes.isPresent()) {
 472             final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
 473             if (destination != null) {
 474                 return putDestinationRoutes(tx, tablePath, destination, attributes, routesNodeId);
 475             }
 476         } else {
 477             LOG.debug("Advertized routes are not present in NLRI {}", nlri);
 478         }
 479         return Collections.emptyList();
 480     }
 481
 482     private static final class DeleteRoute implements ApplyRoute {
 483         @Override
 484         public void apply(final DOMDataWriteTransaction tx, final YangInstanceIdentifier base,
 485                 final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route,
 486                 final ContainerNode attributes) {
 487             tx.delete(LogicalDatastoreType.OPERATIONAL, base.node(routeKey));
 488         }
 489     }
 490
 491     private final class PutRoute implements ApplyRoute {
 492         @Override
 493         public void apply(final DOMDataWriteTransaction tx, final YangInstanceIdentifier base,
 494                 final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route,
 495                 final ContainerNode attributes) {
 496             // Build the DataContainer data
 497             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
 498                     ImmutableNodes.mapEntryBuilder();
 499             b.withNodeIdentifier(routeKey);
 500
 501             route.getValue().forEach(b::withChild);
 502             // Add attributes
 503             final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> cb =
 504                     Builders.containerBuilder(attributes);
 505             cb.withNodeIdentifier(routeAttributesIdentifier());
 506             b.withChild(cb.build());
 507             tx.put(LogicalDatastoreType.OPERATIONAL, base.node(routeKey), b.build());
 508         }
 509     }
 510
 511     protected final NodeIdentifier routePathIdNid() {
 512         return this.pathIdNid;
 513     }
 514
 515     protected final QName pathIdQName() {
 516         return this.pathIdQname;
 517     }
 518
 519     protected final QName routeKeyQName() {
 520         return this.routeKeyQname;
 521     }
 522
 523     protected final String extractPrefix(final DataContainerNode<? extends PathArgument> route) {
 524         return (String) route.getChild(prefixTypeNid).get().getValue();
 525     }
 526
 527     protected final RouteDistinguisher extractRouteDistinguisher(
 528             final DataContainerNode<? extends PathArgument> route) {
 529         if (route.getChild(this.rdNid).isPresent()) {
 530             return RouteDistinguisherBuilder.getDefaultInstance((String) route.getChild(this.rdNid).get().getValue());
 531         }
 532         return null;
 533     }
 534
 535     protected final YangInstanceIdentifier routesYangInstanceIdentifier(final YangInstanceIdentifier routesTablePaths) {
 536         return this.routesPath.getUnchecked(routesTablePaths);
 537     }
 538
 539     @Override
 540     public R fromNormalizedNode(final YangInstanceIdentifier routePath, final NormalizedNode<?, ?> normalizedNode) {
 541         final DataObject node = this.mappingService.fromNormalizedNode(routePath, normalizedNode).getValue();
 542         verify(node instanceof Route, "node %s is not a Route", node);
 543         return (R) node;
 544     }
 545
 546     @Override
 547     public Attributes attributeFromContainerNode(final ContainerNode advertisedAttrs) {
 548         final YangInstanceIdentifier path = this.routeDefaultYii.node(routeAttributesIdentifier());
 549         return (Attributes) this.mappingService.fromNormalizedNode(path, advertisedAttrs).getValue();
 550     }
 551
 552     @Override
 553     public ContainerNode attributeToContainerNode(final YangInstanceIdentifier attPath, final Attributes attributes) {
 554         final InstanceIdentifier<DataObject> iid = this.mappingService.fromYangInstanceIdentifier(attPath);
 555         return (ContainerNode) this.mappingService.toNormalizedNode(iid, attributes).getValue();
 556     }
 557 }