bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractIPRIBSupport.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  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.rib.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableCollection;
  13 import com.google.common.collect.ImmutableSet;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  17 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  20 import org.opendaylight.yangtools.yang.binding.DataObject;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  28 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * Common {@link org.opendaylight.protocol.bgp.rib.spi.RIBSupport} class for IPv4 and IPv6 addresses.
  42  */
  43 abstract class AbstractIPRIBSupport extends AbstractRIBSupport {
  44     private abstract static class ApplyRoute {
  45         abstract void apply(DOMDataWriteTransaction tx, YangInstanceIdentifier base, NodeIdentifierWithPredicates routeKey, DataContainerNode<?> route, final ContainerNode attributes);
  46     }
  47
  48     private static final class DeleteRoute extends ApplyRoute {
  49         @Override
  50         void apply(final DOMDataWriteTransaction tx, final YangInstanceIdentifier base, final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route, final ContainerNode attributes) {
  51             tx.delete(LogicalDatastoreType.OPERATIONAL, base.node(routeKey));
  52         }
  53     }
  54
  55     private final class PutRoute extends ApplyRoute {
  56         @Override
  57         void apply(final DOMDataWriteTransaction tx, final YangInstanceIdentifier base, final NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route, final ContainerNode attributes) {
  58             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b = ImmutableNodes.mapEntryBuilder();
  59             b.withNodeIdentifier(routeKey);
  60             b.withChild(ImmutableNodes.leafNode(routeKeyLeafIdentifier(), routeKey.getKeyValues().get(routeQName())));
  61
  62             // FIXME: All route children, there should be a utility somewhere to do this
  63             for (final DataContainerChild<? extends PathArgument, ?> child : route.getValue()) {
  64                 b.withChild(child);
  65             }
  66
  67             // Add attributes
  68             final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> cb = Builders.containerBuilder(attributes);
  69             cb.withNodeIdentifier(routeAttributesIdentifier());
  70             b.withChild(cb.build());
  71             tx.put(LogicalDatastoreType.OPERATIONAL, base.node(routeKey), b.build());
  72         }
  73     }
  74
  75     private static final Logger LOG = LoggerFactory.getLogger(AbstractIPRIBSupport.class);
  76     private static final NodeIdentifier ROUTES = new NodeIdentifier(Routes.QNAME);
  77     private static final ApplyRoute DELETE_ROUTE = new DeleteRoute();
  78     private final ApplyRoute putRoute = new PutRoute();
  79
  80     protected AbstractIPRIBSupport(final Class<? extends Routes> cazeClass,
  81         final Class<? extends DataObject> containerClass, final Class<? extends Route> listClass) {
  82         super(cazeClass, containerClass, listClass);
  83     }
  84
  85     /**
  86      * Return the NodeIdentifier corresponding to the list containing individual routes.
  87      *
  88      * @return The NodeIdentifier for individual route list.
  89      */
  90     @Nonnull protected abstract NodeIdentifier routeIdentifier();
  91
  92     /**
  93      * Return the NodeIdentifier corresponding to the list containing individual routes.
  94      *
  95      * @return The NodeIdentifier for individual route list.
  96      */
  97     @Nonnull protected abstract NodeIdentifier nlriRoutesListIdentifier();
  98
  99
 100     @Nonnull protected abstract NodeIdentifier routeKeyLeafIdentifier();
 101
 102     @Nonnull protected abstract QName keyLeafQName();
 103
 104     @Nonnull protected abstract QName routeQName();
 105
 106
 107     @Override
 108     public final ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
 109         return ImmutableSet.of();
 110     }
 111
 112     @Override
 113     public final boolean isComplexRoute() {
 114         return false;
 115     }
 116
 117     private void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 118             final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 119         if (destination != null) {
 120             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(nlriRoutesListIdentifier());
 121             if (maybeRoutes.isPresent()) {
 122                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 123                 if (routes instanceof UnkeyedListNode) {
 124                     // Instance identifier to table/(choice routes)/(map of route)
 125                     // FIXME: cache on per-table basis (in TableContext, for example)
 126                     final YangInstanceIdentifier base = tablePath.node(ROUTES).node(routesContainerIdentifier()).node(routeIdentifier());
 127                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode)routes).getValue()) {
 128                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
 129                         function.apply(tx, base, routeKey,  e, attributes);
 130                     }
 131                 } else {
 132                     LOG.warn("Routes {} are not a map", routes);
 133                 }
 134             }
 135         }
 136     }
 137
 138     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode e) {
 139         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeKeyLeaf = e.getChild(routeKeyLeafIdentifier());
 140         Preconditions.checkState(maybeKeyLeaf.isPresent());
 141
 142         // FIXME: a cache here would mean we instantiate the same identifier for each route
 143         //        making comparison quicker.
 144         final Object keyValue = ((LeafNode<?>) maybeKeyLeaf.get()).getValue();
 145         return new NodeIdentifierWithPredicates(routeQName(), keyLeafQName(), keyValue);
 146     }
 147
 148
 149     @Override
 150     protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination, final ContainerNode attributes) {
 151         processDestination(tx, tablePath, destination, attributes, this.putRoute);
 152     }
 153
 154     @Override
 155     protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination) {
 156         processDestination(tx, tablePath, destination, null, DELETE_ROUTE);
 157     }
 158 }