/* * 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 static com.google.common.base.Preconditions.checkState; import static java.util.Objects.requireNonNull; import com.google.common.util.concurrent.FluentFuture; import java.lang.invoke.MethodHandles; import java.lang.invoke.VarHandle; import java.util.EnumMap; import java.util.Map; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.mdsal.common.api.CommitInfo; 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.DOMDataTreeReadWriteTransaction; import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction; import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort; import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory; import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Abstract composite transaction factory. * *
* Provides a 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
* Callback invoked when {@link DOMDataTreeWriteTransaction#commit()} is invoked on transaction created by this
* factory.
*
* @param transaction Transaction on which {@link DOMDataTreeWriteTransaction#commit()} was invoked.
* @param cohort Subtransactions associated with the transaction being committed.
* @return a FluentFuture. if commit coordination on cohorts finished successfully, a CommitInfo is returned from
* the Future, On failure, the Future fails with a {@link TransactionCommitFailedException}.
*/
protected abstract FluentFuture extends CommitInfo> commit(DOMDataTreeWriteTransaction transaction,
DOMStoreThreePhaseCommitCohort cohort);
/**
* Creates a new forwarded read-only transaction.
*
*
* Creates a new read-only transaction backed by single read-only sub-transaction.
* Target datastore is determined dynamically on first usage.
*
*
* Sub-transaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter for
* {@link DOMDataTreeReadTransaction#read(LogicalDatastoreType, YangInstanceIdentifier)}
*
*
* Identifier of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
*
* @return New composite read-only transaction.
*/
public final DOMDataTreeReadTransaction newReadOnlyTransaction() {
checkNotClosed();
return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(),
storeType -> requireTxFactory(storeType).newReadOnlyTransaction());
}
/**
* Creates a new forwarded write-only transaction
*
*
* Creates a new write-only transaction backed by single write-only sub-transaction.
* Target datastore is determined dynamically on first usage.
*
*
* Implementation of composite Write-only transaction is following:
*
*
* Identifier of returned transaction is generated via {@link #newTransactionIdentifier()}.
*
* @return New composite write-only transaction associated with this factory.
*/
public final DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
checkNotClosed();
return new DOMForwardedWriteTransaction<>(newTransactionIdentifier(),
storeType -> requireTxFactory(storeType).newWriteOnlyTransaction(), this);
}
/**
* Creates a new forwarded read-write transaction.
*
* @return New forwarded read-write transaction associated with this factory.
*/
public final DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
checkNotClosed();
return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(),
storeType -> requireTxFactory(storeType).newReadWriteTransaction(), 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
*
*
*