bgp/inet/src/main/java/org/opendaylight/protocol/bgp/inet/AbstractIPRibSupport.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.inet;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.ImmutableCollection;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.Optional;
  14 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  15 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  16 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  17 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
  22 import org.opendaylight.yangtools.yang.binding.DataObject;
  23 import org.opendaylight.yangtools.yang.binding.Identifier;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  31 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * Common {@link org.opendaylight.protocol.bgp.rib.spi.RIBSupport} class for IPv4 and IPv6 addresses.
  38  */
  39 abstract class AbstractIPRibSupport<
  40         C extends Routes & DataObject,
  41         S extends DataObject,
  42         R extends Route,
  43         N extends Identifier>
  44         extends AbstractRIBSupport<C, S, R, N> {
  45     private static final Logger LOG = LoggerFactory.getLogger(AbstractIPRibSupport.class);
  46     private final NodeIdentifier prefixNid;
  47     private final NodeIdentifier nlriRoutesList;
  48     private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
  49
  50     AbstractIPRibSupport(
  51             final BindingNormalizedNodeSerializer mappingService,
  52             final Class<? extends DataObject> prefixClass,
  53             final Class<? extends AddressFamily> addressFamilyClass,
  54             final Class<C> cazeClass,
  55             final Class<S> containerClass,
  56             final Class<R> listClass,
  57             final QName destinationQname, final QName prefixesQname) {
  58         super(mappingService, cazeClass, containerClass, listClass, addressFamilyClass,
  59                 UnicastSubsequentAddressFamily.class, destinationQname);
  60         this.nlriRoutesList = new NodeIdentifier(prefixesQname);
  61         this.cacheableNlriObjects = ImmutableSet.of(prefixClass);
  62         this.prefixNid = new NodeIdentifier(QName.create(routeQName(), "prefix").intern());
  63     }
  64
  65     final NodeIdentifier routePrefixIdentifier() {
  66         return this.prefixNid;
  67     }
  68
  69     @Override
  70     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  71         return this.cacheableNlriObjects;
  72     }
  73
  74     @Override
  75     protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
  76         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
  77         if (destination != null) {
  78             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes =
  79                     destination.getChild(this.nlriRoutesList);
  80             if (maybeRoutes.isPresent()) {
  81                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
  82                 if (routes instanceof UnkeyedListNode) {
  83                     // Instance identifier to table/(choice routes)/(map of route)
  84                     // FIXME: cache on per-table basis (in TableContext, for example)
  85                     final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(routeNid());
  86                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
  87                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
  88                         function.apply(tx, base, routeKey, e, attributes);
  89                     }
  90                 } else {
  91                     LOG.warn("Routes {} are not a map", routes);
  92                 }
  93             }
  94         }
  95     }
  96
  97     /**
  98      * Prefix and Path Id are the route key.
  99      *
 100      * @param prefixes UnkeyedListEntryNode containing route
 101      * @return Nid with Route Key
 102      */
 103     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode prefixes) {
 104         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePrefixLeaf =
 105                 prefixes.getChild(routePrefixIdentifier());
 106         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
 107                 prefixes.getChild(routePathIdNid());
 108         Preconditions.checkState(maybePrefixLeaf.isPresent());
 109         final Object prefixValue = maybePrefixLeaf.get().getValue();
 110         return PathIdUtil.createNidKey(routeQName(), routeKeyQName(), pathIdQName(), prefixValue, maybePathIdLeaf);
 111     }
 112 }