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 static abstract 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, 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, NodeIdentifierWithPredicates routeKey, final DataContainerNode<?> route, final ContainerNode attributes) {
  58             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b = ImmutableNodes.mapEntryBuilder();
  59             b.withNodeIdentifier(routeKey);
  60
  61             // FIXME: All route children, there should be a utility somewhere to do this
  62             for (final DataContainerChild<? extends PathArgument, ?> child : route.getValue()) {
  63                 b.withChild(child);
  64             }
  65
  66             // Add attributes
  67             final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> cb = Builders.containerBuilder(attributes);
  68             cb.withNodeIdentifier(routeAttributesIdentifier());
  69             b.withChild(cb.build());
  70             tx.put(LogicalDatastoreType.OPERATIONAL, base.node(routeKey), b.build());
  71         }
  72     }
  73
  74     private static final Logger LOG = LoggerFactory.getLogger(AbstractIPRIBSupport.class);
  75     private static final NodeIdentifier ROUTES = new NodeIdentifier(Routes.QNAME);
  76     private static final ApplyRoute DELETE_ROUTE = new DeleteRoute();
  77     private final ApplyRoute putRoute = new PutRoute();
  78
  79     protected AbstractIPRIBSupport(final Class<? extends Routes> cazeClass,
  80         final Class<? extends DataObject> containerClass, final Class<? extends Route> listClass) {
  81         super(cazeClass, containerClass, listClass);
  82     }
  83
  84     /**
  85      * Return the NodeIdentifier corresponding to the list containing individual routes.
  86      *
  87      * @return The NodeIdentifier for individual route list.
  88      */
  89     @Nonnull protected abstract NodeIdentifier routeIdentifier();
  90
  91     /**
  92      * Return the NodeIdentifier corresponding to the list containing individual routes.
  93      *
  94      * @return The NodeIdentifier for individual route list.
  95      */
  96     @Nonnull protected abstract NodeIdentifier nlriRoutesListIdentifier();
  97
  98
  99     @Nonnull protected abstract NodeIdentifier routeKeyLeafIdentifier();
 100
 101     @Nonnull protected abstract QName keyLeafQName();
 102
 103     @Nonnull protected abstract QName routeQName();
 104
 105
 106     @Override
 107     public final ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
 108         return ImmutableSet.of();
 109     }
 110
 111     @Override
 112     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
 113         return ImmutableSet.of();
 114     }
 115
 116     private final void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 117             final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 118         if (destination != null) {
 119             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(nlriRoutesListIdentifier());
 120             if (maybeRoutes.isPresent()) {
 121                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 122                 if (routes instanceof UnkeyedListNode) {
 123                     // Instance identifier to table/(choice routes)/(map of route)
 124                     final YangInstanceIdentifier base = tablePath.node(ROUTES).node(routesContainerIdentifier()).node(routeIdentifier());
 125                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode)routes).getValue()) {
 126                         NodeIdentifierWithPredicates routeKey = createRouteKey(e);
 127                         function.apply(tx, base, routeKey,  e, attributes);
 128                     }
 129                 } else {
 130                     LOG.warn("Routes {} are not a map", routes);
 131                 }
 132             }
 133         }
 134     }
 135
 136     private NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode e) {
 137         Optional<DataContainerChild<? extends PathArgument, ?>> maybeKeyLeaf = e.getChild(routeKeyLeafIdentifier());
 138         Preconditions.checkState(maybeKeyLeaf.isPresent());
 139         Object keyValue = ((LeafNode<?>) maybeKeyLeaf.get()).getValue();
 140         return new NodeIdentifierWithPredicates(routeQName(), keyLeafQName(), keyValue);
 141     }
 142
 143
 144     @Override
 145     protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination, final ContainerNode attributes) {
 146         processDestination(tx, tablePath, destination, attributes, this.putRoute);
 147     }
 148
 149     @Override
 150     protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination) {
 151         processDestination(tx, tablePath, destination, null, DELETE_ROUTE);
 152     }
 153
 154
 155 }