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.mdsal.dom.broker;
10 import com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.CheckedFuture;
12 import java.util.Collection;
13 import java.util.EnumMap;
15 import java.util.Map.Entry;
16 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
18 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
19 import org.opendaylight.mdsal.dom.api.DOMDataReadOnlyTransaction;
20 import org.opendaylight.mdsal.dom.api.DOMDataReadWriteTransaction;
21 import org.opendaylight.mdsal.dom.api.DOMDataWriteTransaction;
22 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
23 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
25 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory;
26 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
30 * Abstract composite transaction factory.
32 * Provides an convenience common implementation for composite DOM Transactions,
33 * where subtransaction is identified by {@link LogicalDatastoreType} type and
34 * implementation of subtransaction is provided by
35 * {@link DOMStoreTransactionFactory}.
37 * <b>Note:</b>This class does not have thread-safe implementation of {@link #close()},
38 * implementation may allow accessing and allocating new transactions during closing
42 * Type of {@link DOMStoreTransactionFactory} factory.
44 abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements AutoCloseable {
45 @SuppressWarnings("rawtypes")
46 private static final AtomicIntegerFieldUpdater<AbstractDOMForwardedTransactionFactory> UPDATER =
47 AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
48 private final Map<LogicalDatastoreType, T> storeTxFactories;
49 private volatile int closed = 0;
51 protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
52 this.storeTxFactories = new EnumMap<>(txFactories);
56 * Implementations must return unique identifier for each and every call of
59 * @return new Unique transaction identifier.
61 protected abstract Object newTransactionIdentifier();
64 * User-supplied implementation of {@link DOMDataWriteTransaction#submit()} for transaction.
66 * Callback invoked when {@link DOMDataWriteTransaction#submit()} is invoked on transaction
67 * created by this factory.
69 * @param transaction Transaction on which {@link DOMDataWriteTransaction#submit()} was invoked.
70 * @param cohorts Iteratable of cohorts for subtransactions associated with the transaction
72 * @return a CheckedFuture. if commit coordination on cohorts finished successfully, nothing is
73 * returned from the Future, On failure, the Future fails with a
74 * {@link TransactionCommitFailedException}.
76 protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
77 final Collection<DOMStoreThreePhaseCommitCohort> cohorts);
80 * Creates a new composite read-only transaction
82 * Creates a new composite read-only transaction backed by one transaction per factory in
83 * {@link #getTxFactories()}.
85 * Subtransaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter
87 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
90 * Id of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
92 * @return New composite read-only transaction.
94 public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
97 final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
98 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
99 txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
101 return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
105 * Creates a new composite write-only transaction
108 * Creates a new composite write-only transaction backed by one write-only transaction per
109 * factory in {@link #getTxFactories()}.
112 * Implementation of composite Write-only transaction is following:
116 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
117 * - backing subtransaction is selected by {@link LogicalDatastoreType},
118 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
119 * is invoked on selected subtransaction.</li>
121 * {@link DOMDataWriteTransaction#merge(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#merge(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#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
127 * - backing subtransaction is selected by {@link LogicalDatastoreType},
128 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
129 * is invoked on selected subtransaction.
130 * <li> {@link DOMDataWriteTransaction#submit()} - results in invoking
131 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
132 * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
133 * transaction which was commited and gathered results.</li>
136 * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
138 * @return New composite write-only transaction associated with this factory.
140 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
143 final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
144 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
145 txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
147 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
151 * Creates a new composite write-only transaction
154 * Creates a new composite write-only transaction backed by one write-only transaction per
155 * factory in {@link #getTxFactories()}.
157 * Implementation of composite Write-only transaction is following:
161 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
162 * - backing subtransaction is selected by {@link LogicalDatastoreType},
163 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
164 * is invoked on selected subtransaction.</li>
166 * {@link DOMDataWriteTransaction#merge(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#merge(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#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
172 * - backing subtransaction is selected by {@link LogicalDatastoreType},
173 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
174 * is invoked on selected subtransaction.</li>
175 * <li> {@link DOMDataWriteTransaction#submit()} - results in invoking
176 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
177 * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
178 * transaction which was commited and gathered results.</li>
181 * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
183 * @return New composite read-write transaction associated with this factory.
185 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
188 final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
189 for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
190 txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
192 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
196 * Convenience accessor of backing factories intended to be used only by
197 * finalization of this class.
200 * Finalization of this class may want to access other functionality of
201 * supplied Transaction factories.
203 * @return Map of backing transaction factories.
205 protected final Map<LogicalDatastoreType, T> getTxFactories() {
206 return storeTxFactories;
210 * Checks if instance is not closed.
212 * @throws IllegalStateException If instance of this class was closed.
215 protected final void checkNotClosed() {
216 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
220 public void close() {
221 final boolean success = UPDATER.compareAndSet(this, 0, 1);
222 Preconditions.checkState(success, "Transaction factory was already closed");