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 java.util.EnumMap;
13 import java.util.Map.Entry;
14 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
16 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
21 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
26 * Abstract composite transaction factory.
28 * Provides an convenience common implementation for composite DOM Transactions,
29 * where subtransaction is identified by {@link LogicalDatastoreType} type and
30 * implementation of subtransaction is provided by
31 * {@link DOMStoreTransactionFactory}.
33 * <b>Note:</b>This class does not have thread-safe implementation of {@link #close()},
34 * implementation may allow accessing and allocating new transactions during closing
38 * Type of {@link DOMStoreTransactionFactory} factory.
40 abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements DOMDataCommitImplementation, AutoCloseable {
41 @SuppressWarnings("rawtypes")
42 private static final AtomicIntegerFieldUpdater<AbstractDOMForwardedTransactionFactory> UPDATER =
43 AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
44 private final Map<LogicalDatastoreType, T> storeTxFactories;
45 private volatile int closed = 0;
47 protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
48 this.storeTxFactories = new EnumMap<>(txFactories);
52 * Implementations must return unique identifier for each and every call of
55 * @return new Unique transaction identifier.
57 protected abstract Object newTransactionIdentifier();
60 * Creates a new composite read-only transaction
62 * Creates a new composite read-only transaction backed by one transaction
63 * per factory in {@link #getTxFactories()}.
65 * Subtransaction for reading is selected by supplied
66 * {@link LogicalDatastoreType} as parameter for
67 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
70 * Id of returned transaction is retrieved via
71 * {@link #newTransactionIdentifier()}.
73 * @return New composite read-only transaction.
75 public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
78 final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
79 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
80 txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
82 return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
86 * Creates a new composite write-only transaction
89 * Creates a new composite write-only transaction backed by one write-only
90 * transaction per factory in {@link #getTxFactories()}.
93 * Implementation of composite Write-only transaction is following:
97 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
98 * - backing subtransaction is selected by {@link LogicalDatastoreType},
99 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
100 * is invoked on selected subtransaction.
102 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
103 * - backing subtransaction is selected by {@link LogicalDatastoreType},
104 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
105 * is invoked on selected subtransaction.
107 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
108 * - backing subtransaction is selected by {@link LogicalDatastoreType},
109 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
110 * selected subtransaction.
111 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
112 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
113 * and then invoking finalized implementation callback
114 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
115 * was commited and gathered results.
118 * Id of returned transaction is generated via
119 * {@link #newTransactionIdentifier()}.
121 * @return New composite write-only transaction associated with this
124 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
127 final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
128 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
129 txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
131 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
135 * Creates a new composite write-only transaction
138 * Creates a new composite write-only transaction backed by one write-only
139 * transaction per factory in {@link #getTxFactories()}.
141 * Implementation of composite Write-only transaction is following:
145 * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
146 * - backing subtransaction is selected by {@link LogicalDatastoreType},
147 * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
148 * selected subtransaction.
150 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
151 * - backing subtransaction is selected by {@link LogicalDatastoreType},
152 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
153 * is invoked on selected subtransaction.
155 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
156 * - backing subtransaction is selected by {@link LogicalDatastoreType},
157 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
158 * is invoked on selected subtransaction.
160 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
161 * - backing subtransaction is selected by {@link LogicalDatastoreType},
162 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
163 * selected subtransaction.
164 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
165 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
166 * and then invoking finalized implementation callback
167 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
168 * was commited and gathered results.
172 * Id of returned transaction is generated via
173 * {@link #newTransactionIdentifier()}.
175 * @return New composite read-write transaction associated with this
178 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
181 final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
182 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
183 txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
185 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
189 * Convenience accessor of backing factories intended to be used only by
190 * finalization of this class.
193 * Finalization of this class may want to access other functionality of
194 * supplied Transaction factories.
196 * @return Map of backing transaction factories.
198 protected final Map<LogicalDatastoreType, T> getTxFactories() {
199 return storeTxFactories;
203 * Checks if instance is not closed.
205 * @throws IllegalStateException If instance of this class was closed.
208 protected final void checkNotClosed() {
209 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
213 public void close() {
214 final boolean success = UPDATER.compareAndSet(this, 0, 1);
215 Preconditions.checkState(success, "Transaction factory was already closed");