bgp/flowspec/src/main/java/org/opendaylight/protocol/bgp/flowspec/AbstractFlowspecRIBSupport.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.flowspec;
   9
  10 import com.google.common.collect.ImmutableCollection;
  11 import com.google.common.collect.ImmutableSet;
  12 import com.google.common.collect.Iterables;
  13 import java.util.Collection;
  14 import javax.annotation.Nullable;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  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.flowspec.rev150807.FlowspecSubsequentAddressFamily;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev150807.flowspec.ipv6.routes.flowspec.ipv6.routes.FlowspecRoute;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.PathId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40
  41 public abstract class AbstractFlowspecRIBSupport extends AbstractRIBSupport {
  42     private static final QName PATHID_QNAME = QName.create(FlowspecRoute.QNAME, "path-id").intern();
  43     private static final NodeIdentifier PATH_ID_NII = new NodeIdentifier(PATHID_QNAME);
  44
  45     private static final QName ROUTE_KEY = QName.create(FlowspecRoute.QNAME, "route-key").intern();
  46
  47     protected AbstractFlowspecRIBSupport(final Class<? extends Routes> cazeClass, final Class<? extends DataObject> containerClass,
  48         final Class<? extends Route> listClass) {
  49         super(cazeClass, containerClass, listClass);
  50     }
  51
  52     protected abstract NodeIdentifier routeIdentifier();
  53
  54     protected abstract AbstractFlowspecNlriParser getParser();
  55
  56     protected abstract Class<? extends AddressFamily> getAfiClass();
  57
  58     @Override
  59     public final ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  60         return ImmutableSet.of();
  61     }
  62
  63     @Override
  64     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  65         return ImmutableSet.of();
  66     }
  67
  68     @Override
  69     public final boolean isComplexRoute() {
  70         return true;
  71     }
  72
  73     @Override
  74     protected final void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
  75         final ContainerNode destination, final ContainerNode attributes, final NodeIdentifier routesNodeId) {
  76         processDestination(tx, tablePath.node(routesNodeId), destination, attributes, this.putRoute);
  77     }
  78
  79     @Override
  80     protected final void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
  81         final ContainerNode destination, final NodeIdentifier routesNodeId) {
  82         processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
  83     }
  84
  85     private void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
  86         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
  87         if (destination != null) {
  88             final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(routeIdentifier());
  89             final NodeIdentifierWithPredicates routeKey = new NodeIdentifierWithPredicates(FlowspecRoute.QNAME, ROUTE_KEY, getParser().stringNlri(destination));
  90             function.apply(tx, base, routeKey,  destination, attributes);
  91         }
  92     }
  93
  94     @Override
  95     protected final MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
  96         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
  97         mb.setAfi(getAfiClass());
  98         mb.setSafi(FlowspecSubsequentAddressFamily.class);
  99         mb.setCNextHop(hop);
 100
 101         final MapEntryNode routesCont = Iterables.getOnlyElement(routes);
 102         final PathId pathId = PathIdUtil.buildPathId(routesCont, PATH_ID_NII);
 103
 104         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(getParser().createAdvertizedRoutesDestinationType(
 105             getParser().extractFlowspec(routesCont), pathId)).build());
 106         return mb.build();
 107     }
 108
 109     @Override
 110     protected final MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 111         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 112         mb.setAfi(getAfiClass());
 113         mb.setSafi(FlowspecSubsequentAddressFamily.class);
 114
 115         final MapEntryNode routesCont = Iterables.getOnlyElement(routes);
 116         final PathId pathId = PathIdUtil.buildPathId(routesCont, PATH_ID_NII);
 117
 118         mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(getParser().createWithdrawnDestinationType(
 119             getParser().extractFlowspec(Iterables.getOnlyElement(routes)), pathId)).build());
 120         return mb.build();
 121     }
 122
 123     @Nullable
 124     @Override
 125     public PathArgument getRouteIdAddPath(final long pathId, final PathArgument routeId) {
 126         return PathIdUtil.createNiiKey(pathId, routeId, FlowspecRoute.QNAME, PATHID_QNAME, ROUTE_KEY);
 127     }
 128
 129     @Override
 130     public Long extractPathId(final NormalizedNode<?, ?> data) {
 131         return PathIdUtil.extractPathId(data, PATH_ID_NII);
 132     }
 133 }