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.dom.spi.store.DOMStoreReadTransaction;
  19 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  20 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * An implementation of {@link DOMStoreTransactionChain} backed by a {@link ClientLocalHistory}.
  27  *
  28  * @author Robert Varga
  29  */
  30 final class ClientBackedTransactionChain implements DOMStoreTransactionChain {
  31     private static final Logger LOG = LoggerFactory.getLogger(ClientBackedTransactionChain.class);
  32
  33     @GuardedBy("this")
  34     private final Map<AbstractClientHandle<?>, Boolean> openSnapshots = new WeakHashMap<>();
  35
  36     private final ClientLocalHistory history;
  37     private final boolean debugAllocation;
  38
  39     ClientBackedTransactionChain(final ClientLocalHistory history, final boolean debugAllocation) {
  40         this.history = Preconditions.checkNotNull(history);
  41         this.debugAllocation = debugAllocation;
  42     }
  43
  44     @Override
  45     public DOMStoreReadTransaction newReadOnlyTransaction() {
  46         return new ClientBackedReadTransaction(createSnapshot(), this, allocationContext());
  47     }
  48
  49     @Override
  50     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
  51         return new ClientBackedReadWriteTransaction(createTransaction(), allocationContext());
  52     }
  53
  54     @Override
  55     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
  56         return new ClientBackedWriteTransaction(createTransaction(), allocationContext());
  57     }
  58
  59     @Override
  60     public synchronized void close() {
  61         for (AbstractClientHandle<?> snap : openSnapshots.keySet()) {
  62             LOG.warn("Aborting unclosed transaction {}", snap.getIdentifier());
  63             snap.abort();
  64         }
  65         openSnapshots.clear();
  66
  67         history.close();
  68     }
  69
  70     synchronized void snapshotClosed(final ClientSnapshot clientTransaction) {
  71         openSnapshots.remove(clientTransaction);
  72     }
  73
  74     private ClientSnapshot createSnapshot() {
  75         return recordSnapshot(history.takeSnapshot());
  76     }
  77
  78     private ClientTransaction createTransaction() {
  79         return recordSnapshot(history.createTransaction());
  80     }
  81
  82     private Throwable allocationContext() {
  83         return debugAllocation ? new Throwable("allocated at") : null;
  84     }
  85
  86     private synchronized <T extends AbstractClientHandle<?>> T recordSnapshot(final T snapshot) {
  87         openSnapshots.put(snapshot, Boolean.TRUE);
  88         return snapshot;
  89     }
  90 }