opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractClientHandle.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.actors.dds;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.MoreObjects;
  15 import java.util.Collection;
  16 import java.util.concurrent.ConcurrentHashMap;
  17 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  21 import org.opendaylight.yangtools.concepts.Identifiable;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Abstract superclass of both ClientSnapshot and ClientTransaction. Provided for convenience.
  28  *
  29  * @author Robert Varga
  30  */
  31 @Beta
  32 public abstract class AbstractClientHandle<T extends AbstractProxyTransaction> extends LocalAbortable
  33         implements Identifiable<TransactionIdentifier> {
  34     /*
  35      * Our state consist of the the proxy map, hence we just subclass ConcurrentHashMap directly.
  36      */
  37     private static final class State<T> extends ConcurrentHashMap<Long, T> {
  38         private static final long serialVersionUID = 1L;
  39     }
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(AbstractClientHandle.class);
  42     @SuppressWarnings("rawtypes")
  43     private static final AtomicReferenceFieldUpdater<AbstractClientHandle, State> STATE_UPDATER =
  44             AtomicReferenceFieldUpdater.newUpdater(AbstractClientHandle.class, State.class, "state");
  45
  46     private final @NonNull TransactionIdentifier transactionId;
  47     private final @NonNull AbstractClientHistory parent;
  48
  49     private volatile State<T> state = new State<>();
  50
  51     // Hidden to prevent outside instantiation
  52     AbstractClientHandle(final AbstractClientHistory parent, final TransactionIdentifier transactionId) {
  53         this.transactionId = requireNonNull(transactionId);
  54         this.parent = requireNonNull(parent);
  55     }
  56
  57     @Override
  58     // Non-final for mocking
  59     public TransactionIdentifier getIdentifier() {
  60         return transactionId;
  61     }
  62
  63     /**
  64      * Release all state associated with this transaction.
  65      *
  66      * @return True if this transaction became closed during this call
  67      */
  68     // Non-final for mocking
  69     public boolean abort() {
  70         if (commonAbort()) {
  71             parent.onTransactionAbort(this);
  72             return true;
  73         }
  74
  75         return false;
  76     }
  77
  78     private boolean commonAbort() {
  79         final Collection<T> toClose = ensureClosed();
  80         if (toClose == null) {
  81             return false;
  82         }
  83
  84         toClose.forEach(AbstractProxyTransaction::abort);
  85         return true;
  86     }
  87
  88     @Override
  89     final void localAbort(final Throwable cause) {
  90         LOG.debug("Local abort of transaction {}", getIdentifier(), cause);
  91         commonAbort();
  92     }
  93
  94     /**
  95      * Make sure this snapshot is closed. If it became closed as the effect of this call, return a collection of
  96      * {@link AbstractProxyTransaction} handles which need to be closed, too.
  97      *
  98      * @return null if this snapshot has already been closed, otherwise a collection of proxies, which need to be
  99      *         closed, too.
 100      */
 101     final @Nullable Collection<T> ensureClosed() {
 102         // volatile read and a conditional CAS. This ends up being better in the typical case when we are invoked more
 103         // than once (see ClientBackedTransaction) than performing a STATE_UPDATER.getAndSet().
 104         final State<T> local = state;
 105         return local != null && STATE_UPDATER.compareAndSet(this, local, null) ? local.values() : null;
 106     }
 107
 108     final T ensureProxy(final YangInstanceIdentifier path) {
 109         final State<T> local = getState();
 110         final Long shard = parent.resolveShardForPath(path);
 111
 112         return local.computeIfAbsent(shard, this::createProxy);
 113     }
 114
 115     final AbstractClientHistory parent() {
 116         return parent;
 117     }
 118
 119     abstract @NonNull T createProxy(@NonNull Long shard);
 120
 121     private State<T> getState() {
 122         final State<T> local = state;
 123         checkState(local != null, "Transaction %s is closed", transactionId);
 124         return local;
 125     }
 126
 127     @Override
 128     public final String toString() {
 129         return MoreObjects.toStringHelper(this).omitNullValues().add("identifier", transactionId).add("state", state)
 130                 .toString();
 131     }
 132 }