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