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.controller.md.sal.dom.api.DOMDataWriteTransaction;
  20 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  21 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  22 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  23 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutes;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.McastMplsLabeledVpnSubsequentAddressFamily;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestination;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestinationBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRoute;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  37 import org.opendaylight.yangtools.yang.binding.ChildOf;
  38 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.common.QNameModule;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  46 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  48 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * Abstract L3VPN Multicast RIBSupport.
  57  *
  58  * @author Claudio D. Gasparini
  59  */
  60 abstract class AbstractL3vpnMcastIpRIBSupport<
  61         C extends Routes & DataObject & ChoiceIn<Tables>,
  62         S extends ChildOf<? super C> & L3vpnMcastRoutes>
  63         extends AbstractRIBSupport<C, S, L3vpnMcastRoute, L3vpnMcastRouteKey> {
  64     private static final Logger LOG = LoggerFactory.getLogger(AbstractL3vpnMcastIpRIBSupport.class);
  65     private final NodeIdentifier nlriRoutesList;
  66     private final NodeIdentifier rdNid;
  67     private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
  68
  69     /**
  70      * Default constructor. Requires the QName of the container augmented under the routes choice
  71      * node in instantiations of the rib grouping. It is assumed that this container is defined by
  72      * the same model which populates it with route grouping instantiation, and by extension with
  73      * the route attributes container.
  74      *
  75      * @param mappingService     Serialization service
  76      * @param cazeClass          Binding class of the AFI/SAFI-specific case statement, must not be null
  77      * @param afiClass           address Family Class
  78      * @param destContainerQname destination container Qname
  79      * @param destListQname      destinations list Qname
  80      */
  81     AbstractL3vpnMcastIpRIBSupport(
  82             final BindingNormalizedNodeSerializer mappingService,
  83             final Class<C> cazeClass,
  84             final Class<S> containerClass,
  85             final Class<? extends AddressFamily> afiClass,
  86             final QName destContainerQname,
  87             final QName destListQname) {
  88         super(mappingService, cazeClass, containerClass, L3vpnMcastRoute.class, afiClass,
  89                 McastMplsLabeledVpnSubsequentAddressFamily.class, destContainerQname);
  90         final QNameModule module = BindingReflections.getQNameModule(cazeClass);
  91         this.nlriRoutesList = NodeIdentifier.create(destListQname);
  92         this.rdNid = new NodeIdentifier(QName.create(module, "route-distinguisher"));
  93         this.cacheableNlriObjects = ImmutableSet.of(cazeClass);
  94
  95     }
  96
  97     @Override
  98     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  99         return this.cacheableNlriObjects;
 100     }
 101
 102     protected abstract IpPrefix createPrefix(String prefix);
 103
 104     @Override
 105     public final L3vpnMcastRoute createRoute(final L3vpnMcastRoute route, final L3vpnMcastRouteKey key,
 106             final Attributes attributes) {
 107         final L3vpnMcastRouteBuilder builder;
 108         if (route != null) {
 109             builder = new L3vpnMcastRouteBuilder(route);
 110         } else {
 111             builder = new L3vpnMcastRouteBuilder();
 112         }
 113         return builder.withKey(key).setAttributes(attributes).build();
 114     }
 115
 116     @Override
 117     public final L3vpnMcastRouteKey createRouteListKey(final PathId pathId, final String routeKey) {
 118         return new L3vpnMcastRouteKey(pathId, routeKey);
 119     }
 120
 121     @Override
 122     protected final Collection<NodeIdentifierWithPredicates> processDestination(
 123             final DOMDataWriteTransaction tx,
 124             final YangInstanceIdentifier routesPath,
 125             final ContainerNode destination,
 126             final ContainerNode attributes,
 127             final ApplyRoute function) {
 128         if (destination != null) {
 129             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 130                     .getChild(nlriRoutesList);
 131             if (maybeRoutes.isPresent()) {
 132                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 133                 if (routes instanceof UnkeyedListNode) {
 134                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 135                     final Collection<UnkeyedListEntryNode> routesList = ((UnkeyedListNode) routes).getValue();
 136                     final List<NodeIdentifierWithPredicates> keys = new ArrayList<>(routesList.size());
 137                     for (final UnkeyedListEntryNode l3vpnDest : routesList) {
 138                         final YangInstanceIdentifier.NodeIdentifierWithPredicates routeKey = createRouteKey(l3vpnDest);
 139                         function.apply(tx, base, routeKey, l3vpnDest, attributes);
 140                         keys.add(routeKey);
 141                     }
 142                     return keys;
 143                 } else {
 144                     LOG.warn("Routes {} are not a map", routes);
 145                 }
 146             }
 147         }
 148         return Collections.emptyList();
 149     }
 150
 151
 152     final List<L3vpnMcastDestination> extractRoutes(final Collection<MapEntryNode> routes) {
 153         return routes.stream().map(this::extractDestinations).collect(Collectors.toList());
 154     }
 155
 156     final L3vpnMcastDestination extractDestinations(
 157             final DataContainerNode<? extends PathArgument> destination) {
 158         return new L3vpnMcastDestinationBuilder()
 159                 .setRouteDistinguisher(RouteDistinguisherUtil.extractRouteDistinguisher(destination, rdNid))
 160                 .setPrefix(createPrefix(extractPrefix(destination)))
 161                 .setPathId(PathIdUtil.buildPathId(destination, routePathIdNid()))
 162                 .build();
 163     }
 164
 165
 166     @Override
 167     public final List<L3vpnMcastRoute> routesFromContainer(final S container) {
 168         return container.getL3vpnMcastRoute();
 169     }
 170
 171
 172     @Override
 173     public final PathId extractPathId(final L3vpnMcastRouteKey routeListKey) {
 174         return routeListKey.getPathId();
 175     }
 176
 177     @Override
 178     public String extractRouteKey(final L3vpnMcastRouteKey routeListKey) {
 179         return routeListKey.getRouteKey();
 180     }
 181
 182     abstract NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode l3vpn);
 183 }