Rib support refactoring II
[bgpcep.git] / bgp / l3vpn / src / main / java / org / opendaylight / protocol / bgp / l3vpn / AbstractVpnRIBSupport.java
index 7b72c90775d1d647c384ab2846ca7a52e294cb9a..f0613238d24486d35bf254fb0fa5e9f60cdaa024 100644 (file)
@@ -12,7 +12,6 @@ import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableSet;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
@@ -23,19 +22,12 @@ import org.opendaylight.protocol.bgp.labeled.unicast.LabeledUnicastRIBSupport;
 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
 import org.opendaylight.protocol.util.ByteArray;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.DestinationType;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.MplsLabeledVpnSubsequentAddressFamily;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.RouteDistinguisher;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.RouteDistinguisherBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev160413.l3vpn.ip.destination.type.VpnDestination;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev160413.l3vpn.ip.destination.type.VpnDestinationBuilder;
 import org.opendaylight.yangtools.yang.binding.DataObject;
@@ -45,15 +37,12 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
-import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -62,18 +51,12 @@ import org.slf4j.LoggerFactory;
  */
 public abstract class AbstractVpnRIBSupport extends AbstractRIBSupport {
     private static final Logger LOG = LoggerFactory.getLogger(AbstractVpnRIBSupport.class);
-    private final NodeIdentifier NLRI_ROUTES_LIST;
-    private final NodeIdentifier PREFIX_TYPE_NID;
-    private final NodeIdentifier LABEL_STACK_NID;
-    private final NodeIdentifier LV_NID;
-    private final NodeIdentifier RD_NID;
-    private final NodeIdentifier DESTINATION;
-    private final QName ROUTE_KEY;
-    private final NodeIdentifier ROUTE;
-    private final Class<? extends AddressFamily> ADDRESS_FAMILY_CLAZZ;
-    private final QName CONTAINER_CLASS_QNAME;
-    private final QName LIST_CLASS_QNAME;
-    private final ChoiceNode EMPTY_ROUTES;
+    private final NodeIdentifier nlriRoutesListNid;
+    private final NodeIdentifier prefixTypeNid;
+    private final NodeIdentifier labelStackNid;
+    private final NodeIdentifier lvNid;
+    private final NodeIdentifier rdNid;
+    private final QName routeKey;
 
     /**
      * Default constructor. Requires the QName of the container augmented under the routes choice
@@ -85,121 +68,53 @@ public abstract class AbstractVpnRIBSupport extends AbstractRIBSupport {
      * @param containerClass Binding class of the container in routes choice, must not be null.
      * @param listClass      Binding class of the route list, nust not be null;
      */
-    protected AbstractVpnRIBSupport(
-        Class<? extends Routes> cazeClass,
-        Class<? extends DataObject> containerClass,
-        Class<? extends Route> listClass,
-        Class<? extends AddressFamily> addressFamilyClass,
-        final QName VPN_DST_CONTAINER_CLASS_QNAME
-    ) {
-        super(cazeClass, containerClass, listClass);
-        CONTAINER_CLASS_QNAME = BindingReflections.findQName(containerClass).intern();
-        LIST_CLASS_QNAME =
-            QName.create(
-                CONTAINER_CLASS_QNAME.getNamespace(), CONTAINER_CLASS_QNAME.getRevision(), BindingReflections.findQName(listClass).intern().getLocalName()
-            );
-        ROUTE = NodeIdentifier.create(LIST_CLASS_QNAME);
-        ROUTE_KEY = QName.create(LIST_CLASS_QNAME, "route-key").intern();
-        EMPTY_ROUTES = Builders.choiceBuilder()
-            .withNodeIdentifier(YangInstanceIdentifier.NodeIdentifier.create(Routes.QNAME))
-            .addChild(
-                Builders.containerBuilder()
-                    .withNodeIdentifier(YangInstanceIdentifier.NodeIdentifier.create(CONTAINER_CLASS_QNAME))
-                    .addChild(
-                        ImmutableNodes.mapNodeBuilder(
-                            LIST_CLASS_QNAME
-                        ).build()
-                    ).build()
-            ).build();
-        final QName VPN_DST_CLASS_QNAME =
-            QName.create(
-                CONTAINER_CLASS_QNAME.getNamespace(), CONTAINER_CLASS_QNAME.getRevision(), VpnDestination.QNAME.getLocalName()
-            );
-        NLRI_ROUTES_LIST = NodeIdentifier.create(VPN_DST_CLASS_QNAME);
-        PREFIX_TYPE_NID = NodeIdentifier.create(QName.create(VPN_DST_CLASS_QNAME, "prefix").intern());
-        LABEL_STACK_NID = NodeIdentifier.create(QName.create(VPN_DST_CLASS_QNAME, "label-stack").intern());
-        LV_NID = NodeIdentifier.create(QName.create(VPN_DST_CLASS_QNAME, "label-value").intern());
-        RD_NID = NodeIdentifier.create(QName.create(VPN_DST_CLASS_QNAME, "route-distinguisher").intern());
-        DESTINATION = NodeIdentifier.create(VPN_DST_CONTAINER_CLASS_QNAME);
-        ADDRESS_FAMILY_CLAZZ = addressFamilyClass;
+    protected AbstractVpnRIBSupport(Class<? extends Routes> cazeClass, Class<? extends DataObject> containerClass, Class<? extends Route> listClass,
+        Class<? extends AddressFamily> afiClass, final QName vpnDstContainerClassQname) {
+        super(cazeClass, containerClass, listClass, afiClass, MplsLabeledVpnSubsequentAddressFamily.class, vpnDstContainerClassQname);
+        final QName classQname = BindingReflections.findQName(containerClass).intern();
+        routeKey = QName.create(routeQName(), "route-key").intern();
+        final QName vpnDstClassQname = QName.create(classQname, VpnDestination.QNAME.getLocalName());
+        nlriRoutesListNid = NodeIdentifier.create(vpnDstClassQname);
+        prefixTypeNid = NodeIdentifier.create(QName.create(vpnDstClassQname, "prefix").intern());
+        labelStackNid = NodeIdentifier.create(QName.create(vpnDstClassQname, "label-stack").intern());
+        lvNid = NodeIdentifier.create(QName.create(vpnDstClassQname, "label-value").intern());
+        rdNid = NodeIdentifier.create(QName.create(vpnDstClassQname, "route-distinguisher").intern());
     }
 
     private VpnDestination extractVpnDestination(DataContainerNode<? extends PathArgument> route) {
         final VpnDestination dst = new VpnDestinationBuilder()
-            .setPrefix(LabeledUnicastRIBSupport.extractPrefix(route, PREFIX_TYPE_NID))
-            .setLabelStack(LabeledUnicastRIBSupport.extractLabel(route, LABEL_STACK_NID, LV_NID))
+            .setPrefix(LabeledUnicastRIBSupport.extractPrefix(route, prefixTypeNid))
+            .setLabelStack(LabeledUnicastRIBSupport.extractLabel(route, labelStackNid, lvNid))
             .setRouteDistinguisher(extractRouteDistinguisher(route))
             .build();
         return dst;
     }
 
     private RouteDistinguisher extractRouteDistinguisher(final DataContainerNode<? extends YangInstanceIdentifier.PathArgument> route) {
-        if (route.getChild(RD_NID).isPresent()) {
-            return RouteDistinguisherBuilder.getDefaultInstance((String) route.getChild(RD_NID).get().getValue());
+        if (route.getChild(rdNid).isPresent()) {
+            return RouteDistinguisherBuilder.getDefaultInstance((String) route.getChild(rdNid).get().getValue());
         }
         return null;
     }
 
-    @Nonnull
-    @Override
-    public ChoiceNode emptyRoutes() {
-        return EMPTY_ROUTES;
-    }
-
-    @Nonnull
-    @Override
-    protected NodeIdentifier destinationContainerIdentifier() {
-        return DESTINATION;
-    }
-
-    @Override
-    protected void deleteDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination, YangInstanceIdentifier.NodeIdentifier routesNodeId) {
-        processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
-    }
-
-    @Override
-    protected void putDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination, ContainerNode attributes, YangInstanceIdentifier.NodeIdentifier routesNodeId) {
-        processDestination(tx, tablePath.node(routesNodeId), destination, attributes, putRoute);
-    }
-
-    protected abstract DestinationType getAdvertizedDestinationType(List<VpnDestination> dests);
+    protected abstract DestinationType getAdvertisedDestinationType(List<VpnDestination> dests);
 
     protected abstract DestinationType getWithdrawnDestinationType(List<VpnDestination> dests);
 
     @Nonnull
     @Override
-    protected MpReachNlri buildReach(Collection<MapEntryNode> routes, CNextHop hop) {
-        final MpReachNlriBuilder mb = new MpReachNlriBuilder()
-            .setAfi(ADDRESS_FAMILY_CLAZZ)
-            .setSafi(MplsLabeledVpnSubsequentAddressFamily.class)
-            .setCNextHop(hop);
-
-        final List<VpnDestination> dests = new ArrayList<>(routes.size());
-        dests.addAll(routes.stream().map(this::extractVpnDestination).collect(Collectors.toList()));
-
-        mb.setAdvertizedRoutes(
-            new AdvertizedRoutesBuilder().setDestinationType(
-                getAdvertizedDestinationType(dests)
-            ).build()
-        ).build();
-        return mb.build();
+    protected DestinationType buildDestination(@Nonnull final Collection<MapEntryNode> routes) {
+        return getAdvertisedDestinationType(extractRoutes(routes));
     }
 
     @Nonnull
     @Override
-    protected MpUnreachNlri buildUnreach(Collection<MapEntryNode> routes) {
-        final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder()
-            .setAfi(ADDRESS_FAMILY_CLAZZ)
-            .setSafi(MplsLabeledVpnSubsequentAddressFamily.class);
-
-        final List<VpnDestination> dests = new ArrayList<>(routes.size());
-        dests.addAll(routes.stream().map(this::extractVpnDestination).collect(Collectors.toList()));
-
-        mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(
-            getWithdrawnDestinationType(dests)
-            ).build()
-        ).build();
-        return mb.build();
+    protected DestinationType buildWithdrawnDestination(@Nonnull final Collection<MapEntryNode> routes) {
+        return getWithdrawnDestinationType(extractRoutes(routes));
+    }
+
+    private List<VpnDestination> extractRoutes(final Collection<MapEntryNode> routes) {
+        return routes.stream().map(this::extractVpnDestination).collect(Collectors.toList());
     }
 
     @Nonnull
@@ -219,16 +134,17 @@ public abstract class AbstractVpnRIBSupport extends AbstractRIBSupport {
         return true;
     }
 
-    private void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
+    @Override
+    protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
                                     final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
         if (destination != null) {
-            final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(NLRI_ROUTES_LIST);
+            final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(this.nlriRoutesListNid);
             if (maybeRoutes.isPresent()) {
                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
                 if (routes instanceof UnkeyedListNode) {
                     UnkeyedListNode routeListNode = (UnkeyedListNode) routes;
                     LOG.debug("{} routes are found", routeListNode.getSize());
-                    final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(ROUTE);
+                    final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(routeNid());
                     for (final UnkeyedListEntryNode e : routeListNode.getValue()) {
                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
                         LOG.debug("Route {} is processed.", routeKey);
@@ -248,6 +164,6 @@ public abstract class AbstractVpnRIBSupport extends AbstractRIBSupport {
 
         final VpnDestination dest = extractVpnDestination(l3vpn);
         AbstractVpnNlriParser.serializeNlri(Collections.singletonList(dest), buffer);
-        return new NodeIdentifierWithPredicates(LIST_CLASS_QNAME, ROUTE_KEY, ByteArray.readAllBytes(buffer));
+        return new NodeIdentifierWithPredicates(routeQName(), this.routeKey, ByteArray.readAllBytes(buffer));
     }
 }