Route Constrain policies
[bgpcep.git] / 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
9 package org.opendaylight.protocol.bgp.openconfig.routing.policy.statement.conditions;
10
11 import static java.util.Objects.requireNonNull;
12
13 import com.google.common.base.Optional;
14 import com.google.common.cache.CacheBuilder;
15 import com.google.common.cache.CacheLoader;
16 import com.google.common.cache.LoadingCache;
17 import java.util.Collections;
18 import java.util.List;
19 import java.util.concurrent.ExecutionException;
20 import org.apache.commons.lang3.StringUtils;
21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.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     private List<PeerRole> loadRoleSets(final String key) throws ExecutionException, InterruptedException {
68         final ReadOnlyTransaction tr = this.dataBroker.newReadOnlyTransaction();
69         final Optional<RoleSet> result = tr.read(LogicalDatastoreType.CONFIGURATION,
70                 ROLE_SET_IID.child(RoleSet.class, new RoleSetKey(key))).get();
71         if (!result.isPresent()) {
72             return Collections.emptyList();
73         }
74         return result.get().getRole();
75     }
76
77     @Override
78     public boolean matchImportCondition(
79             final Class<? extends AfiSafiType> afiSafi,
80             final RouteEntryBaseAttributes routeEntryInfo,
81             final BGPRouteEntryImportParameters importParameters,
82             final Void attributes,
83             final MatchRoleSetCondition conditions) {
84         return matchNeighborRoleSetCondition(importParameters.getFromPeerRole(), null,
85                 conditions.getMatchRoleSet());
86     }
87
88     private boolean matchNeighborRoleSetCondition(final PeerRole fromPeerRole, final PeerRole toPeerRole,
89             final MatchRoleSet matchRoleSet) {
90
91         final FromRole from = matchRoleSet.getFromRole();
92         Boolean match = null;
93         if (from != null) {
94             match = checkMatch(from.getRoleSet(), fromPeerRole, from.getMatchSetOptions());
95         }
96         if (match != null && !match) {
97             return false;
98         }
99
100         final ToRole to = matchRoleSet.getToRole();
101         if (to != null) {
102             match = checkMatch(to.getRoleSet(), toPeerRole, to.getMatchSetOptions());
103         }
104
105         return match;
106     }
107
108     private boolean checkMatch(final String roleSetName, final PeerRole role,
109             final MatchSetOptionsRestrictedType matchSetOptions) {
110         final List<PeerRole> roles = this.roleSets.getUnchecked(StringUtils
111                 .substringBetween(roleSetName, "=\"", "\""));
112
113         final boolean found = roles.contains(role);
114         if (MatchSetOptionsRestrictedType.ANY.equals(matchSetOptions)) {
115             return found;
116         }
117         //INVERT
118         return !found;
119     }
120
121     @Override
122     public boolean matchExportCondition(
123             final Class<? extends AfiSafiType> afiSafi,
124             final RouteEntryBaseAttributes routeEntryInfo,
125             final BGPRouteEntryExportParameters exportParameters,
126             final Void attributes,
127             final MatchRoleSetCondition conditions) {
128         return matchNeighborRoleSetCondition(exportParameters.getFromPeerRole(),
129                 exportParameters.getToPeerRole(), conditions.getMatchRoleSet());
130     }
131
132     @Override
133     public Void getConditionParameter(final Attributes attributes) {
134         return null;
135     }
136 }