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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableCollection;
  13 import com.google.common.collect.ImmutableSet;
  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.rev130925.Route;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.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, final Class<? extends AddressFamily> addressFamilyClass,
  45         final Class<? extends Routes> cazeClass, final Class<? extends DataObject> containerClass, final Class<? extends Route> listClass,
  46         final QName destinationQname, final QName prefixesQname) {
  47         super(cazeClass, containerClass, listClass, addressFamilyClass, UnicastSubsequentAddressFamily.class, "prefix", destinationQname);
  48         this.prefixNid = new NodeIdentifier(routeKeyQName());
  49         this.nlriRoutesList = new NodeIdentifier(prefixesQname);
  50         this.cacheableNlriObjects = ImmutableSet.of(prefixClass);
  51     }
  52
  53     protected final NodeIdentifier routePrefixIdentifier() {
  54         return this.prefixNid;
  55     }
  56
  57     @Nonnull
  58     @Override
  59     public final ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  60         return ImmutableSet.of();
  61     }
  62
  63     @Nonnull
  64     @Override
  65     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  66         return this.cacheableNlriObjects;
  67     }
  68
  69     @Override
  70     public final boolean isComplexRoute() {
  71         return false;
  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 = destination.getChild(this.nlriRoutesList);
  79             if (maybeRoutes.isPresent()) {
  80                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
  81                 if (routes instanceof UnkeyedListNode) {
  82                     // Instance identifier to table/(choice routes)/(map of route)
  83                     // FIXME: cache on per-table basis (in TableContext, for example)
  84                     final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(routeNid());
  85                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
  86                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
  87                         function.apply(tx, base, routeKey, e, attributes);
  88                     }
  89                 } else {
  90                     LOG.warn("Routes {} are not a map", routes);
  91                 }
  92             }
  93         }
  94     }
  95
  96     /**
  97      * Prefix and Path Id are the route key
  98      *
  99      * @param prefixes UnkeyedListEntryNode containing route
 100      * @return Nid with Route Key
 101      */
 102     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode prefixes) {
 103         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePrefixLeaf = prefixes.getChild(routePrefixIdentifier());
 104         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf = prefixes.getChild(routePathIdNid());
 105         Preconditions.checkState(maybePrefixLeaf.isPresent());
 106         final Object prefixValue = (maybePrefixLeaf.get()).getValue();
 107         return PathIdUtil.createNidKey(routeQName(), routeKeyQName(), pathIdQName(), prefixValue, maybePathIdLeaf);
 108     }
 109 }