org.opendaylight.mdsal.dom.broker

Class SerializedDOMDataBroker

java.lang.Object

org.opendaylight.mdsal.dom.broker.AbstractDOMDataBroker

org.opendaylight.mdsal.dom.broker.SerializedDOMDataBroker

All Implemented Interfaces:

AutoCloseable, DOMDataBroker, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, DOMService, DOMTransactionFactory

public class SerializedDOMDataBroker
extends AbstractDOMDataBroker

Implementation of blocking three phase commit coordinator, which which supports coordination on multiple DOMStoreThreePhaseCommitCohort.

This implementation does not support cancellation of commit,

In order to advance to next phase of three phase commit all subtasks of previous step must be finish.

This executor does not have an upper bound on subtask timeout.

Constructor Summary

Constructors

Constructor and Description
SerializedDOMDataBroker(Map<LogicalDatastoreType,DOMStore> datastores, com.google.common.util.concurrent.ListeningExecutorService executor) Construct DOMDataCommitCoordinator which uses supplied executor to process commit coordinations.

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed() Checks if instance is not closed.
protected com.google.common.util.concurrent.FluentFuture<? extends CommitInfo>	commit(DOMDataTreeWriteTransaction transaction, Collection<DOMStoreThreePhaseCommitCohort> cohorts) User-supplied implementation of DOMDataTreeWriteTransaction.commit() for transaction.
org.opendaylight.yangtools.util.DurationStatisticsTracker	getCommitStatsTracker()
protected Map<LogicalDatastoreType,T>	getTxFactories() Convenience accessor of backing factories intended to be used only by finalization of this class.
DOMDataTreeReadTransaction	newReadOnlyTransaction() Creates a new composite read-only transaction.
DOMDataTreeReadWriteTransaction	newReadWriteTransaction() Creates a new composite read-write transaction.
DOMDataTreeWriteTransaction	newWriteOnlyTransaction() Creates a new composite write-only transaction

Methods inherited from class org.opendaylight.mdsal.dom.broker.AbstractDOMDataBroker

close, createTransactionChain, getExtensions, newTransactionIdentifier, setCloseable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMTransactionFactory

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Constructor Detail

SerializedDOMDataBroker

public SerializedDOMDataBroker(Map<LogicalDatastoreType,DOMStore> datastores,
                               com.google.common.util.concurrent.ListeningExecutorService executor)

Construct DOMDataCommitCoordinator which uses supplied executor to process commit coordinations.

Parameters:

datastores - the Map of backing DOMStore instances

executor - the ListeningExecutorService to use

Method Detail

getCommitStatsTracker

public org.opendaylight.yangtools.util.DurationStatisticsTracker getCommitStatsTracker()

commit

protected com.google.common.util.concurrent.FluentFuture<? extends CommitInfo> commit(DOMDataTreeWriteTransaction transaction,
                                                                                      Collection<DOMStoreThreePhaseCommitCohort> cohorts)

User-supplied implementation of DOMDataTreeWriteTransaction.commit() for transaction.

Callback invoked when DOMDataTreeWriteTransaction.commit() is invoked on transaction created by this factory.

Parameters:

transaction - Transaction on which DOMDataTreeWriteTransaction.commit() was invoked.

cohorts - Iteratable of cohorts for subtransactions associated with the transaction being committed.

Returns:

a FluentFuture. if commit coordination on cohorts finished successfully, a CommitInfo is returned from the Future, On failure, the Future fails with a TransactionCommitFailedException.

newReadOnlyTransaction

public final DOMDataTreeReadTransaction newReadOnlyTransaction()

Creates a new composite read-only transaction.

Creates a new composite read-only transaction backed by one transaction per factory in getTxFactories().

Subtransaction for reading is selected by supplied LogicalDatastoreType as parameter for DOMDataTreeReadOperations.read(LogicalDatastoreType, YangInstanceIdentifier)

Id of returned transaction is retrieved via newTransactionIdentifier().

Returns:

New composite read-only transaction.

newWriteOnlyTransaction

public final DOMDataTreeWriteTransaction newWriteOnlyTransaction()

Creates a new composite write-only transaction

Creates a new composite write-only transaction backed by one write-only transaction per factory in getTxFactories().

Implementation of composite Write-only transaction is following:

• DOMDataTreeWriteOperations.put(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.write(YangInstanceIdentifier, NormalizedNode) is invoked on selected subtransaction.
• DOMDataTreeWriteOperations.merge(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.merge(YangInstanceIdentifier, NormalizedNode) is invoked on selected subtransaction.
• DOMDataTreeWriteOperations.delete(LogicalDatastoreType, YangInstanceIdentifier) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.delete(YangInstanceIdentifier) is invoked on selected subtransaction.
• DOMDataTreeWriteTransaction.commit() - results in invoking DOMStoreWriteTransaction.ready(), gathering all resulting cohorts and then invoking finalized implementation callback commit(DOMDataTreeWriteTransaction, Collection) with transaction which was committed and gathered results.

Id of returned transaction is generated via newTransactionIdentifier().

Returns:

New composite write-only transaction associated with this factory.

newReadWriteTransaction

public final DOMDataTreeReadWriteTransaction newReadWriteTransaction()

Creates a new composite read-write transaction.

Returns:

New composite read-write transaction associated with this factory.

getTxFactories

protected final Map<LogicalDatastoreType,T> getTxFactories()

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.

Returns:

Map of backing transaction factories.

checkNotClosed

protected final void checkNotClosed()

Checks if instance is not closed.

Throws:

IllegalStateException - If instance of this class was closed.