bgp/openconfig-rp-statement/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/statement/conditions/MatchBgpNeighborSetHandler.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.openconfig.routing.policy.statement.conditions;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.cache.CacheBuilder;
  13 import com.google.common.cache.CacheLoader;
  14 import com.google.common.cache.LoadingCache;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Optional;
  19 import java.util.concurrent.ExecutionException;
  20 import java.util.stream.Collectors;
  21 import org.apache.commons.lang3.StringUtils;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.RouteEntryBaseAttributes;
  26 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.policy.condition.BgpConditionsAugmentationPolicy;
  27 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
  28 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryExportParameters;
  29 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.MatchSetOptionsRestrictedType;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.generic.defined.sets.NeighborSets;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSet;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSetKey;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicy;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSets;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.BgpNeighbor;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.MatchBgpNeighborCondition;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.bgp.neighbor.grouping.MatchBgpNeighborSet;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43
  44 /**
  45  * Match a set of Neighbors(ip address) (ANY, INVERT).
  46  */
  47 public final class MatchBgpNeighborSetHandler
  48         implements BgpConditionsAugmentationPolicy<MatchBgpNeighborCondition, Void> {
  49     private static final InstanceIdentifier<NeighborSets> NEIGHBOR_SET_IID
  50             = InstanceIdentifier.create(RoutingPolicy.class)
  51             .child(DefinedSets.class)
  52             .child(NeighborSets.class);
  53     private final DataBroker dataBroker;
  54     private final LoadingCache<String, List<PeerId>> peerSets = CacheBuilder.newBuilder()
  55             .build(new CacheLoader<String, List<PeerId>>() {
  56                 @Override
  57                 public List<PeerId> load(final String key) throws ExecutionException, InterruptedException {
  58                     return loadRoleSets(key);
  59                 }
  60             });
  61
  62     public MatchBgpNeighborSetHandler(final DataBroker dataBroker) {
  63         this.dataBroker = requireNonNull(dataBroker);
  64     }
  65
  66     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  67             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  68     private List<PeerId> loadRoleSets(final String key) throws ExecutionException, InterruptedException {
  69         final ReadTransaction tr = this.dataBroker.newReadOnlyTransaction();
  70         final Optional<NeighborSet> result = tr.read(LogicalDatastoreType.CONFIGURATION,
  71                 NEIGHBOR_SET_IID.child(NeighborSet.class, new NeighborSetKey(key))).get();
  72         if (!result.isPresent()) {
  73             return Collections.emptyList();
  74         }
  75         return result.get().getNeighbor().stream()
  76                 .map(nei -> RouterIds.createPeerId(nei.getAddress()))
  77                 .collect(Collectors.toList());
  78     }
  79
  80     @Override
  81     public boolean matchImportCondition(
  82             final Class<? extends AfiSafiType> afiSafi,
  83             final RouteEntryBaseAttributes routeEntryInfo,
  84             final BGPRouteEntryImportParameters importParameters,
  85             final Void nonAttributres,
  86             final MatchBgpNeighborCondition conditions) {
  87         return matchBgpNeighborSetCondition(importParameters.getFromPeerId(), null,
  88                 conditions.getMatchBgpNeighborSet());
  89     }
  90
  91     @Override
  92     public boolean matchExportCondition(
  93             final Class<? extends AfiSafiType> afiSafi,
  94             final RouteEntryBaseAttributes routeEntryInfo,
  95             final BGPRouteEntryExportParameters exportParameters,
  96             final Void nonAttributres,
  97             final MatchBgpNeighborCondition conditions) {
  98         return matchBgpNeighborSetCondition(exportParameters.getFromPeerId(), exportParameters.getToPeerId(),
  99                 conditions.getMatchBgpNeighborSet());
 100     }
 101
 102     private boolean matchBgpNeighborSetCondition(
 103             final PeerId fromPeerId,
 104             final PeerId toPeerId,
 105             final MatchBgpNeighborSet matchBgpNeighborSet) {
 106
 107         final BgpNeighbor from = matchBgpNeighborSet.getFromNeighbor();
 108         Boolean match = null;
 109         if (from != null) {
 110             match = checkMatch(from.getNeighborSet(), fromPeerId, from.getMatchSetOptions());
 111         }
 112
 113         if (match != null && !match) {
 114             return false;
 115         }
 116
 117         final BgpNeighbor to = matchBgpNeighborSet.getToNeighbor();
 118         if (to != null) {
 119             match = checkMatch(to.getNeighborSet(), toPeerId, to.getMatchSetOptions());
 120         }
 121
 122         return match;
 123     }
 124
 125     private boolean checkMatch(
 126             final String neighborSetName,
 127             final PeerId peerId,
 128             final MatchSetOptionsRestrictedType matchSetOptions) {
 129         final List<PeerId> roles = this.peerSets.getUnchecked(StringUtils
 130                 .substringBetween(neighborSetName, "=\"", "\""));
 131
 132         final boolean found = roles.contains(peerId);
 133         if (MatchSetOptionsRestrictedType.ANY.equals(matchSetOptions)) {
 134             return found;
 135         }
 136         //INVERT
 137         return !found;
 138     }
 139
 140     @Override
 141     public Void getConditionParameter(final Attributes attributes) {
 142         return null;
 143     }
 144 }