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
9 package org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.listen;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.util.concurrent.AsyncFunction;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.MoreExecutors;
19 import java.util.Collection;
20 import javax.annotation.Nonnull;
21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
22 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
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.MasterDatabaseBindingListener;
28 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.SimpleCachedDao;
29 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.SxpMapperReactor;
30 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.EPTemplateUtil;
31 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.L3EPServiceUtil;
32 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.util.SxpListenerUtil;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointForwardingTemplateBySubnet;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointPolicyTemplateBySgt;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.Sgt;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.master.database.fields.MasterDatabaseBinding;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.SxpNodeIdentity;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.network.topology.topology.node.SxpDomains;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.network.topology.topology.node.sxp.domains.SxpDomain;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.sxp.databases.fields.MasterDatabase;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
43 import org.opendaylight.yangtools.concepts.ListenerRegistration;
44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
45 import org.opendaylight.yangtools.yang.common.RpcError;
46 import org.opendaylight.yangtools.yang.common.RpcResult;
47 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 * listens to sxp master database and propagates change events for further processing
54 public class MasterDatabaseBindingListenerImpl implements MasterDatabaseBindingListener {
56 private static final Logger LOG = LoggerFactory.getLogger(MasterDatabaseBindingListenerImpl.class);
58 private static final FutureCallback<RpcResult<Void>> RPC_POLICY_RESULT_FUTURE_CALLBACK =
59 L3EPServiceUtil.createFailureLoggingCallback("failed to read epPolicyTemplate");
61 public static final FutureCallback<RpcResult<Void>> RPC_FW_RESULT_FUTURE_CALLBACK =
62 L3EPServiceUtil.createFailureLoggingCallback("failed to read epForwardingTemplate");
64 private final SxpMapperReactor sxpMapperReactor;
65 private final SimpleCachedDao<IpPrefix, MasterDatabaseBinding> masterDBBindingDaoCached;
66 private final DSAsyncDao<Sgt, EndpointPolicyTemplateBySgt> epPolicyTemplateDao;
67 private final DSAsyncDao<IpPrefix, EndpointForwardingTemplateBySubnet> epForwardingTemplateDao;
69 private final ListenerRegistration<? extends ClusteredDataTreeChangeListener> listenerRegistration;
70 private final InstanceIdentifier<MasterDatabaseBinding> sxpDbPath;
72 public MasterDatabaseBindingListenerImpl(final DataBroker dataBroker,
73 final SxpMapperReactor sxpMapperReactor,
74 final SimpleCachedDao<IpPrefix, MasterDatabaseBinding> masterDBBindingDaoCached,
75 final DSAsyncDao<Sgt, EndpointPolicyTemplateBySgt> epPolicyTemplateDao,
76 final DSAsyncDao<IpPrefix, EndpointForwardingTemplateBySubnet> epForwardingTemplateDao) {
77 this.sxpMapperReactor = Preconditions.checkNotNull(sxpMapperReactor);
78 this.masterDBBindingDaoCached = Preconditions.checkNotNull(masterDBBindingDaoCached);
79 this.epPolicyTemplateDao = Preconditions.checkNotNull(epPolicyTemplateDao);
80 this.epForwardingTemplateDao = Preconditions.checkNotNull(epForwardingTemplateDao);
82 //TODO: get exact sxp-node path from config (pointing to ise listener).. start listening later - when config appears
83 sxpDbPath = MasterDatabaseBindingListener.SXP_TOPOLOGY_PATH
85 .augmentation(SxpNodeIdentity.class)
86 .child(SxpDomains.class)
87 .child(SxpDomain.class)
88 .child(MasterDatabase.class)
89 .child(MasterDatabaseBinding.class);
91 final DataTreeIdentifier<MasterDatabaseBinding> dataTreeIdentifier = new DataTreeIdentifier<>(
92 LogicalDatastoreType.OPERATIONAL, sxpDbPath);
93 listenerRegistration = dataBroker.registerDataTreeChangeListener(dataTreeIdentifier, this);
94 LOG.debug("started listening to {}", sxpDbPath);
98 public void onDataTreeChanged(@Nonnull final Collection<DataTreeModification<MasterDatabaseBinding>> collection) {
99 for (DataTreeModification<MasterDatabaseBinding> change : collection) {
100 LOG.trace("received modification: {} -> {}", change.getRootPath(), change.getRootNode().getModificationType());
102 final MasterDatabaseBinding sxpMasterDBItem = change.getRootNode().getDataAfter();
103 if (sxpMasterDBItem == null) {
104 //TODO: cover sgt-ip mapping removal
105 LOG.debug("ip-sgt mapping was removed - NOOP: {}",
106 change.getRootPath().getRootIdentifier().firstKeyOf(MasterDatabaseBinding.class));
108 final IpPrefix ipPrefixKey = sxpMasterDBItem.getIpPrefix();
109 SxpListenerUtil.updateCachedDao(masterDBBindingDaoCached, ipPrefixKey, change);
110 processWithEPTemplates(sxpMasterDBItem);
115 private void processWithEPTemplates(final MasterDatabaseBinding sxpMasterDBItem) {
116 final ListenableFuture<Optional<EndpointPolicyTemplateBySgt>> epPolicyTemplateFuture =
117 epPolicyTemplateDao.read(sxpMasterDBItem.getSecurityGroupTag());
119 final ListenableFuture<Optional<EndpointForwardingTemplateBySubnet>> epForwardingTemplateFuture =
120 epForwardingTemplateDao.read(sxpMasterDBItem.getIpPrefix());
122 final ListenableFuture<EPTemplateUtil.OptionalMutablePair<EndpointPolicyTemplateBySgt, EndpointForwardingTemplateBySubnet>> compositeRead
123 = EPTemplateUtil.compositeRead(epPolicyTemplateFuture, epForwardingTemplateFuture);
125 final ListenableFuture<RpcResult<Void>> rpcResult = Futures.transformAsync(compositeRead,
126 new AsyncFunction<EPTemplateUtil.OptionalMutablePair<EndpointPolicyTemplateBySgt, EndpointForwardingTemplateBySubnet>, RpcResult<Void>>() {
128 public ListenableFuture<RpcResult<Void>> apply(final EPTemplateUtil.OptionalMutablePair<EndpointPolicyTemplateBySgt, EndpointForwardingTemplateBySubnet> input) throws Exception {
129 final ListenableFuture<RpcResult<Void>> result;
131 LOG.debug("no ep*Templates available for sgt/ip-prefix: {}/{}",
132 sxpMasterDBItem.getSecurityGroupTag(),
133 sxpMasterDBItem.getIpPrefix());
134 result = RpcResultBuilder.<Void>failed()
135 .withError(RpcError.ErrorType.APPLICATION,
136 "no ep-templates available for" + sxpMasterDBItem)
139 } else if (!input.getLeft().isPresent()) {
140 LOG.debug("no epPolicyTemplate available for sgt: {}", sxpMasterDBItem.getSecurityGroupTag());
141 result = RpcResultBuilder.<Void>failed()
142 .withError(RpcError.ErrorType.APPLICATION,
143 "no epPolicyTemplate available for " + sxpMasterDBItem)
145 } else if (!input.getRight().isPresent()) {
146 LOG.debug("no epForwardingTemplate available for ip-prefix: {}",
147 sxpMasterDBItem.getIpPrefix());
148 result = RpcResultBuilder.<Void>failed()
149 .withError(RpcError.ErrorType.APPLICATION,
150 "no epForwardingTemplate available for " + sxpMasterDBItem)
153 LOG.trace("processing sxpMasterDB event and epPolicyTemplate for sgt/ip-prefix: {}/{}",
154 sxpMasterDBItem.getSecurityGroupTag(),
155 sxpMasterDBItem.getIpPrefix());
156 result = sxpMapperReactor.processTemplatesAndSxpMasterDB(input.getLeft().get(),
157 input.getRight().get(), sxpMasterDBItem);
161 }, MoreExecutors.directExecutor());
163 Futures.addCallback(rpcResult, RPC_POLICY_RESULT_FUTURE_CALLBACK, MoreExecutors.directExecutor());
167 public void close() throws Exception {
168 LOG.debug("closing listener registration to {}", sxpDbPath);
169 listenerRegistration.close();