bgp/openconfig-rp-statement/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/statement/conditions/MatchOriginatorIdSetHandler.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.Optional;
  17 import java.util.concurrent.ExecutionException;
  18 import org.apache.commons.lang3.StringUtils;
  19 import org.opendaylight.mdsal.binding.api.DataBroker;
  20 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  22 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.RouteEntryBaseAttributes;
  23 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.policy.condition.BgpConditionsAugmentationPolicy;
  24 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryExportParameters;
  25 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  26 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.DefinedSets1;
  27 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.BgpDefinedSets;
  28 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.MatchSetOptionsRestrictedType;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicy;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSets;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.OriginatorId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.BgpOriginatorIdSets;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.MatchOriginatorIdSetCondition;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.originator.id.set.OriginatorIdSet;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.originator.id.set.OriginatorIdSetKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.routing.policy.defined.sets.bgp.defined.sets.OriginatorIdSets;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41
  42 /**
  43  * Match an Originator Id(ANY, INVERT).
  44  */
  45 public final class MatchOriginatorIdSetHandler
  46         implements BgpConditionsAugmentationPolicy<MatchOriginatorIdSetCondition, OriginatorId> {
  47     private static final InstanceIdentifier<OriginatorIdSets> ORIGINATOR_ID_SETS_IID
  48             = InstanceIdentifier.create(RoutingPolicy.class).child(DefinedSets.class)
  49             .augmentation(DefinedSets1.class).child(BgpDefinedSets.class)
  50             .augmentation(BgpOriginatorIdSets.class).child(OriginatorIdSets.class);
  51     private final DataBroker dataBroker;
  52     private final LoadingCache<String, OriginatorIdSet> sets = CacheBuilder.newBuilder()
  53             .build(new CacheLoader<String, OriginatorIdSet>() {
  54                 @Override
  55                 public OriginatorIdSet load(final String key) throws ExecutionException, InterruptedException {
  56                     return loadSets(key);
  57                 }
  58             });
  59
  60     public MatchOriginatorIdSetHandler(final DataBroker dataBroker) {
  61         this.dataBroker = requireNonNull(dataBroker);
  62     }
  63
  64     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  65             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  66     private OriginatorIdSet loadSets(final String key) throws ExecutionException, InterruptedException {
  67         final ReadTransaction tr = this.dataBroker.newReadOnlyTransaction();
  68         final Optional<OriginatorIdSet> result = tr.read(LogicalDatastoreType.CONFIGURATION,
  69                 ORIGINATOR_ID_SETS_IID.child(OriginatorIdSet.class, new OriginatorIdSetKey(key))).get();
  70         return result.orElse(null);
  71     }
  72
  73     @Override
  74     public boolean matchImportCondition(
  75             final Class<? extends AfiSafiType> afiSafi,
  76             final RouteEntryBaseAttributes routeEntryInfo,
  77             final BGPRouteEntryImportParameters routeEntryImportParameters,
  78             final OriginatorId originatorId,
  79             final MatchOriginatorIdSetCondition conditions) {
  80
  81         return matchOriginatorCondition(routeEntryInfo.getOriginatorId(), originatorId,
  82                 conditions.getMatchOriginatorIdSetCondition());
  83     }
  84
  85     @Override
  86     public boolean matchExportCondition(
  87             final Class<? extends AfiSafiType> afiSafi,
  88             final RouteEntryBaseAttributes routeEntryInfo,
  89             final BGPRouteEntryExportParameters routeEntryExportParameters,
  90             final OriginatorId originatorId,
  91             final MatchOriginatorIdSetCondition conditions) {
  92         return matchOriginatorCondition(routeEntryInfo.getOriginatorId(), originatorId,
  93                 conditions.getMatchOriginatorIdSetCondition());
  94     }
  95
  96     @Override
  97     public OriginatorId getConditionParameter(final Attributes attributes) {
  98         return attributes.getOriginatorId();
  99     }
 100
 101     private boolean matchOriginatorCondition(
 102             final Ipv4Address localOriginatorId,
 103             final OriginatorId originatorId, final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl
 104             .bgp._default.policy.rev180329.match.originator.id.set.condition.grouping
 105             .MatchOriginatorIdSetCondition condition) {
 106
 107         final OriginatorIdSet originatorIdSet = this.sets.getUnchecked(StringUtils
 108                 .substringBetween(condition.getOriginatorIdSet(), "=\"", "\""));
 109
 110         if (originatorIdSet == null) {
 111             return false;
 112         }
 113         boolean found = false;
 114         if (originatorId != null) {
 115             final Ipv4Address remOrigin = originatorId.getOriginator();
 116
 117             if (originatorIdSet.getLocal() != null && localOriginatorId.equals(remOrigin)) {
 118                 found = true;
 119             }
 120             if (!found && originatorIdSet.getOriginatorId() != null) {
 121                 found = originatorIdSet.getOriginatorId().contains(remOrigin);
 122             }
 123         }
 124         final MatchSetOptionsRestrictedType matchOption = condition.getMatchSetOptions();
 125         return matchOption.equals(MatchSetOptionsRestrictedType.ANY) && found
 126                 || matchOption.equals(MatchSetOptionsRestrictedType.INVERT) && !found;
 127     }
 128 }