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

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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 akka.actor.ActorSelection;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.SettableFuture;
  15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  16 import org.opendaylight.controller.cluster.datastore.messages.AbstractRead;
  17 import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
  18 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
  20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  21 import scala.concurrent.Future;
  22
  23 /**
  24  * Processes front-end transaction operations locally before being committed to the destination shard.
  25  * Instances of this class are used when the destination shard is local to the caller.
  26  *
  27  * @author Thomas Pantelis
  28  */
  29 abstract class LocalTransactionContext extends AbstractTransactionContext {
  30     private final DOMStoreTransaction txDelegate;
  31     private final LocalTransactionReadySupport readySupport;
  32     private Exception operationError;
  33
  34     LocalTransactionContext(DOMStoreTransaction txDelegate, TransactionIdentifier identifier,
  35             LocalTransactionReadySupport readySupport) {
  36         super(identifier);
  37         this.txDelegate = Preconditions.checkNotNull(txDelegate);
  38         this.readySupport = readySupport;
  39     }
  40
  41     protected abstract DOMStoreWriteTransaction getWriteDelegate();
  42
  43     protected abstract DOMStoreReadTransaction getReadDelegate();
  44
  45     @Override
  46     @SuppressWarnings("checkstyle:IllegalCatch")
  47     public void executeModification(final AbstractModification modification, final Boolean havePermit) {
  48         incrementModificationCount();
  49         if (operationError == null) {
  50             try {
  51                 modification.apply(getWriteDelegate());
  52             } catch (Exception e) {
  53                 operationError = e;
  54             }
  55         }
  56     }
  57
  58     @Override
  59     public <T> void executeRead(final AbstractRead<T> readCmd, final SettableFuture<T> proxyFuture,
  60             final Boolean havePermit) {
  61         Futures.addCallback(readCmd.apply(getReadDelegate()), new FutureCallback<T>() {
  62             @Override
  63             public void onSuccess(final T result) {
  64                 proxyFuture.set(result);
  65             }
  66
  67             @Override
  68             public void onFailure(final Throwable failure) {
  69                 proxyFuture.setException(failure);
  70             }
  71         });
  72     }
  73
  74     private LocalThreePhaseCommitCohort ready() {
  75         logModificationCount();
  76         return readySupport.onTransactionReady(getWriteDelegate(), operationError);
  77     }
  78
  79     @Override
  80     public Future<ActorSelection> readyTransaction(final Boolean havePermit) {
  81         final LocalThreePhaseCommitCohort cohort = ready();
  82         return cohort.initiateCoordinatedCommit();
  83     }
  84
  85     @Override
  86     public Future<Object> directCommit(final Boolean havePermit) {
  87         final LocalThreePhaseCommitCohort cohort = ready();
  88         return cohort.initiateDirectCommit();
  89     }
  90
  91     @Override
  92     public void closeTransaction() {
  93         txDelegate.close();
  94     }
  95 }