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