2 * Copyright (c) 2015 Cisco Systems, Inc. and others. 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
8 package org.opendaylight.protocol.bgp.inet;
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.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.parser.spi.PathIdUtil;
17 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
23 import org.opendaylight.yangtools.yang.binding.ChildOf;
24 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
25 import org.opendaylight.yangtools.yang.binding.DataObject;
26 import org.opendaylight.yangtools.yang.binding.Identifiable;
27 import org.opendaylight.yangtools.yang.binding.Identifier;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
33 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
35 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
41 * Common {@link org.opendaylight.protocol.bgp.rib.spi.RIBSupport} class for IPv4 and IPv6 addresses.
43 abstract class AbstractIPRibSupport<
44 C extends Routes & DataObject & ChoiceIn<Tables>,
45 S extends ChildOf<? super C>,
46 R extends Route & ChildOf<S> & Identifiable<N>,
47 N extends Identifier<R>>
48 extends AbstractRIBSupport<C, S, R, N> {
49 private static final Logger LOG = LoggerFactory.getLogger(AbstractIPRibSupport.class);
50 private final NodeIdentifier prefixNid;
51 private final NodeIdentifier nlriRoutesList;
52 private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
55 final BindingNormalizedNodeSerializer mappingService,
56 final Class<? extends DataObject> prefixClass,
57 final Class<? extends AddressFamily> addressFamilyClass,
58 final Class<C> cazeClass,
59 final Class<S> containerClass,
60 final Class<R> listClass,
61 final QName destinationQname, final QName prefixesQname) {
62 super(mappingService, cazeClass, containerClass, listClass, addressFamilyClass,
63 UnicastSubsequentAddressFamily.class, destinationQname);
64 this.nlriRoutesList = new NodeIdentifier(prefixesQname);
65 this.cacheableNlriObjects = ImmutableSet.of(prefixClass);
66 this.prefixNid = new NodeIdentifier(QName.create(routeQName(), "prefix").intern());
69 final NodeIdentifier routePrefixIdentifier() {
70 return this.prefixNid;
74 public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
75 return this.cacheableNlriObjects;
79 protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
80 final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
81 if (destination != null) {
82 final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes =
83 destination.getChild(this.nlriRoutesList);
84 if (maybeRoutes.isPresent()) {
85 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
86 if (routes instanceof UnkeyedListNode) {
87 // Instance identifier to table/(choice routes)/(map of route)
88 final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
89 for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
90 final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
91 function.apply(tx, base, routeKey, e, attributes);
94 LOG.warn("Routes {} are not a map", routes);
101 * Prefix and Path Id are the route key.
103 * @param prefixes UnkeyedListEntryNode containing route
104 * @return Nid with Route Key
106 private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode prefixes) {
107 final Optional<DataContainerChild<? extends PathArgument, ?>> maybePrefixLeaf =
108 prefixes.getChild(routePrefixIdentifier());
109 final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
110 prefixes.getChild(routePathIdNid());
111 Preconditions.checkState(maybePrefixLeaf.isPresent());
112 final Object prefixValue = maybePrefixLeaf.get().getValue();
113 return PathIdUtil.createNidKey(routeQName(), routeKeyQName(), pathIdQName(), prefixValue, maybePathIdLeaf);