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