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