bgp/openconfig-rp-statement/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/statement/conditions/MatchClusterIdSetHandler.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.ArrayList;
  17 import java.util.Collections;
  18 import java.util.List;
  19 import java.util.Optional;
  20 import java.util.concurrent.ExecutionException;
  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.policy.BGPRouteEntryExportParameters;
  28 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.DefinedSets1;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.BgpDefinedSets;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.MatchSetOptionsType;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicy;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSets;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.ClusterId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.BgpClusterIdSets;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.MatchClusterIdSetCondition;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.cluster.id.set.ClusterIdSet;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.cluster.id.set.ClusterIdSetKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.routing.policy.defined.sets.bgp.defined.sets.ClusterIdSets;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44
  45 /**
  46  * Match a set of Cluster Id(ALL, NAY, INVERT).
  47  */
  48 public final class MatchClusterIdSetHandler
  49         implements BgpConditionsAugmentationPolicy<MatchClusterIdSetCondition, ClusterId> {
  50     private static final InstanceIdentifier<ClusterIdSets> CLUSTERS_ID_SETS_IID
  51             = InstanceIdentifier.create(RoutingPolicy.class).child(DefinedSets.class)
  52             .augmentation(DefinedSets1.class).child(BgpDefinedSets.class)
  53             .augmentation(BgpClusterIdSets.class).child(ClusterIdSets.class);
  54     private final DataBroker dataBroker;
  55     private final LoadingCache<String, ClusterIdSet> sets = CacheBuilder.newBuilder()
  56             .build(new CacheLoader<String, ClusterIdSet>() {
  57                 @Override
  58                 public ClusterIdSet load(final String key) throws ExecutionException, InterruptedException {
  59                     return loadSets(key);
  60                 }
  61             });
  62
  63     public MatchClusterIdSetHandler(final DataBroker dataBroker) {
  64         this.dataBroker = requireNonNull(dataBroker);
  65     }
  66
  67     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  68             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  69     private ClusterIdSet loadSets(final String key) throws ExecutionException, InterruptedException {
  70         final ReadTransaction tr = this.dataBroker.newReadOnlyTransaction();
  71         final Optional<ClusterIdSet> result = tr.read(LogicalDatastoreType.CONFIGURATION,
  72                 CLUSTERS_ID_SETS_IID.child(ClusterIdSet.class, new ClusterIdSetKey(key))).get();
  73         return result.orElse(null);
  74     }
  75
  76     @Override
  77     public boolean matchImportCondition(
  78             final Class<? extends AfiSafiType> afiSafi,
  79             final RouteEntryBaseAttributes routeEntryInfo,
  80             final BGPRouteEntryImportParameters importParameters,
  81             final ClusterId clusterIdAtt,
  82             final MatchClusterIdSetCondition conditions) {
  83         final ClusterIdentifier clusterIdLocal = importParameters.getFromClusterId() == null
  84                 ? routeEntryInfo.getClusterId() : importParameters.getFromClusterId();
  85         return matchClusterIdCondition(clusterIdLocal, clusterIdAtt,
  86                 conditions.getMatchClusterIdSetCondition());
  87     }
  88
  89     @Override
  90     public boolean matchExportCondition(
  91             final Class<? extends AfiSafiType> afiSafi,
  92             final RouteEntryBaseAttributes routeEntryInfo,
  93             final BGPRouteEntryExportParameters exportParameters,
  94             final ClusterId clusterIdAtt,
  95             final MatchClusterIdSetCondition conditions) {
  96         final ClusterIdentifier clusterIdLocal = exportParameters.getFromClusterId() == null
  97                 ? routeEntryInfo.getClusterId() : exportParameters.getFromClusterId();
  98         return matchClusterIdCondition(clusterIdLocal, clusterIdAtt,
  99                 conditions.getMatchClusterIdSetCondition());
 100     }
 101
 102     @Override
 103     public ClusterId getConditionParameter(final Attributes attributes) {
 104         return attributes.getClusterId();
 105     }
 106
 107     private boolean matchClusterIdCondition(
 108             final ClusterIdentifier localClusterId,
 109             final ClusterId clusterId, final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl
 110             .bgp._default.policy.rev180329.match.cluster.id.set.condition.grouping
 111             .MatchClusterIdSetCondition matchClusterIdSetCondition) {
 112         final ClusterIdSet clusterIdSet = this.sets.getUnchecked(StringUtils
 113                 .substringBetween(matchClusterIdSetCondition.getClusterIdSet(), "=\"", "\""));
 114
 115         if (clusterIdSet == null) {
 116             return false;
 117         }
 118         final MatchSetOptionsType matchOption = matchClusterIdSetCondition.getMatchSetOptions();
 119
 120         if (clusterId != null) {
 121             List<ClusterIdentifier> newList = new ArrayList<>();
 122             if (clusterIdSet.getClusterId() != null) {
 123                 newList.addAll(clusterIdSet.getClusterId());
 124             }
 125             if (clusterIdSet.getLocal() != null) {
 126                 newList.add(localClusterId);
 127             }
 128
 129             final List<ClusterIdentifier> matchClusterList = clusterId.getCluster();
 130             if (matchOption.equals(MatchSetOptionsType.ALL)) {
 131                 return matchClusterList.containsAll(newList) && newList.containsAll(matchClusterList);
 132             }
 133             final boolean noneInCommon = Collections.disjoint(matchClusterList, newList);
 134             if (matchOption.equals(MatchSetOptionsType.ANY)) {
 135                 return !noneInCommon;
 136             } else if (matchOption.equals(MatchSetOptionsType.INVERT)) {
 137                 return noneInCommon;
 138             }
 139         } else if (matchOption.equals(MatchSetOptionsType.INVERT)) {
 140             return true;
 141         }
 142         return false;
 143     }
 144 }