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;
11 import java.util.Map.Entry;
13 import javax.annotation.concurrent.GuardedBy;
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;
24 import com.google.common.base.Preconditions;
25 import com.google.common.collect.ImmutableMap;
29 * Abstract composite transaction factory.
31 * Provides an convenience common implementation for composite DOM Transactions,
32 * where subtransaction is identified by {@link LogicalDatastoreType} type and
33 * implementation of subtransaction is provided by
34 * {@link DOMStoreTransactionFactory}.
36 * <b>Note:</b>This class does not have thread-safe implementation of {@link #close()},
37 * implementation may allow accessing and allocating new transactions during closing
41 * Type of {@link DOMStoreTransactionFactory} factory.
43 public abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements DOMDataCommitImplementation, AutoCloseable {
45 private final ImmutableMap<LogicalDatastoreType, T> storeTxFactories;
47 private boolean closed;
49 protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
50 this.storeTxFactories = ImmutableMap.copyOf(txFactories);
54 * Implementations must return unique identifier for each and every call of
57 * @return new Unique transaction identifier.
59 protected abstract Object newTransactionIdentifier();
62 * Creates a new composite read-only transaction
64 * Creates a new composite read-only transaction backed by one transaction
65 * per factory in {@link #getTxFactories()}.
67 * Subtransaction for reading is selected by supplied
68 * {@link LogicalDatastoreType} as parameter for
69 * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
72 * Id of returned transaction is retrieved via
73 * {@link #newTransactionIdentifier()}.
75 * @return New composite read-only transaction.
77 public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
79 ImmutableMap.Builder<LogicalDatastoreType, DOMStoreReadTransaction> builder = ImmutableMap.builder();
80 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
81 builder.put(store.getKey(), store.getValue().newReadOnlyTransaction());
83 return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), builder.build());
89 * Creates a new composite write-only transaction
92 * Creates a new composite write-only transaction backed by one write-only
93 * transaction per factory in {@link #getTxFactories()}.
96 * Implementation of composite Write-only transaction is following:
100 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
101 * - backing subtransaction is selected by {@link LogicalDatastoreType},
102 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
103 * is invoked on selected subtransaction.
105 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
106 * - backing subtransaction is selected by {@link LogicalDatastoreType},
107 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
108 * is invoked on selected subtransaction.
110 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
111 * - backing subtransaction is selected by {@link LogicalDatastoreType},
112 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
113 * selected subtransaction.
114 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
115 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
116 * and then invoking finalized implementation callback
117 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
118 * was commited and gathered results.
121 * Id of returned transaction is generated via
122 * {@link #newTransactionIdentifier()}.
124 * @return New composite write-only transaction associated with this
127 public DOMDataWriteTransaction newWriteOnlyTransaction() {
129 ImmutableMap.Builder<LogicalDatastoreType, DOMStoreWriteTransaction> builder = ImmutableMap.builder();
130 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
131 builder.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
133 return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), builder.build(),
138 * Creates a new composite write-only transaction
141 * Creates a new composite write-only transaction backed by one write-only
142 * transaction per factory in {@link #getTxFactories()}.
144 * Implementation of composite Write-only transaction is following:
148 * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
149 * - backing subtransaction is selected by {@link LogicalDatastoreType},
150 * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
151 * selected subtransaction.
153 * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
154 * - backing subtransaction is selected by {@link LogicalDatastoreType},
155 * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
156 * is invoked on selected subtransaction.
158 * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
159 * - backing subtransaction is selected by {@link LogicalDatastoreType},
160 * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
161 * is invoked on selected subtransaction.
163 * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
164 * - backing subtransaction is selected by {@link LogicalDatastoreType},
165 * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
166 * selected subtransaction.
167 * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
168 * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
169 * and then invoking finalized implementation callback
170 * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
171 * was commited and gathered results.
175 * Id of returned transaction is generated via
176 * {@link #newTransactionIdentifier()}.
178 * @return New composite read-write transaction associated with this
182 public DOMDataReadWriteTransaction newReadWriteTransaction() {
184 ImmutableMap.Builder<LogicalDatastoreType, DOMStoreReadWriteTransaction> builder = ImmutableMap.builder();
185 for (Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
186 builder.put(store.getKey(), store.getValue().newReadWriteTransaction());
188 return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), builder.build(), this);
192 * Convenience accessor of backing factories intended to be used only by
193 * finalization of this class.
196 * Finalization of this class may want to access other functionality of
197 * supplied Transaction factories.
199 * @return Map of backing transaction factories.
201 protected final Map<LogicalDatastoreType, T> getTxFactories() {
202 return storeTxFactories;
207 * Checks if instance is not closed.
209 * @throws IllegalStateException If instance of this class was closed.
213 protected synchronized void checkNotClosed() {
214 Preconditions.checkState(!closed,"Transaction factory was closed. No further operations allowed.");
219 public synchronized void close() {