org.opendaylight.controller.cluster.databroker

Class ConcurrentDOMDataBroker

java.lang.Object

org.opendaylight.controller.cluster.databroker.AbstractDOMTransactionFactory<org.opendaylight.controller.sal.core.spi.data.DOMStore>

org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker

All Implemented Interfaces:

AutoCloseable, org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>,org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener>, org.opendaylight.controller.md.sal.common.api.data.AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, org.opendaylight.controller.md.sal.common.api.data.TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, org.opendaylight.controller.md.sal.dom.api.DOMDataBroker, org.opendaylight.controller.md.sal.dom.api.DOMExtensibleService<org.opendaylight.controller.md.sal.dom.api.DOMDataBroker,org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension>, org.opendaylight.controller.md.sal.dom.api.DOMService, org.opendaylight.controller.sal.core.api.BrokerService

@Beta
public class ConcurrentDOMDataBroker
extends AbstractDOMTransactionFactory<org.opendaylight.controller.sal.core.spi.data.DOMStore>

ConcurrentDOMDataBroker commits transactions concurrently. The 3 commit phases (canCommit, preCommit, and commit) are performed serially and non-blocking (ie async) per transaction but multiple transaction commits can run concurrent.

Author:

Thomas Pantelis

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker

org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope

Constructor Summary

Constructors

Constructor and Description
ConcurrentDOMDataBroker(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,org.opendaylight.controller.sal.core.spi.data.DOMStore> datastores, Executor listenableFutureExecutor)
ConcurrentDOMDataBroker(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,org.opendaylight.controller.sal.core.spi.data.DOMStore> datastores, Executor listenableFutureExecutor, org.opendaylight.yangtools.util.DurationStatisticsTracker commitStatsTracker)

Method Summary

Modifier and Type	Method and Description
void	close()
org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain	createTransactionChain(org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener listener)
org.opendaylight.yangtools.util.DurationStatisticsTracker	getCommitStatsTracker()
Map<Class<? extends org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension>,org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension>	getSupportedExtensions()
protected Object	newTransactionIdentifier() Implementations must return unique identifier for each and every call of this method.
org.opendaylight.yangtools.concepts.ListenerRegistration<org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener>	registerDataChangeListener(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener listener, org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope triggeringScope)
void	setCloseable(AutoCloseable closeable)
protected com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction transaction, Collection<org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort> cohorts) Submits a transaction asynchronously for commit.
String	toString()

Methods inherited from class org.opendaylight.controller.cluster.databroker.AbstractDOMTransactionFactory

checkNotClosed, getTxFactories, newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.controller.md.sal.dom.api.DOMDataBroker

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Constructor Detail

ConcurrentDOMDataBroker

public ConcurrentDOMDataBroker(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,org.opendaylight.controller.sal.core.spi.data.DOMStore> datastores,
                               Executor listenableFutureExecutor)

ConcurrentDOMDataBroker

public ConcurrentDOMDataBroker(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,org.opendaylight.controller.sal.core.spi.data.DOMStore> datastores,
                               Executor listenableFutureExecutor,
                               org.opendaylight.yangtools.util.DurationStatisticsTracker commitStatsTracker)

Method Detail

getCommitStatsTracker

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

submit

protected com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction transaction,
                                                                                                                                                           Collection<org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort> cohorts)

Description copied from class: AbstractDOMTransactionFactory

Submits a transaction asynchronously for commit.

Specified by:

submit in class AbstractDOMTransactionFactory<org.opendaylight.controller.sal.core.spi.data.DOMStore>

Parameters:

transaction - the transaction to submit

cohorts - the associated cohorts

Returns:

a resulting Future

toString

public String toString()

Overrides:

toString in class Object

setCloseable

public void setCloseable(AutoCloseable closeable)

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractDOMTransactionFactory<org.opendaylight.controller.sal.core.spi.data.DOMStore>

newTransactionIdentifier

protected Object newTransactionIdentifier()

Description copied from class: AbstractDOMTransactionFactory

Implementations must return unique identifier for each and every call of this method.

Specified by:

newTransactionIdentifier in class AbstractDOMTransactionFactory<org.opendaylight.controller.sal.core.spi.data.DOMStore>

Returns:

new Unique transaction identifier.

registerDataChangeListener

public org.opendaylight.yangtools.concepts.ListenerRegistration<org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener> registerDataChangeListener(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store,
                                                                                                                                                             org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                                                                                                             org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener listener,
                                                                                                                                                             org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope triggeringScope)

Specified by:

registerDataChangeListener in interface org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>,org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener>

getSupportedExtensions

public Map<Class<? extends org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension>,org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension> getSupportedExtensions()

Specified by:

getSupportedExtensions in interface org.opendaylight.controller.md.sal.dom.api.DOMExtensibleService<org.opendaylight.controller.md.sal.dom.api.DOMDataBroker,org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension>

createTransactionChain

public org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain createTransactionChain(org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener listener)

Specified by:

createTransactionChain in interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

createTransactionChain in interface org.opendaylight.controller.md.sal.dom.api.DOMDataBroker