bgp/openconfig-rp-statement/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/statement/conditions/MatchRoleSetHandler.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 org.apache.commons.lang3.StringUtils;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  23 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  24 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.RouteEntryBaseAttributes;
  25 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.policy.condition.BgpConditionsAugmentationPolicy;
  26 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryExportParameters;
  27 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  28 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.DefinedSets1;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.BgpDefinedSets;
  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.routing.policy.top.RoutingPolicy;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSets;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.BgpRoleSets;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.MatchRoleSetCondition;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.match.role.set.condition.grouping.MatchRoleSet;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.match.role.set.condition.grouping.match.role.set.FromRole;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.match.role.set.condition.grouping.match.role.set.ToRole;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.role.set.RoleSet;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.role.set.RoleSetKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev180329.routing.policy.defined.sets.bgp.defined.sets.RoleSets;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45
  46 /**
  47  * Match a Peer Role (FROM, TO).
  48  */
  49 public final class MatchRoleSetHandler implements BgpConditionsAugmentationPolicy<MatchRoleSetCondition, Void> {
  50     private static final InstanceIdentifier<RoleSets> ROLE_SET_IID
  51             = InstanceIdentifier.create(RoutingPolicy.class).child(DefinedSets.class)
  52             .augmentation(DefinedSets1.class).child(BgpDefinedSets.class)
  53             .augmentation(BgpRoleSets.class).child(RoleSets.class);
  54     private final DataBroker dataBroker;
  55     private final LoadingCache<String, List<PeerRole>> roleSets = CacheBuilder.newBuilder()
  56             .build(new CacheLoader<String, List<PeerRole>>() {
  57                 @Override
  58                 public List<PeerRole> load(final String key) throws ExecutionException, InterruptedException {
  59                     return loadRoleSets(key);
  60                 }
  61             });
  62
  63     public MatchRoleSetHandler(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 List<PeerRole> loadRoleSets(final String key) throws ExecutionException, InterruptedException {
  70         final ReadTransaction tr = this.dataBroker.newReadOnlyTransaction();
  71         final Optional<RoleSet> result = tr.read(LogicalDatastoreType.CONFIGURATION,
  72                 ROLE_SET_IID.child(RoleSet.class, new RoleSetKey(key))).get();
  73         if (!result.isPresent()) {
  74             return Collections.emptyList();
  75         }
  76         return result.get().getRole();
  77     }
  78
  79     @Override
  80     public boolean matchImportCondition(
  81             final Class<? extends AfiSafiType> afiSafi,
  82             final RouteEntryBaseAttributes routeEntryInfo,
  83             final BGPRouteEntryImportParameters importParameters,
  84             final Void attributes,
  85             final MatchRoleSetCondition conditions) {
  86         return matchNeighborRoleSetCondition(importParameters.getFromPeerRole(), null,
  87                 conditions.getMatchRoleSet());
  88     }
  89
  90     private boolean matchNeighborRoleSetCondition(final PeerRole fromPeerRole, final PeerRole toPeerRole,
  91             final MatchRoleSet matchRoleSet) {
  92
  93         final FromRole from = matchRoleSet.getFromRole();
  94         Boolean match = null;
  95         if (from != null) {
  96             match = checkMatch(from.getRoleSet(), fromPeerRole, from.getMatchSetOptions());
  97         }
  98         if (match != null && !match) {
  99             return false;
 100         }
 101
 102         final ToRole to = matchRoleSet.getToRole();
 103         if (to != null) {
 104             match = checkMatch(to.getRoleSet(), toPeerRole, to.getMatchSetOptions());
 105         }
 106
 107         return match;
 108     }
 109
 110     private boolean checkMatch(final String roleSetName, final PeerRole role,
 111             final MatchSetOptionsRestrictedType matchSetOptions) {
 112         final List<PeerRole> roles = this.roleSets.getUnchecked(StringUtils
 113                 .substringBetween(roleSetName, "=\"", "\""));
 114
 115         final boolean found = roles.contains(role);
 116         if (MatchSetOptionsRestrictedType.ANY.equals(matchSetOptions)) {
 117             return found;
 118         }
 119         //INVERT
 120         return !found;
 121     }
 122
 123     @Override
 124     public boolean matchExportCondition(
 125             final Class<? extends AfiSafiType> afiSafi,
 126             final RouteEntryBaseAttributes routeEntryInfo,
 127             final BGPRouteEntryExportParameters exportParameters,
 128             final Void attributes,
 129             final MatchRoleSetCondition conditions) {
 130         return matchNeighborRoleSetCondition(exportParameters.getFromPeerRole(),
 131                 exportParameters.getToPeerRole(), conditions.getMatchRoleSet());
 132     }
 133
 134     @Override
 135     public Void getConditionParameter(final Attributes attributes) {
 136         return null;
 137     }
 138 }