b2f66d5d31b1952c639c6cc3b24d34bcd5d0b1be
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / databroker / actors / dds / AbstractTransactionCommitCohort.java
1 /*
2  * Copyright (c) 2016 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.databroker.actors.dds;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.base.MoreObjects;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
16 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
17
18 /**
19  * Base class for internal {@link DOMStoreThreePhaseCommitCohort} implementation. It contains utility constants for
20  * wide reuse.
21  *
22  * @author Robert Varga
23  */
24 abstract class AbstractTransactionCommitCohort implements DOMStoreThreePhaseCommitCohort {
25     static final ListenableFuture<Boolean> TRUE_FUTURE = Futures.immediateFuture(Boolean.TRUE);
26     static final ListenableFuture<Void> VOID_FUTURE = Futures.immediateFuture(null);
27
28     private final AbstractClientHistory parent;
29     private final TransactionIdentifier txId;
30
31     AbstractTransactionCommitCohort(final AbstractClientHistory parent, final TransactionIdentifier txId) {
32         this.parent = requireNonNull(parent);
33         this.txId = requireNonNull(txId);
34     }
35
36     final void complete() {
37         parent.onTransactionComplete(txId);
38     }
39
40     @Override
41     public final String toString() {
42         return MoreObjects.toStringHelper(this).add("txId", txId).toString();
43     }
44 }