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 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.controller.md.sal.common.api.data.LogicalDatastoreType;
18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
19 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
20 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
25 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
26 import org.opendaylight.controller.sal.core.spi.data.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()}
67 * Callback invoked when {@link DOMDataWriteTransaction#submit()} is invoked
68 * on transaction created by this factory.
71 * Transaction on which {@link DOMDataWriteTransaction#commit()}
74 * Iteratable of cohorts for subtransactions associated with
75 * the transaction being committed.
76 * @return a CheckedFuture. if commit coordination on cohorts finished successfully,
77 * nothing is returned from the Future, On failure,
78 * the Future fails with a {@link TransactionCommitFailedException}.
80 protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
81 final Collection<DOMStoreThreePhaseCommitCohort> cohorts);
84 * Creates a new composite read-only transaction
86 * Creates a new composite read-only transaction backed by one transaction
87 * per factory in {@link #getTxFactories()}.
89 * Subtransaction for reading is selected by supplied
90 * {@link LogicalDatastoreType} as parameter for
91 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
94 * Id of returned transaction is retrieved via
95 * {@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 (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
114 * transaction per factory in {@link #getTxFactories()}.
117 * Implementation of composite Write-only transaction is following:
121 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, 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.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
124 * is invoked on selected subtransaction.
126 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, 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.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
129 * is invoked on selected subtransaction.
131 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
132 * - backing subtransaction is selected by {@link LogicalDatastoreType},
133 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
134 * selected subtransaction.
135 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
136 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
137 * and then invoking finalized implementation callback
138 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
139 * was commited and gathered results.
142 * Id of returned transaction is generated via
143 * {@link #newTransactionIdentifier()}.
145 * @return New composite write-only transaction associated with this
148 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
151 final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
152 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
153 txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
155 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
159 * Creates a new composite write-only transaction
162 * Creates a new composite write-only transaction backed by one write-only
163 * transaction per factory in {@link #getTxFactories()}.
165 * Implementation of composite Write-only transaction is following:
169 * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
170 * - backing subtransaction is selected by {@link LogicalDatastoreType},
171 * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
172 * selected subtransaction.
174 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
175 * - backing subtransaction is selected by {@link LogicalDatastoreType},
176 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
177 * is invoked on selected subtransaction.
179 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
180 * - backing subtransaction is selected by {@link LogicalDatastoreType},
181 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
182 * is invoked on selected subtransaction.
184 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
185 * - backing subtransaction is selected by {@link LogicalDatastoreType},
186 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
187 * selected subtransaction.
188 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
189 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
190 * and then invoking finalized implementation callback
191 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
192 * was commited and gathered results.
196 * Id of returned transaction is generated via
197 * {@link #newTransactionIdentifier()}.
199 * @return New composite read-write transaction associated with this
202 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
205 final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
206 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
207 txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
209 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
213 * Convenience accessor of backing factories intended to be used only by
214 * finalization of this class.
217 * Finalization of this class may want to access other functionality of
218 * supplied Transaction factories.
220 * @return Map of backing transaction factories.
222 protected final Map<LogicalDatastoreType, T> getTxFactories() {
223 return storeTxFactories;
227 * Checks if instance is not closed.
229 * @throws IllegalStateException If instance of this class was closed.
232 protected final void checkNotClosed() {
233 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
237 public void close() {
238 final boolean success = UPDATER.compareAndSet(this, 0, 1);
239 Preconditions.checkState(success, "Transaction factory was already closed");