sxp-integration/sxp-ep-provider/src/main/java/org/opendaylight/groupbasedpolicy/sxp/ep/provider/impl/listen/EPPolicyTemplateListenerImpl.java

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