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 org.opendaylight.mdsal.dom.api.DOMDataReadOnlyTransaction;
11 import org.opendaylight.mdsal.dom.api.DOMDataReadWriteTransaction;
12 import org.opendaylight.mdsal.dom.api.DOMDataWriteTransaction;
14 import com.google.common.base.Preconditions;
15 import com.google.common.util.concurrent.CheckedFuture;
16 import java.util.Collection;
17 import java.util.EnumMap;
19 import java.util.Map.Entry;
20 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
25 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
26 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
31 * Abstract composite transaction factory.
33 * Provides an convenience common implementation for composite DOM Transactions,
34 * where subtransaction is identified by {@link LogicalDatastoreType} type and
35 * implementation of subtransaction is provided by
36 * {@link DOMStoreTransactionFactory}.
38 * <b>Note:</b>This class does not have thread-safe implementation of {@link #close()},
39 * implementation may allow accessing and allocating new transactions during closing
43 * Type of {@link DOMStoreTransactionFactory} factory.
45 abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements AutoCloseable {
46 @SuppressWarnings("rawtypes")
47 private static final AtomicIntegerFieldUpdater<AbstractDOMForwardedTransactionFactory> UPDATER =
48 AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
49 private final Map<LogicalDatastoreType, T> storeTxFactories;
50 private volatile int closed = 0;
52 protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
53 this.storeTxFactories = new EnumMap<>(txFactories);
57 * Implementations must return unique identifier for each and every call of
60 * @return new Unique transaction identifier.
62 protected abstract Object newTransactionIdentifier();
65 * User-supplied implementation of {@link DOMDataWriteTransaction#submit()}
68 * Callback invoked when {@link DOMDataWriteTransaction#submit()} is invoked
69 * on transaction created by this factory.
72 * Transaction on which {@link DOMDataWriteTransaction#commit()}
75 * Iteratable of cohorts for subtransactions associated with
76 * the transaction being committed.
77 * @return a CheckedFuture. if commit coordination on cohorts finished successfully,
78 * nothing is returned from the Future, On failure,
79 * the Future fails with a {@link TransactionCommitFailedException}.
81 protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
82 final Collection<DOMStoreThreePhaseCommitCohort> cohorts);
85 * Creates a new composite read-only transaction
87 * Creates a new composite read-only transaction backed by one transaction per factory in
88 * {@link #getTxFactories()}.
90 * Subtransaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter
92 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
95 * Id of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
97 * @return New composite read-only transaction.
99 public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
102 final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
103 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
104 txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
106 return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
110 * Creates a new composite write-only transaction
113 * Creates a new composite write-only transaction backed by one write-only transaction per
114 * factory in {@link #getTxFactories()}.
117 * Implementation of composite Write-only transaction is following:
121 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
122 * - backing subtransaction is selected by {@link LogicalDatastoreType},
123 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
124 * is invoked on selected subtransaction.</li>
126 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
127 * - backing subtransaction is selected by {@link LogicalDatastoreType},
128 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
129 * is invoked on selected subtransaction.</li>
131 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
132 * - backing subtransaction is selected by {@link LogicalDatastoreType},
133 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
134 * is invoked on selected subtransaction.
135 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
136 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
137 * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
138 * transaction which was commited and gathered results.</li>
141 * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
143 * @return New composite write-only transaction associated with this factory.
145 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
148 final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
149 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
150 txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
152 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
156 * Creates a new composite write-only transaction
159 * Creates a new composite write-only transaction backed by one write-only transaction per
160 * factory in {@link #getTxFactories()}.
162 * Implementation of composite Write-only transaction is following:
166 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
167 * - backing subtransaction is selected by {@link LogicalDatastoreType},
168 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
169 * is invoked on selected subtransaction.</li>
171 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
172 * - backing subtransaction is selected by {@link LogicalDatastoreType},
173 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
174 * is invoked on selected subtransaction.</li>
176 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
177 * - backing subtransaction is selected by {@link LogicalDatastoreType},
178 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
179 * is invoked on selected subtransaction.</li>
180 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
181 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
182 * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
183 * transaction which was commited and gathered results.</li>
186 * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
188 * @return New composite read-write transaction associated with this factory.
190 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
193 final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
194 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
195 txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
197 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
201 * Convenience accessor of backing factories intended to be used only by
202 * finalization of this class.
205 * Finalization of this class may want to access other functionality of
206 * supplied Transaction factories.
208 * @return Map of backing transaction factories.
210 protected final Map<LogicalDatastoreType, T> getTxFactories() {
211 return storeTxFactories;
215 * Checks if instance is not closed.
217 * @throws IllegalStateException If instance of this class was closed.
220 protected final void checkNotClosed() {
221 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
225 public void close() {
226 final boolean success = UPDATER.compareAndSet(this, 0, 1);
227 Preconditions.checkState(success, "Transaction factory was already closed");