2 * Copyright (c) 2014 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.md.sal.dom.broker.impl;
10 import static com.google.common.base.Preconditions.checkState;
12 import javax.annotation.concurrent.GuardedBy;
14 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
16 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
17 import org.opendaylight.controller.md.sal.common.impl.service.AbstractDataTransaction;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
21 import org.opendaylight.yangtools.yang.common.RpcResult;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
25 import com.google.common.base.Preconditions;
26 import com.google.common.collect.ImmutableList;
27 import com.google.common.collect.ImmutableMap;
28 import com.google.common.util.concurrent.CheckedFuture;
29 import com.google.common.util.concurrent.ListenableFuture;
34 * Read-Write Transaction, which is composed of several
35 * {@link DOMStoreWriteTransaction} transactions. Subtransaction is selected by
36 * {@link LogicalDatastoreType} type parameter in:
39 * <li>{@link #put(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
40 * <li>{@link #delete(LogicalDatastoreType, YangInstanceIdentifier)}
41 * <li>{@link #merge(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
44 * {@link #commit()} will result in invocation of
45 * {@link DOMDataCommitImplementation#submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, Iterable)}
46 * invocation with all {@link org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort} for underlying
50 * Subtype of {@link DOMStoreWriteTransaction} which is used as
53 class DOMForwardedWriteTransaction<T extends DOMStoreWriteTransaction> extends
54 AbstractDOMForwardedCompositeTransaction<LogicalDatastoreType, T> implements DOMDataWriteTransaction {
57 * Implementation of real commit.
59 * Transaction can not be commited if commitImpl is null,
60 * so this seting this property to null is also used to
62 * already commited / canceled transaction {@link #checkNotCanceled()
67 private volatile DOMDataCommitImplementation commitImpl;
71 * Future task of transaction commit.
73 * This value is initially null, and is once updated if transaction
74 * is commited {@link #commit()}.
75 * If this future exists, transaction MUST not be commited again
76 * and all modifications should fail. See {@link #checkNotCommited()}.
80 private volatile CheckedFuture<Void, TransactionCommitFailedException> commitFuture;
82 protected DOMForwardedWriteTransaction(final Object identifier,
83 final ImmutableMap<LogicalDatastoreType, T> backingTxs, final DOMDataCommitImplementation commitImpl) {
84 super(identifier, backingTxs);
85 this.commitImpl = Preconditions.checkNotNull(commitImpl, "commitImpl must not be null.");
89 public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
91 getSubtransaction(store).write(path, data);
95 public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
97 getSubtransaction(store).delete(path);
101 public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
103 getSubtransaction(store).merge(path, data);
107 public synchronized boolean cancel() {
108 // Transaction is already canceled, we are safe to return true
109 final boolean cancelationResult;
110 if (commitImpl == null && commitFuture != null) {
111 // Transaction is submitted, we try to cancel future.
112 cancelationResult = commitFuture.cancel(false);
113 } else if(commitImpl == null) {
116 cancelationResult = true;
119 return cancelationResult;
124 public synchronized ListenableFuture<RpcResult<TransactionStatus>> commit() {
125 return AbstractDataTransaction.convertToLegacyCommitFuture(submit());
129 public CheckedFuture<Void,TransactionCommitFailedException> submit() {
132 ImmutableList.Builder<DOMStoreThreePhaseCommitCohort> cohortsBuilder = ImmutableList.builder();
133 for (DOMStoreWriteTransaction subTx : getSubtransactions()) {
134 cohortsBuilder.add(subTx.ready());
136 ImmutableList<DOMStoreThreePhaseCommitCohort> cohorts = cohortsBuilder.build();
137 commitFuture = commitImpl.submit(this, cohorts);
140 *We remove reference to Commit Implementation in order
141 *to prevent memory leak
147 private void checkNotReady() {
152 private void checkNotCanceled() {
153 Preconditions.checkState(commitImpl != null, "Transaction was canceled.");
156 private void checkNotCommited() {
157 checkState(commitFuture == null, "Transaction was already submited.");