2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.listen;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.AsyncFunction;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.Collections;
19 import java.util.List;
20 import javax.annotation.Nonnull;
21 import org.apache.commons.lang3.tuple.Pair;
22 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
23 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
24 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
26 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.DSAsyncDao;
27 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.EPTemplateListener;
28 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.ReadableAsyncByKey;
29 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.SimpleCachedDao;
30 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.SxpMapperReactor;
31 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.EPTemplateUtil;
32 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.L3EPServiceUtil;
33 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.SxpListenerUtil;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointForwardingTemplateBySubnet;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointPolicyTemplateBySgt;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.Sgt;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.master.database.fields.MasterDatabaseBinding;
39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
41 import org.opendaylight.yangtools.yang.common.RpcError;
42 import org.opendaylight.yangtools.yang.common.RpcResult;
43 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 * Purpose: listens to EP policy template and propagates change events for further processing
50 public class EPPolicyTemplateListenerImpl implements EPTemplateListener<EndpointPolicyTemplateBySgt> {
52 private static final Logger LOG = LoggerFactory.getLogger(EPPolicyTemplateListenerImpl.class);
54 private static final FutureCallback<List<RpcResult<Void>>> RPC_RESULT_FUTURE_CALLBACK =
55 L3EPServiceUtil.createFailureLoggingCallback("failed to apply epPolicyTemplate");
57 private final ListenerRegistration<? extends EPTemplateListener> listenerRegistration;
58 private final InstanceIdentifier<EndpointPolicyTemplateBySgt> templatePath;
59 private final SxpMapperReactor sxpMapperReactor;
60 private final SimpleCachedDao<Sgt, EndpointPolicyTemplateBySgt> templateCachedDao;
61 private final ReadableAsyncByKey<Sgt, MasterDatabaseBinding> masterDBBindingDao;
62 private final DSAsyncDao<IpPrefix, EndpointForwardingTemplateBySubnet> epForwardingTemplateDao;
64 public EPPolicyTemplateListenerImpl(final DataBroker dataBroker,
65 final SxpMapperReactor sxpMapperReactor,
66 final SimpleCachedDao<Sgt, EndpointPolicyTemplateBySgt> templateCachedDao,
67 final ReadableAsyncByKey<Sgt, MasterDatabaseBinding> masterDBBindingDao,
68 final DSAsyncDao<IpPrefix, EndpointForwardingTemplateBySubnet> epForwardingTemplateDao) {
69 this.sxpMapperReactor = Preconditions.checkNotNull(sxpMapperReactor);
70 this.templateCachedDao = Preconditions.checkNotNull(templateCachedDao);
71 this.masterDBBindingDao = Preconditions.checkNotNull(masterDBBindingDao);
72 this.epForwardingTemplateDao = Preconditions.checkNotNull(epForwardingTemplateDao);
73 templatePath = EPTemplateListener.SXP_MAPPER_TEMPLATE_PARENT_PATH.child(EndpointPolicyTemplateBySgt.class);
75 final DataTreeIdentifier<EndpointPolicyTemplateBySgt> dataTreeIdentifier = new DataTreeIdentifier<>(
76 LogicalDatastoreType.CONFIGURATION, templatePath);
77 listenerRegistration = dataBroker.registerDataTreeChangeListener(dataTreeIdentifier, this);
78 LOG.debug("started listening to {}", templatePath);
82 public void onDataTreeChanged(@Nonnull final Collection<DataTreeModification<EndpointPolicyTemplateBySgt>> collection) {
83 for (DataTreeModification<EndpointPolicyTemplateBySgt> change : collection) {
84 LOG.trace("received modification: {} -> {}", change.getRootPath(), change.getRootNode().getModificationType());
87 final InstanceIdentifier<EndpointPolicyTemplateBySgt> changePath = change.getRootPath().getRootIdentifier();
88 final Sgt changeKey = changePath.firstKeyOf(EndpointPolicyTemplateBySgt.class).getSgt();
89 SxpListenerUtil.updateCachedDao(templateCachedDao, changeKey, change);
91 final EndpointPolicyTemplateBySgt epPolicyTemplate = change.getRootNode().getDataAfter();
92 processWithEPTemplates(epPolicyTemplate);
96 private void processWithEPTemplates(final EndpointPolicyTemplateBySgt epPolicyTemplate) {
97 final ListenableFuture<Collection<MasterDatabaseBinding>> sxpMasterDbItemsRead =
98 masterDBBindingDao.readBy(epPolicyTemplate.getSgt());
100 // find all available epForwardingTemplates and pair those to sxpMasterDBBinding
101 final ListenableFuture<List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>> epForwardingTemplatesRead =
102 Futures.transform(sxpMasterDbItemsRead, createReadAndPairTemplateToBindingFunction(epPolicyTemplate));
104 // invoke sxpMapperReactor.process for every valid combination of sxpMasterDBBinding, epPolicyTemplate, epForwardingTemplate
105 final ListenableFuture<List<RpcResult<Void>>> rpcResult =
106 Futures.transform(epForwardingTemplatesRead, createProcessAllFunction(epPolicyTemplate));
108 Futures.addCallback(rpcResult, RPC_RESULT_FUTURE_CALLBACK);
111 private AsyncFunction<List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>, List<RpcResult<Void>>>
112 createProcessAllFunction(final EndpointPolicyTemplateBySgt epPolicyTemplate) {
113 return new AsyncFunction<List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>, List<RpcResult<Void>>>() {
115 public ListenableFuture<List<RpcResult<Void>>>
116 apply(final List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>> input) throws Exception {
117 final ListenableFuture<List<RpcResult<Void>>> result;
118 if (input == null || input.isEmpty()) {
119 LOG.debug("no epForwardingTemplate available for sgt: {}", epPolicyTemplate.getSgt());
120 result = Futures.immediateFuture(Collections.singletonList(
121 RpcResultBuilder.<Void>failed()
122 .withError(RpcError.ErrorType.APPLICATION,
123 "no epForwardingTemplate available for sgt " + epPolicyTemplate.getSgt())
126 LOG.trace("processing epPolicyTemplate event for sgt: {}", epPolicyTemplate.getSgt());
127 List<ListenableFuture<RpcResult<Void>>> allResults = new ArrayList<>(input.size());
128 for (Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet> pair : input) {
129 final MasterDatabaseBinding sxpMasterDBBinding = pair.getLeft();
130 final EndpointForwardingTemplateBySubnet epForwardingTemplate = pair.getRight();
131 if (epForwardingTemplate != null) {
132 LOG.trace("processing epPolicyTemplate event with resolved sxpMasterDb entry and " +
133 "epForwardingTemplate for sgt/ip-prefix: {}/{}",
134 sxpMasterDBBinding.getSecurityGroupTag(), sxpMasterDBBinding.getImplementedInterface());
135 allResults.add(sxpMapperReactor.processTemplatesAndSxpMasterDB(
136 epPolicyTemplate, epForwardingTemplate, sxpMasterDBBinding));
139 result = Futures.successfulAsList(allResults);
147 private AsyncFunction<Collection<MasterDatabaseBinding>, List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>>
148 createReadAndPairTemplateToBindingFunction(final EndpointPolicyTemplateBySgt epPolicyTemplate) {
149 return new AsyncFunction<Collection<MasterDatabaseBinding>, List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>>() {
151 public ListenableFuture<List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>>
152 apply(final Collection<MasterDatabaseBinding> input) throws Exception {
153 final ListenableFuture<List<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>> result;
154 if (input == null || input.isEmpty()) {
155 LOG.debug("no sxpMasterDB entry available for sgt: {}", epPolicyTemplate.getSgt());
156 result = Futures.immediateFuture(Collections.emptyList());
158 LOG.trace("processing sxpMasterDB entries for sgt: {}", epPolicyTemplate.getSgt());
159 List<ListenableFuture<Pair<MasterDatabaseBinding, EndpointForwardingTemplateBySubnet>>> allResults =
160 new ArrayList<>(input.size());
161 for (MasterDatabaseBinding masterDBItem : input) {
162 final ListenableFuture<Optional<EndpointForwardingTemplateBySubnet>> epForwardingTemplateRead =
163 epForwardingTemplateDao.read(masterDBItem.getIpPrefix());
164 allResults.add(EPTemplateUtil.wrapToPair(masterDBItem, epForwardingTemplateRead));
166 result = Futures.successfulAsList(allResults);
175 public void close() throws Exception {
176 LOG.debug("closing listener registration to {}", templatePath);
177 listenerRegistration.close();