2 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
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
9 package org.opendaylight.protocol.bgp.l3vpn.mcast;
11 import com.google.common.collect.ImmutableCollection;
12 import com.google.common.collect.ImmutableSet;
13 import java.util.Collection;
14 import java.util.List;
15 import java.util.Optional;
16 import java.util.stream.Collectors;
17 import org.opendaylight.bgp.concepts.RouteDistinguisherUtil;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
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.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutes;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.McastMplsLabeledVpnSubsequentAddressFamily;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestination;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestinationBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRoute;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteKey;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
35 import org.opendaylight.yangtools.yang.binding.ChildOf;
36 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
37 import org.opendaylight.yangtools.yang.binding.DataObject;
38 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.opendaylight.yangtools.yang.common.QNameModule;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
47 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
55 * Abstract L3VPN Multicast RIBSupport.
57 * @author Claudio D. Gasparini
59 abstract class AbstractL3vpnMcastIpRIBSupport<
60 C extends Routes & DataObject & ChoiceIn<Tables>,
61 S extends ChildOf<? super C> & L3vpnMcastRoutes>
62 extends AbstractRIBSupport<C, S, L3vpnMcastRoute, L3vpnMcastRouteKey> {
63 private static final Logger LOG = LoggerFactory.getLogger(AbstractL3vpnMcastIpRIBSupport.class);
64 private final NodeIdentifier nlriRoutesList;
65 private final NodeIdentifier rdNid;
66 private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
69 * Default constructor. Requires the QName of the container augmented under the routes choice
70 * node in instantiations of the rib grouping. It is assumed that this container is defined by
71 * the same model which populates it with route grouping instantiation, and by extension with
72 * the route attributes container.
74 * @param mappingService Serialization service
75 * @param cazeClass Binding class of the AFI/SAFI-specific case statement, must not be null
76 * @param afiClass address Family Class
77 * @param destContainerQname destination container Qname
78 * @param destListQname destinations list Qname
80 AbstractL3vpnMcastIpRIBSupport(
81 final BindingNormalizedNodeSerializer mappingService,
82 final Class<C> cazeClass,
83 final Class<S> containerClass,
84 final Class<? extends AddressFamily> afiClass,
85 final QName destContainerQname,
86 final QName destListQname) {
87 super(mappingService, cazeClass, containerClass, L3vpnMcastRoute.class, afiClass,
88 McastMplsLabeledVpnSubsequentAddressFamily.class, destContainerQname);
89 final QNameModule module = BindingReflections.getQNameModule(cazeClass);
90 this.nlriRoutesList = NodeIdentifier.create(destListQname);
91 this.rdNid = new NodeIdentifier(QName.create(module, "route-distinguisher"));
92 this.cacheableNlriObjects = ImmutableSet.of(cazeClass);
97 public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
98 return this.cacheableNlriObjects;
101 protected abstract IpPrefix createPrefix(String prefix);
104 public final L3vpnMcastRoute createRoute(final L3vpnMcastRoute route, final String routeKey, final long pathId,
105 final Attributes attributes) {
106 final L3vpnMcastRouteBuilder builder;
108 builder = new L3vpnMcastRouteBuilder(route);
110 builder = new L3vpnMcastRouteBuilder();
112 return builder.withKey(createRouteListKey(pathId, routeKey)).setAttributes(attributes).build();
116 public final L3vpnMcastRouteKey createRouteListKey(final long pathId, final String routeKey) {
117 return new L3vpnMcastRouteKey(new PathId(pathId), routeKey);
121 protected final void processDestination(
122 final DOMDataWriteTransaction tx,
123 final YangInstanceIdentifier routesPath,
124 final ContainerNode destination,
125 final ContainerNode attributes,
126 final ApplyRoute function) {
127 if (destination != null) {
128 final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
129 .getChild(nlriRoutesList);
130 if (maybeRoutes.isPresent()) {
131 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
132 if (routes instanceof UnkeyedListNode) {
133 final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
134 for (final UnkeyedListEntryNode l3vpnDest : ((UnkeyedListNode) routes).getValue()) {
135 final YangInstanceIdentifier.NodeIdentifierWithPredicates routeKey = createRouteKey(l3vpnDest);
136 function.apply(tx, base, routeKey, l3vpnDest, attributes);
139 LOG.warn("Routes {} are not a map", routes);
146 final List<L3vpnMcastDestination> extractRoutes(final Collection<MapEntryNode> routes) {
147 return routes.stream().map(this::extractDestinations).collect(Collectors.toList());
150 final L3vpnMcastDestination extractDestinations(
151 final DataContainerNode<? extends PathArgument> destination) {
152 return new L3vpnMcastDestinationBuilder()
153 .setRouteDistinguisher(RouteDistinguisherUtil.extractRouteDistinguisher(destination, rdNid))
154 .setPrefix(createPrefix(extractPrefix(destination)))
155 .setPathId(PathIdUtil.buildPathId(destination, routePathIdNid()))
159 abstract NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode l3vpn);