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.mdsal.common.api.TransactionChainClosedException;
  19 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  20 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  22 import org.opendaylight.mdsal.dom.spi.store.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     private final boolean debugAllocation;
  39
  40     ClientBackedTransactionChain(final ClientLocalHistory history, final boolean debugAllocation) {
  41         this.history = Preconditions.checkNotNull(history);
  42         this.debugAllocation = debugAllocation;
  43     }
  44
  45     @Override
  46     public DOMStoreReadTransaction newReadOnlyTransaction() {
  47         return new ClientBackedReadTransaction(createSnapshot(), this, allocationContext());
  48     }
  49
  50     @Override
  51     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
  52         return new ClientBackedReadWriteTransaction(createTransaction(), allocationContext());
  53     }
  54
  55     @Override
  56     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
  57         return new ClientBackedWriteTransaction(createTransaction(), allocationContext());
  58     }
  59
  60     @Override
  61     public synchronized void close() {
  62         for (AbstractClientHandle<?> snap : openSnapshots.keySet()) {
  63             LOG.warn("Aborting unclosed transaction {}", snap.getIdentifier());
  64             snap.abort();
  65         }
  66         openSnapshots.clear();
  67
  68         history.close();
  69     }
  70
  71     synchronized void snapshotClosed(final ClientSnapshot clientTransaction) {
  72         openSnapshots.remove(clientTransaction);
  73     }
  74
  75     private ClientSnapshot createSnapshot() {
  76         try {
  77             return recordSnapshot(history.takeSnapshot());
  78         } catch (org.opendaylight.mdsal.common.api.TransactionChainClosedException e) {
  79             throw new TransactionChainClosedException("Transaction chain has been closed", e);
  80         }
  81     }
  82
  83     private ClientTransaction createTransaction() {
  84         try {
  85             return recordSnapshot(history.createTransaction());
  86         } catch (org.opendaylight.mdsal.common.api.TransactionChainClosedException e) {
  87             throw new TransactionChainClosedException("Transaction chain has been closed", e);
  88         }
  89     }
  90
  91     private Throwable allocationContext() {
  92         return debugAllocation ? new Throwable("allocated at") : null;
  93     }
  94
  95     private synchronized <T extends AbstractClientHandle<?>> T recordSnapshot(final T snapshot) {
  96         openSnapshots.put(snapshot, Boolean.TRUE);
  97         return snapshot;
  98     }
  99 }