opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractShardDataTreeTransaction.java

   1 /*
   2  * Copyright (c) 2015 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.datastore;
   9
  10 import com.google.common.base.MoreObjects;
  11 import com.google.common.base.Preconditions;
  12 import javax.annotation.concurrent.NotThreadSafe;
  13 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  14 import org.opendaylight.yangtools.concepts.Identifiable;
  15 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  16 import org.slf4j.Logger;
  17 import org.slf4j.LoggerFactory;
  18
  19 /**
  20  * Abstract base for transactions running on SharrdDataTree.
  21  *
  22  * @param <T> Backing transaction type.
  23  */
  24 @NotThreadSafe
  25 abstract class AbstractShardDataTreeTransaction<T extends DataTreeSnapshot>
  26         implements Identifiable<TransactionIdentifier> {
  27     private static final Logger LOG = LoggerFactory.getLogger(AbstractShardDataTreeTransaction.class);
  28
  29     private final ShardDataTreeTransactionParent parent;
  30     private final TransactionIdentifier id;
  31     private final T snapshot;
  32
  33     private boolean closed;
  34
  35     AbstractShardDataTreeTransaction(final ShardDataTreeTransactionParent parent, final TransactionIdentifier id,
  36         final T snapshot) {
  37         this.parent = Preconditions.checkNotNull(parent);
  38         this.snapshot = Preconditions.checkNotNull(snapshot);
  39         this.id = Preconditions.checkNotNull(id);
  40     }
  41
  42     @Override
  43     public final TransactionIdentifier getIdentifier() {
  44         return id;
  45     }
  46
  47     final ShardDataTreeTransactionParent getParent() {
  48         return parent;
  49     }
  50
  51     final T getSnapshot() {
  52         return snapshot;
  53     }
  54
  55     final boolean isClosed() {
  56         return closed;
  57     }
  58
  59     /**
  60      * Close this transaction and mark it as closed, allowing idempotent invocations.
  61      *
  62      * @return True if the transaction got closed by this method invocation.
  63      */
  64     protected final boolean close() {
  65         if (closed) {
  66             return false;
  67         }
  68
  69         closed = true;
  70         return true;
  71     }
  72
  73     final void abort(final Runnable callback) {
  74         Preconditions.checkState(close(), "Transaction is already closed");
  75         parent.abortTransaction(this, callback);
  76     }
  77
  78     @Override
  79     public final String toString() {
  80         return MoreObjects.toStringHelper(this).add("id", id).add("closed", closed).add("snapshot", snapshot)
  81                 .toString();
  82     }
  83 }