opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/ClientBackedTransactionChain.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.controller.cluster.databroker;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.Map;
  12 import java.util.WeakHashMap;
  13 import javax.annotation.concurrent.GuardedBy;
  14 import org.opendaylight.controller.cluster.databroker.actors.dds.AbstractClientHandle;
  15 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientLocalHistory;
  16 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientSnapshot;
  17 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientTransaction;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
  19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  21 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * An implementation of {@link DOMStoreTransactionChain} backed by a {@link ClientLocalHistory}.
  28  *
  29  * @author Robert Varga
  30  */
  31 final class ClientBackedTransactionChain implements DOMStoreTransactionChain {
  32     private static final Logger LOG = LoggerFactory.getLogger(ClientBackedTransactionChain.class);
  33
  34     @GuardedBy("this")
  35     private final Map<AbstractClientHandle<?>, Boolean> openSnapshots = new WeakHashMap<>();
  36
  37     private final ClientLocalHistory history;
  38
  39     ClientBackedTransactionChain(final ClientLocalHistory history) {
  40         this.history = Preconditions.checkNotNull(history);
  41     }
  42
  43     @Override
  44     public DOMStoreReadTransaction newReadOnlyTransaction() {
  45         return new ClientBackedReadTransaction(createSnapshot(), this);
  46     }
  47
  48     @Override
  49     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
  50         return new ClientBackedReadWriteTransaction(createTransaction());
  51     }
  52
  53     @Override
  54     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
  55         return new ClientBackedWriteTransaction(createTransaction());
  56     }
  57
  58     @Override
  59     public synchronized void close() {
  60         for (AbstractClientHandle<?> snap : openSnapshots.keySet()) {
  61             LOG.warn("Aborting unclosed transaction {}", snap.getIdentifier());
  62             snap.abort();
  63         }
  64         openSnapshots.clear();
  65
  66         history.close();
  67     }
  68
  69     synchronized void snapshotClosed(final ClientSnapshot clientTransaction) {
  70         openSnapshots.remove(clientTransaction);
  71     }
  72
  73     private ClientSnapshot createSnapshot() {
  74         try {
  75             return recordSnapshot(history.takeSnapshot());
  76         } catch (org.opendaylight.mdsal.common.api.TransactionChainClosedException e) {
  77             throw new TransactionChainClosedException("Transaction chain has been closed", e);
  78         }
  79     }
  80
  81     private ClientTransaction createTransaction() {
  82         try {
  83             return recordSnapshot(history.createTransaction());
  84         } catch (org.opendaylight.mdsal.common.api.TransactionChainClosedException e) {
  85             throw new TransactionChainClosedException("Transaction chain has been closed", e);
  86         }
  87     }
  88
  89     private synchronized <T extends AbstractClientHandle<?>> T recordSnapshot(final T snapshot) {
  90         openSnapshots.put(snapshot, Boolean.TRUE);
  91         return snapshot;
  92     }
  93 }