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.mvpn.impl;
11 import com.google.common.collect.ImmutableCollection;
12 import com.google.common.collect.ImmutableSet;
13 import java.util.Optional;
14 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
15 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
16 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.McastVpnSubsequentAddressFamily;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.MvpnRoutes;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.mvpn.MvpnChoice;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.mvpn.routes.MvpnRoute;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.mvpn.routes.MvpnRouteBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev180417.mvpn.routes.MvpnRouteKey;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
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.common.QName;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Abstract Mvpn RIBSupport.
47 * @author Claudio D. Gasparini
49 abstract class AbstractMvpnRIBSupport<C extends Routes & DataObject & ChoiceIn<Tables>,
50 S extends ChildOf<? super C> & MvpnRoutes> extends AbstractRIBSupport<C, S, MvpnRoute, MvpnRouteKey> {
51 private static final Logger LOG = LoggerFactory.getLogger(AbstractMvpnRIBSupport.class);
52 private final NodeIdentifier nlriRoutesList;
53 private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
56 * Default constructor. Requires the QName of the container augmented under the routes choice
57 * node in instantiations of the rib grouping. It is assumed that this container is defined by
58 * the same model which populates it with route grouping instantiation, and by extension with
59 * the route attributes container.
61 * @param mappingService Serialization service
62 * @param cazeClass Binding class of the AFI/SAFI-specific case statement, must not be null
63 * @param afiClass address Family Class
64 * @param destContainerQname destination container Qname
65 * @param destListQname destinations list Qname
67 AbstractMvpnRIBSupport(
68 final BindingNormalizedNodeSerializer mappingService,
69 final Class<C> cazeClass,
70 final Class<S> containerClass,
71 final Class<? extends AddressFamily> afiClass,
72 final QName destContainerQname,
73 final QName destListQname) {
74 super(mappingService, cazeClass, containerClass, MvpnRoute.class, afiClass,
75 McastVpnSubsequentAddressFamily.class, destContainerQname);
76 this.nlriRoutesList = NodeIdentifier.create(destListQname);
77 this.cacheableNlriObjects = ImmutableSet.of(cazeClass);
82 public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
83 return this.cacheableNlriObjects;
87 public final MvpnRoute createRoute(final MvpnRoute route, final String routeKey, final long pathId,
88 final Attributes attributes) {
89 final MvpnRouteBuilder builder;
91 builder = new MvpnRouteBuilder(route);
93 builder = new MvpnRouteBuilder();
95 return builder.withKey(createRouteListKey(pathId, routeKey)).setAttributes(attributes).build();
99 public final MvpnRouteKey createRouteListKey(final long pathId, final String routeKey) {
100 return new MvpnRouteKey(new PathId(pathId), routeKey);
103 final MvpnChoice extractMvpnChoice(final DataContainerNode<? extends PathArgument> route) {
104 final DataObject nn = this.mappingService.fromNormalizedNode(this.routeDefaultYii, route).getValue();
105 return ((MvpnRoute) nn).getMvpnChoice();
109 protected final void processDestination(
110 final DOMDataWriteTransaction tx,
111 final YangInstanceIdentifier routesPath,
112 final ContainerNode destination,
113 final ContainerNode attributes,
114 final ApplyRoute function) {
115 if (destination != null) {
116 final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
117 .getChild(this.nlriRoutesList);
118 if (maybeRoutes.isPresent()) {
119 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
120 if (routes instanceof UnkeyedListNode) {
121 final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
122 for (final UnkeyedListEntryNode mvpnDest : ((UnkeyedListNode) routes).getValue()) {
123 final NodeIdentifierWithPredicates routeKey = createRouteKey(mvpnDest);
124 function.apply(tx, base, routeKey, mvpnDest, attributes);
127 LOG.warn("Routes {} are not a map", routes);
133 abstract NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode mvpn);