sxp-integration/sxp-ep-provider/src/main/java/org/opendaylight/groupbasedpolicy/sxp/ep/provider/impl/dao/MasterDatabaseBindingDaoImpl.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.dao;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import java.util.Objects;
  22 import java.util.stream.Collectors;
  23 import javax.annotation.Nonnull;
  24 import javax.annotation.Nullable;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  29 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.DSAsyncDao;
  30 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.MasterDatabaseBindingListener;
  31 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.ReadableAsyncByKey;
  32 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.impl.SimpleCachedDao;
  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.sxp.database.rev160308.MasterDatabaseFields;
  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.SxpDatabasesFields;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.SxpNodeIdentity;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.node.rev160308.network.topology.topology.node.SxpDomains;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  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.yang.binding.InstanceIdentifier;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Purpose: general dao for EndPoint templates
  49  */
  50 public class MasterDatabaseBindingDaoImpl implements DSAsyncDao<IpPrefix, MasterDatabaseBinding>,
  51         ReadableAsyncByKey<Sgt, MasterDatabaseBinding> {
  52
  53     private static final Logger LOG = LoggerFactory.getLogger(MasterDatabaseBindingDaoImpl.class);
  54     private static final ListenableFuture<Optional<MasterDatabaseBinding>>
  55         READ_FUTURE_ABSENT = Futures.immediateFuture(Optional.absent());
  56
  57     private final DataBroker dataBroker;
  58     private final SimpleCachedDao<IpPrefix, MasterDatabaseBinding> cachedDao;
  59
  60     public MasterDatabaseBindingDaoImpl(final DataBroker dataBroker,
  61                               final SimpleCachedDao<IpPrefix, MasterDatabaseBinding> cachedDao) {
  62         this.dataBroker = dataBroker;
  63         this.cachedDao = cachedDao;
  64     }
  65
  66     @Override
  67     public ListenableFuture<Optional<MasterDatabaseBinding>> read(@Nonnull final IpPrefix key) {
  68         final Optional<MasterDatabaseBinding> cachedMasterDatabaseBinding = lookup(cachedDao, key);
  69         if (cachedMasterDatabaseBinding.isPresent()) {
  70             return Futures.immediateFuture(cachedMasterDatabaseBinding);
  71         } else if (!cachedDao.isEmpty()) {
  72             return READ_FUTURE_ABSENT;
  73         } else {
  74             final ListenableFuture<Void> cacheUpdatedFt = updateCache();
  75
  76             return Futures.transform(cacheUpdatedFt, new Function<Void, Optional<MasterDatabaseBinding>>() {
  77                 @Nullable
  78                 @Override
  79                 public Optional<MasterDatabaseBinding> apply(@Nullable final Void input) {
  80                     return lookup(cachedDao, key);
  81                 }
  82             }, MoreExecutors.directExecutor());
  83         }
  84     }
  85
  86     private ListenableFuture<Void> updateCache() {
  87         final ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
  88         final CheckedFuture<Optional<Topology>, ReadFailedException> read =
  89                 rTx.read(LogicalDatastoreType.CONFIGURATION, buildReadPath(null));
  90
  91         Futures.addCallback(read, SxpListenerUtil.createTxCloseCallback(rTx), MoreExecutors.directExecutor());
  92
  93         return Futures.transform(read, new Function<Optional<Topology>, Void>() {
  94             @Nullable
  95             @Override
  96             public Void apply(@Nullable final Optional<Topology> input) {
  97                 if (input != null) {
  98                     // clean cache
  99                     cachedDao.invalidateCache();
 100
 101                     final List<Node> nodeList = java.util.Optional.ofNullable(input.orNull())
 102                             .map(Topology::getNode)
 103                             .orElseGet(() -> {
 104                                 LOG.warn("failed to update cache of SxpMasterDB - no data");
 105                                 return Collections.emptyList();
 106                             });
 107                     for (Node node : nodeList) {
 108                         java.util.Optional.ofNullable(node.getAugmentation(SxpNodeIdentity.class))
 109                                 .map(SxpNodeIdentity::getSxpDomains)
 110                                 .map(SxpDomains::getSxpDomain)
 111                                 .ifPresent((sxpDomain) -> {
 112                                     final List<MasterDatabaseBinding> masterDBBindings = sxpDomain.stream()
 113                                             .map(SxpDatabasesFields::getMasterDatabase)
 114                                             .filter(masterDb -> masterDb != null)
 115                                             .map(MasterDatabaseFields::getMasterDatabaseBinding)
 116                                             .filter(binding -> binding != null)
 117                                             .flatMap(Collection::stream)
 118                                             .collect(Collectors.toList());
 119
 120                                     for (MasterDatabaseBinding masterDBItem : masterDBBindings) {
 121                                         // update all
 122                                         final MasterDatabaseBinding
 123                                                 previousValue =
 124                                                 cachedDao.update(masterDBItem.getIpPrefix(), masterDBItem);
 125                                         if (previousValue != null) {
 126                                             LOG.warn("updated key already obtained: [node:{}, sgt:{}]",
 127                                                     node.getNodeId().getValue(), masterDBItem.getSecurityGroupTag());
 128                                         }
 129                                     }
 130                                 });
 131                     }
 132                 } else {
 133                     LOG.warn("failed to update cache of SxpMasterDB - null input");
 134                 }
 135                 return null;
 136             }
 137         }, MoreExecutors.directExecutor());
 138     }
 139
 140     private InstanceIdentifier<Topology> buildReadPath(final Sgt key) {
 141         return MasterDatabaseBindingListener.SXP_TOPOLOGY_PATH;
 142     }
 143
 144     private Optional<MasterDatabaseBinding> lookup(final SimpleCachedDao<IpPrefix, MasterDatabaseBinding> cachedDao, final IpPrefix key) {
 145         return cachedDao.find(key);
 146     }
 147
 148     @Override
 149     public ListenableFuture<Collection<MasterDatabaseBinding>> readBy(@Nonnull final Sgt specialKey) {
 150         final ListenableFuture<Void> cacheUpdatedFt;
 151         if (!cachedDao.isEmpty()) {
 152             cacheUpdatedFt = Futures.immediateFuture(null);
 153         } else {
 154             cacheUpdatedFt = updateCache();
 155         }
 156
 157         return Futures.transform(cacheUpdatedFt, new Function<Void, Collection<MasterDatabaseBinding>>() {
 158             @Nullable
 159             @Override
 160             public Collection<MasterDatabaseBinding> apply(@Nullable final Void input) {
 161                 final Collection<MasterDatabaseBinding> foundGroups = new ArrayList<>();
 162
 163                 for (MasterDatabaseBinding masterDBItem : cachedDao.values()) {
 164                     if (masterDBItem.getSecurityGroupTag().equals(specialKey)) {
 165                         foundGroups.add(masterDBItem);
 166                     }
 167                 }
 168                 return foundGroups;
 169             }
 170         }, MoreExecutors.directExecutor());
 171     }
 172 }