2 * Copyright (c) 2015 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
9 package org.opendaylight.controller.cluster.databroker;
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import java.util.Collection;
14 import java.util.EnumMap;
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.DOMStoreThreePhaseCommitCohort;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
25 public abstract class AbstractDOMTransactionFactory<T extends DOMStoreTransactionFactory> implements AutoCloseable {
26 @SuppressWarnings("rawtypes")
27 private static final AtomicIntegerFieldUpdater<AbstractDOMTransactionFactory> UPDATER =
28 AtomicIntegerFieldUpdater.newUpdater(AbstractDOMTransactionFactory.class, "closed");
29 private final Map<LogicalDatastoreType, T> storeTxFactories;
30 private volatile int closed = 0;
32 protected AbstractDOMTransactionFactory(final Map<LogicalDatastoreType, T> txFactories) {
33 this.storeTxFactories = new EnumMap<>(txFactories);
37 * Implementations must return unique identifier for each and every call of
40 * @return new Unique transaction identifier.
42 protected abstract Object newTransactionIdentifier();
45 * Submits a transaction asynchronously for commit.
47 * @param transaction the transaction to submit
48 * @param cohorts the associated cohorts
49 * @return a resulting Future
51 protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(DOMDataWriteTransaction transaction,
52 Collection<DOMStoreThreePhaseCommitCohort> cohorts);
55 * Creates a new read-only transaction.
57 * @return the transaction instance
59 public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
62 return new DOMBrokerReadOnlyTransaction(newTransactionIdentifier(), storeTxFactories);
67 * Creates a new write-only transaction.
69 * @return the transaction instance
71 public final DOMDataWriteTransaction newWriteOnlyTransaction() {
74 return new DOMBrokerWriteOnlyTransaction(newTransactionIdentifier(), storeTxFactories, this);
79 * Creates a new read-write transaction.
81 * @return the transaction instance
83 public final DOMDataReadWriteTransaction newReadWriteTransaction() {
86 return new DOMBrokerReadWriteTransaction(newTransactionIdentifier(), storeTxFactories, this);
90 * Convenience accessor of backing factories intended to be used only by
91 * finalization of this class.
94 * Finalization of this class may want to access other functionality of
95 * supplied Transaction factories.
97 * @return Map of backing transaction factories.
99 protected final Map<LogicalDatastoreType, T> getTxFactories() {
100 return storeTxFactories;
104 * Checks if instance is not closed.
106 * @throws IllegalStateException If instance of this class was closed.
109 protected final void checkNotClosed() {
110 Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
114 public void close() {
115 final boolean success = UPDATER.compareAndSet(this, 0, 1);
116 Preconditions.checkState(success, "Transaction factory was already closed");