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.AbstractRIBSupport;
  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.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<R extends Route, N extends Identifier>
  40         extends AbstractRIBSupport<R,N> {
  41     private static final Logger LOG = LoggerFactory.getLogger(AbstractIPRibSupport.class);
  42     private final NodeIdentifier prefixNid;
  43     private final NodeIdentifier nlriRoutesList;
  44     private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
  45     private static final String ROUTE_KEY = "prefix";
  46
  47     protected AbstractIPRibSupport(final Class<? extends DataObject> prefixClass,
  48             final Class<? extends AddressFamily> addressFamilyClass,
  49             final Class<? extends Routes> cazeClass,
  50             final Class<? extends DataObject> containerClass, final Class<? extends Route> listClass,
  51             final QName destinationQname, final QName prefixesQname) {
  52         super(cazeClass, containerClass, listClass, addressFamilyClass,
  53                 UnicastSubsequentAddressFamily.class, ROUTE_KEY, destinationQname);
  54         this.prefixNid = new NodeIdentifier(routeKeyQName());
  55         this.nlriRoutesList = new NodeIdentifier(prefixesQname);
  56         this.cacheableNlriObjects = ImmutableSet.of(prefixClass);
  57     }
  58
  59     protected final NodeIdentifier routePrefixIdentifier() {
  60         return this.prefixNid;
  61     }
  62
  63     @Nonnull
  64     @Override
  65     public final ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  66         return ImmutableSet.of();
  67     }
  68
  69     @Nonnull
  70     @Override
  71     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  72         return this.cacheableNlriObjects;
  73     }
  74
  75     @Override
  76     public final boolean isComplexRoute() {
  77         return false;
  78     }
  79
  80     @Override
  81     protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
  82         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
  83         if (destination != null) {
  84             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes =
  85                     destination.getChild(this.nlriRoutesList);
  86             if (maybeRoutes.isPresent()) {
  87                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
  88                 if (routes instanceof UnkeyedListNode) {
  89                     // Instance identifier to table/(choice routes)/(map of route)
  90                     // FIXME: cache on per-table basis (in TableContext, for example)
  91                     final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(routeNid());
  92                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
  93                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
  94                         function.apply(tx, base, routeKey, e, attributes);
  95                     }
  96                 } else {
  97                     LOG.warn("Routes {} are not a map", routes);
  98                 }
  99             }
 100         }
 101     }
 102
 103     /**
 104      * Prefix and Path Id are the route key.
 105      *
 106      * @param prefixes UnkeyedListEntryNode containing route
 107      * @return Nid with Route Key
 108      */
 109     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode prefixes) {
 110         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePrefixLeaf =
 111                 prefixes.getChild(routePrefixIdentifier());
 112         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
 113                 prefixes.getChild(routePathIdNid());
 114         Preconditions.checkState(maybePrefixLeaf.isPresent());
 115         final Object prefixValue = maybePrefixLeaf.get().getValue();
 116         return PathIdUtil.createNidKey(routeQName(), routeKeyQName(), pathIdQName(), prefixValue, maybePathIdLeaf);
 117     }
 118 }