opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java

   1 /*
   2  * Copyright (c) 2014 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.sal.core.spi.data;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11
  12 /**
  13  * Interface implemented by the {@link DOMStore} and exposed for each {@link DOMStoreWriteTransaction}
  14  * upon its transition to Ready state. The frontend (DOMStore user) uses this interface to drive the
  15  * commit procedure across potentially multiple DOMStores using the Three-Phase-Commit (3PC) Protocol,
  16  * as described in <a href="https://en.wikipedia.org/wiki/Three-phase_commit">Three-Phase-Commit Protocol</a>.
  17  */
  18 public interface DOMStoreThreePhaseCommitCohort {
  19
  20     /**
  21      * Sends transaction associated with this three phase commit instance to the
  22      * participant, participant votes on the transaction, if the transaction
  23      * should be committed or aborted.
  24      *
  25      * @return ListenableFuture with vote of the participant. Vote
  26      *         {@link ListenableFuture#get()} is following:
  27      *         <ul>
  28      *         <li>
  29      *         true if transaction is approved by data store.
  30      *         <li>false if the transaction is not approved by data store and
  31      *         should be aborted.
  32      *         </ul>
  33      */
  34     ListenableFuture<Boolean> canCommit();
  35
  36     /**
  37      * Initiates a pre-commit phase of associated transaction on datastore.
  38      *
  39      * <p>
  40      * This message is valid only and only if and only if the participant responded
  41      * on {@link #canCommit()} call with positive response.
  42      *
  43      * @return ListenableFuture representing acknowledgment for participant
  44      *        that pre-commit message was received and processed.
  45      */
  46     ListenableFuture<Void> preCommit();
  47
  48     /**
  49      * Initiates a abort phase of associated transaction on data store.
  50      *
  51      * @return ListenableFuture representing acknowledgment for participant
  52      *        that abort message was received.
  53      */
  54     ListenableFuture<Void> abort();
  55
  56     /**
  57      * Initiates a commit phase on of associated transaction on data store.
  58      *
  59      * @return ListenableFuture representing acknowledgment for participant
  60      *        that commit message was received and commit of transaction was
  61      *        processed.
  62      */
  63     ListenableFuture<Void> commit();
  64 }