bgp/extensions/l3vpn/src/main/java/org/opendaylight/protocol/bgp/l3vpn/mcast/AbstractL3vpnMcastIpRIBSupport.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.l3vpn.mcast;
   9
  10 import com.google.common.collect.ImmutableCollection;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import java.util.stream.Collectors;
  18 import org.opendaylight.bgp.concepts.RouteDistinguisherUtil;
  19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  20 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  21 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  22 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutes;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.McastMplsLabeledVpnSubsequentAddressFamily;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestination;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestinationBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRoute;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily;
  32 import org.opendaylight.yangtools.yang.binding.BindingObject;
  33 import org.opendaylight.yangtools.yang.binding.ChildOf;
  34 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  43 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 /**
  51  * Abstract L3VPN Multicast RIBSupport.
  52  *
  53  * @author Claudio D. Gasparini
  54  */
  55 abstract class AbstractL3vpnMcastIpRIBSupport<
  56         C extends Routes & DataObject & ChoiceIn<Tables>,
  57         S extends ChildOf<? super C> & L3vpnMcastRoutes>
  58         extends AbstractRIBSupport<C, S, L3vpnMcastRoute> {
  59     private static final Logger LOG = LoggerFactory.getLogger(AbstractL3vpnMcastIpRIBSupport.class);
  60     private final NodeIdentifier nlriRoutesList;
  61     private final NodeIdentifier rdNid;
  62     private final ImmutableCollection<Class<? extends BindingObject>> cacheableNlriObjects;
  63
  64     /**
  65      * Default constructor. Requires the QName of the container augmented under the routes choice
  66      * node in instantiations of the rib grouping. It is assumed that this container is defined by
  67      * the same model which populates it with route grouping instantiation, and by extension with
  68      * the route attributes container.
  69      *
  70      * @param mappingService     Serialization service
  71      * @param cazeClass          Binding class of the AFI/SAFI-specific case statement, must not be null
  72      * @param afiClass           address Family Class
  73      * @param destContainerQname destination container Qname
  74      * @param destListQname      destinations list Qname
  75      */
  76     AbstractL3vpnMcastIpRIBSupport(
  77             final BindingNormalizedNodeSerializer mappingService,
  78             final Class<C> cazeClass, final QName cazeQName,
  79             final Class<S> containerClass,
  80             final Class<? extends AddressFamily> afiClass,
  81             final QName destContainerQname,
  82             final QName destListQname) {
  83         super(mappingService, cazeClass, containerClass, L3vpnMcastRoute.class, afiClass,
  84                 McastMplsLabeledVpnSubsequentAddressFamily.class, destContainerQname);
  85         this.nlriRoutesList = NodeIdentifier.create(destListQname);
  86         this.rdNid = NodeIdentifier.create(QName.create(cazeQName, "route-distinguisher").intern());
  87         this.cacheableNlriObjects = ImmutableSet.of(cazeClass);
  88     }
  89
  90     @Override
  91     public final ImmutableCollection<Class<? extends BindingObject>> cacheableNlriObjects() {
  92         return this.cacheableNlriObjects;
  93     }
  94
  95     protected abstract IpPrefix createPrefix(String prefix);
  96
  97     @Override
  98     protected final Collection<NodeIdentifierWithPredicates> processDestination(
  99             final DOMDataTreeWriteTransaction tx,
 100             final YangInstanceIdentifier routesPath,
 101             final ContainerNode destination,
 102             final ContainerNode attributes,
 103             final ApplyRoute function) {
 104         if (destination != null) {
 105             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 106                     .getChild(nlriRoutesList);
 107             if (maybeRoutes.isPresent()) {
 108                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 109                 if (routes instanceof UnkeyedListNode) {
 110                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 111                     final Collection<UnkeyedListEntryNode> routesList = ((UnkeyedListNode) routes).getValue();
 112                     final List<NodeIdentifierWithPredicates> keys = new ArrayList<>(routesList.size());
 113                     for (final UnkeyedListEntryNode l3vpnDest : routesList) {
 114                         final YangInstanceIdentifier.NodeIdentifierWithPredicates routeKey = createRouteKey(l3vpnDest);
 115                         function.apply(tx, base, routeKey, l3vpnDest, attributes);
 116                         keys.add(routeKey);
 117                     }
 118                     return keys;
 119                 }
 120                 LOG.warn("Routes {} are not a map", routes);
 121             }
 122         }
 123         return Collections.emptyList();
 124     }
 125
 126     final List<L3vpnMcastDestination> extractRoutes(final Collection<MapEntryNode> routes) {
 127         return routes.stream().map(this::extractDestinations).collect(Collectors.toList());
 128     }
 129
 130     final L3vpnMcastDestination extractDestinations(
 131             final DataContainerNode<? extends PathArgument> destination) {
 132         return new L3vpnMcastDestinationBuilder()
 133                 .setRouteDistinguisher(RouteDistinguisherUtil.extractRouteDistinguisher(destination, rdNid))
 134                 .setPrefix(createPrefix(extractPrefix(destination)))
 135                 .setPathId(PathIdUtil.buildPathId(destination, routePathIdNid()))
 136                 .build();
 137     }
 138
 139     abstract NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode l3vpn);
 140 }