opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTreeCohort.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.annotations.VisibleForTesting;
  11 import com.google.common.primitives.UnsignedLong;
  12 import com.google.common.util.concurrent.FutureCallback;
  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.DataTreeCandidate;
  16 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
  17 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  18
  19 public abstract class ShardDataTreeCohort implements Identifiable<TransactionIdentifier> {
  20     public enum State {
  21         READY,
  22         CAN_COMMIT_PENDING,
  23         CAN_COMMIT_COMPLETE,
  24         PRE_COMMIT_PENDING,
  25         PRE_COMMIT_COMPLETE,
  26         COMMIT_PENDING,
  27
  28         ABORTED,
  29         COMMITTED,
  30         FAILED,
  31     }
  32
  33     ShardDataTreeCohort() {
  34         // Prevent foreign instantiation
  35     }
  36
  37     // FIXME: This leaks internal state generated in preCommit,
  38     // should be result of canCommit
  39     abstract DataTreeCandidateTip getCandidate();
  40
  41     abstract DataTreeModification getDataTreeModification();
  42
  43     // FIXME: Should return rebased DataTreeCandidateTip
  44     @VisibleForTesting
  45     public abstract void canCommit(FutureCallback<Void> callback);
  46
  47     @VisibleForTesting
  48     public abstract void preCommit(FutureCallback<DataTreeCandidate> callback);
  49
  50     @VisibleForTesting
  51     public abstract void abort(FutureCallback<Void> callback);
  52
  53     @VisibleForTesting
  54     public abstract void commit(FutureCallback<UnsignedLong> callback);
  55
  56     public abstract boolean isFailed();
  57
  58     public abstract State getState();
  59 }