/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.mdsal.dom.broker;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.CheckedFuture;
import java.util.Collection;
import java.util.EnumMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory;
import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
/**
* Abstract composite transaction factory.
*
*
* Provides an convenience common implementation for composite DOM Transactions,
* where subtransaction is identified by {@link LogicalDatastoreType} type and
* implementation of subtransaction is provided by
* {@link DOMStoreTransactionFactory}.
*
* Note:This class does not have thread-safe implementation of {@link #close()},
* implementation may allow accessing and allocating new transactions during closing
* this instance.
*
* @param
* Type of {@link DOMStoreTransactionFactory} factory.
*/
abstract class AbstractDOMForwardedTransactionFactory implements AutoCloseable {
@SuppressWarnings("rawtypes")
private static final AtomicIntegerFieldUpdater UPDATER =
AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
private final Map storeTxFactories;
private volatile int closed = 0;
protected AbstractDOMForwardedTransactionFactory(final Map txFactories) {
this.storeTxFactories = new EnumMap<>(txFactories);
}
/**
* Implementations must return unique identifier for each and every call of
* this method.
*
* @return new Unique transaction identifier.
*/
protected abstract Object newTransactionIdentifier();
/**
* User-supplied implementation of {@link DOMDataTreeWriteTransaction#submit()} for transaction.
*
*
* Callback invoked when {@link DOMDataTreeWriteTransaction#submit()} is invoked on transaction
* created by this factory.
*
* @param transaction Transaction on which {@link DOMDataTreeWriteTransaction#submit()} was invoked.
* @param cohorts Iteratable of cohorts for subtransactions associated with the transaction
* being committed.
* @return a CheckedFuture. if commit coordination on cohorts finished successfully, nothing is
* returned from the Future, On failure, the Future fails with a
* {@link TransactionCommitFailedException}.
*/
protected abstract CheckedFuture submit(
final DOMDataTreeWriteTransaction transaction,
final Collection cohorts);
/**
* Creates a new composite read-only transaction.
*
*
* Creates a new composite read-only transaction backed by one transaction per factory in
* {@link #getTxFactories()}.
*
*
* Subtransaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter
* for
* {@link DOMDataTreeReadTransaction#read(LogicalDatastoreType,
* org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
*
*
* Id of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
*
* @return New composite read-only transaction.
*/
public final DOMDataTreeReadTransaction newReadOnlyTransaction() {
checkNotClosed();
final Map txns = new EnumMap<>(LogicalDatastoreType.class);
for (final Entry store : storeTxFactories.entrySet()) {
txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
}
return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
}
/**
* Creates a new composite write-only transaction
*
*
* Creates a new composite write-only transaction backed by one write-only transaction per
* factory in {@link #getTxFactories()}.
*
*
* Implementation of composite Write-only transaction is following:
*
*
* -
* {@link DOMDataTreeWriteTransaction#put(LogicalDatastoreType,
* org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,
* org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
* - backing subtransaction is selected by {@link LogicalDatastoreType},
* {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,
* org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
* is invoked on selected subtransaction.
* -
* {@link DOMDataTreeWriteTransaction#merge(LogicalDatastoreType,
* org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,
* org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
* - backing subtransaction is selected by {@link LogicalDatastoreType},
* {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,
* org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
* is invoked on selected subtransaction.
* -
* {@link DOMDataTreeWriteTransaction#delete(LogicalDatastoreType,
* org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
* - backing subtransaction is selected by {@link LogicalDatastoreType},
* {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
* is invoked on selected subtransaction.
*
- {@link DOMDataTreeWriteTransaction#submit()} - results in invoking
* {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
* finalized implementation callback {@link #submit(DOMDataTreeWriteTransaction, Collection)} with
* transaction which was commited and gathered results.
*
*
*
* Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
*
* @return New composite write-only transaction associated with this factory.
*/
public final DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
checkNotClosed();
final Map txns = new EnumMap<>(LogicalDatastoreType.class);
for (final Entry store : storeTxFactories.entrySet()) {
txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
}
return new DOMForwardedWriteTransaction(newTransactionIdentifier(), txns, this);
}
/**
* Convenience accessor of backing factories intended to be used only by
* finalization of this class.
*
* Note:
* Finalization of this class may want to access other functionality of
* supplied Transaction factories.
*
* @return Map of backing transaction factories.
*/
protected final Map getTxFactories() {
return storeTxFactories;
}
/**
* Checks if instance is not closed.
*
* @throws IllegalStateException If instance of this class was closed.
*
*/
protected final void checkNotClosed() {
Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
}
@Override
public void close() {
final boolean success = UPDATER.compareAndSet(this, 0, 1);
Preconditions.checkState(success, "Transaction factory was already closed");
}
}