2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.MoreObjects.ToStringHelper;
13 import com.google.common.primitives.UnsignedLong;
14 import com.google.common.util.concurrent.FutureCallback;
15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
16 import org.opendaylight.yangtools.concepts.Identifiable;
17 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
18 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
22 public abstract class ShardDataTreeCohort implements Identifiable<TransactionIdentifier> {
36 ShardDataTreeCohort() {
37 // Prevent foreign instantiation
40 // FIXME: This leaks internal state generated in preCommit,
41 // should be result of canCommit
42 abstract DataTreeCandidateTip getCandidate();
44 abstract DataTreeModification getDataTreeModification();
46 // FIXME: Should return rebased DataTreeCandidateTip
48 public abstract void canCommit(FutureCallback<Void> callback);
51 public abstract void preCommit(FutureCallback<DataTreeCandidate> callback);
54 public abstract void abort(FutureCallback<Void> callback);
57 public abstract void commit(FutureCallback<UnsignedLong> callback);
59 public abstract boolean isFailed();
61 public abstract State getState();
64 public final String toString() {
65 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
68 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
69 return toStringHelper.add("id", getIdentifier()).add("state", getState());