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