bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.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.annotations.VisibleForTesting;
  11 import com.google.common.collect.ImmutableCollection;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.bgp.rib.rib.loc.rib.tables.routes.Ipv4RoutesCase;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  42
  43 /**
  44  * Class supporting IPv4 unicast RIBs.
  45  */
  46 final class IPv4RIBSupport extends AbstractIPRIBSupport {
  47     @VisibleForTesting
  48     static final QName PREFIX_QNAME = QName.cachedReference(QName.create(Ipv4Route.QNAME, "prefix"));
  49     private static final IPv4RIBSupport SINGLETON = new IPv4RIBSupport();
  50     private static final ImmutableCollection<Class<? extends DataObject>> CACHEABLE_NLRI_OBJECTS =
  51             ImmutableSet.<Class<? extends DataObject>>of(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.Ipv4Prefix.class);
  52     private final ChoiceNode emptyRoutes = Builders.choiceBuilder()
  53             .withNodeIdentifier(new NodeIdentifier(Routes.QNAME))
  54             .addChild(Builders.containerBuilder()
  55                 .withNodeIdentifier(new NodeIdentifier(Ipv4Routes.QNAME))
  56                 .withChild(ImmutableNodes.mapNodeBuilder(Ipv4Route.QNAME).build()).build()).build();
  57     private final NodeIdentifier destination = new NodeIdentifier(DestinationIpv4.QNAME);
  58     private final NodeIdentifier route = new NodeIdentifier(Ipv4Route.QNAME);
  59     private final NodeIdentifier nlriRoutesList = new NodeIdentifier(Ipv4Prefixes.QNAME);
  60     private final NodeIdentifier routeKeyLeaf = new NodeIdentifier(PREFIX_QNAME);
  61
  62     private IPv4RIBSupport() {
  63         super(Ipv4RoutesCase.class, Ipv4Routes.class, Ipv4Route.class);
  64     }
  65
  66     static IPv4RIBSupport getInstance() {
  67         return SINGLETON;
  68     }
  69
  70     @Override
  71     public ChoiceNode emptyRoutes() {
  72         return this.emptyRoutes;
  73     }
  74
  75     @Override
  76     protected NodeIdentifier destinationContainerIdentifier() {
  77         return this.destination;
  78     }
  79
  80     @Override
  81     protected NodeIdentifier routeIdentifier() {
  82         return this.route;
  83     }
  84
  85     @Override
  86     protected NodeIdentifier routeKeyLeafIdentifier() {
  87         return this.routeKeyLeaf;
  88     }
  89
  90     @Override
  91     protected NodeIdentifier nlriRoutesListIdentifier() {
  92         return this.nlriRoutesList;
  93     }
  94
  95     @Override
  96     protected QName keyLeafQName() {
  97         return PREFIX_QNAME;
  98     }
  99
 100     @Override
 101     protected QName routeQName() {
 102         return Ipv4Route.QNAME;
 103     }
 104
 105     @Override
 106     public ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
 107         return CACHEABLE_NLRI_OBJECTS;
 108     }
 109
 110     private List<Ipv4Prefixes> extractPrefixes(final Collection<MapEntryNode> routes) {
 111         final List<Ipv4Prefixes> prefs = new ArrayList<>(routes.size());
 112         for (final MapEntryNode ipv4Route : routes) {
 113             final String prefix = (String) ipv4Route.getChild(this.routeKeyLeaf).get().getValue();
 114             prefs.add(new Ipv4PrefixesBuilder().setPrefix(new Ipv4Prefix(prefix)).build());
 115         }
 116         return prefs;
 117     }
 118
 119     @Override
 120     protected MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
 121         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
 122         mb.setAfi(Ipv4AddressFamily.class);
 123         mb.setSafi(UnicastSubsequentAddressFamily.class);
 124         mb.setCNextHop(hop);
 125         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(
 126             new DestinationIpv4CaseBuilder().setDestinationIpv4(
 127                 new DestinationIpv4Builder().setIpv4Prefixes(extractPrefixes(routes)).build()).build()).build());
 128         return mb.build();
 129     }
 130
 131     @Override
 132     protected MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 133         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 134         mb.setAfi(Ipv4AddressFamily.class);
 135         mb.setSafi(UnicastSubsequentAddressFamily.class);
 136         mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(
 137             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 138                 new DestinationIpv4Builder().setIpv4Prefixes(extractPrefixes(routes)).build()).build()).build());
 139         return mb.build();
 140     }
 141 }