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.util.concurrent.ListenableFuture;
  12 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
  13 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  14
  15 public abstract class ShardDataTreeCohort {
  16     ShardDataTreeCohort() {
  17         // Prevent foreign instantiation
  18     }
  19
  20     // FIXME: This leaks internal state generated in preCommit,
  21     // should be result of canCommit
  22     abstract DataTreeCandidateTip getCandidate();
  23     abstract DataTreeModification getDataTreeModification();
  24
  25     // FIXME: Should return rebased DataTreeCandidateTip
  26     @VisibleForTesting
  27     public abstract ListenableFuture<Boolean> canCommit();
  28     @VisibleForTesting
  29     public abstract ListenableFuture<Void> preCommit();
  30     @VisibleForTesting
  31     public abstract ListenableFuture<Void> abort();
  32     @VisibleForTesting
  33     public abstract ListenableFuture<Void> commit();
  34 }