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