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.collect.ImmutableMap;
12 import java.util.EnumMap;
14 import java.util.Map.Entry;
15 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
21 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
27 * Abstract composite transaction factory.
29 * Provides an convenience common implementation for composite DOM Transactions,
30 * where subtransaction is identified by {@link LogicalDatastoreType} type and
31 * implementation of subtransaction is provided by
32 * {@link DOMStoreTransactionFactory}.
34 * <b>Note:</b>This class does not have thread-safe implementation of {@link #close()},
35 * implementation may allow accessing and allocating new transactions during closing
39 * Type of {@link DOMStoreTransactionFactory} factory.
41 abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements DOMDataCommitImplementation, AutoCloseable {
42 @SuppressWarnings("rawtypes")
43 private static final AtomicIntegerFieldUpdater<AbstractDOMForwardedTransactionFactory> UPDATER =
44 AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
45 private final Map<LogicalDatastoreType, T> storeTxFactories;
46 private volatile int closed = 0;
48 protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
49 this.storeTxFactories = ImmutableMap.copyOf(txFactories);
53 * Implementations must return unique identifier for each and every call of
56 * @return new Unique transaction identifier.
58 protected abstract Object newTransactionIdentifier();
61 * Creates a new composite read-only transaction
63 * Creates a new composite read-only transaction backed by one transaction
64 * per factory in {@link #getTxFactories()}.
66 * Subtransaction for reading is selected by supplied
67 * {@link LogicalDatastoreType} as parameter for
68 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
71 * Id of returned transaction is retrieved via
72 * {@link #newTransactionIdentifier()}.
74 * @return New composite read-only transaction.
76 public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
79 final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
80 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
81 txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
83 return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
87 * Creates a new composite write-only transaction
90 * Creates a new composite write-only transaction backed by one write-only
91 * transaction per factory in {@link #getTxFactories()}.
94 * Implementation of composite Write-only transaction is following:
98 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
99 * - backing subtransaction is selected by {@link LogicalDatastoreType},
100 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
101 * is invoked on selected subtransaction.
103 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
104 * - backing subtransaction is selected by {@link LogicalDatastoreType},
105 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
106 * is invoked on selected subtransaction.
108 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
109 * - backing subtransaction is selected by {@link LogicalDatastoreType},
110 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
111 * selected subtransaction.
112 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
113 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
114 * and then invoking finalized implementation callback
115 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
116 * was commited and gathered results.
119 * Id of returned transaction is generated via
120 * {@link #newTransactionIdentifier()}.
122 * @return New composite write-only transaction associated with this
125 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
128 final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
129 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
130 txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
132 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
136 * Creates a new composite write-only transaction
139 * Creates a new composite write-only transaction backed by one write-only
140 * transaction per factory in {@link #getTxFactories()}.
142 * Implementation of composite Write-only transaction is following:
146 * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
147 * - backing subtransaction is selected by {@link LogicalDatastoreType},
148 * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
149 * selected subtransaction.
151 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
152 * - backing subtransaction is selected by {@link LogicalDatastoreType},
153 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
154 * is invoked on selected subtransaction.
156 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
157 * - backing subtransaction is selected by {@link LogicalDatastoreType},
158 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
159 * is invoked on selected subtransaction.
161 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
162 * - backing subtransaction is selected by {@link LogicalDatastoreType},
163 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
164 * selected subtransaction.
165 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
166 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
167 * and then invoking finalized implementation callback
168 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
169 * was commited and gathered results.
173 * Id of returned transaction is generated via
174 * {@link #newTransactionIdentifier()}.
176 * @return New composite read-write transaction associated with this
179 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
182 final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
183 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
184 txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
186 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
190 * Convenience accessor of backing factories intended to be used only by
191 * finalization of this class.
194 * Finalization of this class may want to access other functionality of
195 * supplied Transaction factories.
197 * @return Map of backing transaction factories.
199 protected final Map<LogicalDatastoreType, T> getTxFactories() {
200 return storeTxFactories;
204 * Checks if instance is not closed.
206 * @throws IllegalStateException If instance of this class was closed.
209 protected final void checkNotClosed() {
210 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
214 public void close() {
215 final boolean success = UPDATER.compareAndSet(this, 0, 1);
216 Preconditions.checkState(success, "Transaction factory was already closed");