org.opendaylight.mdsal.dom.store.inmemory

Class InMemoryDOMDataStore

java.lang.Object

org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction.TransactionReadyPrototype<String>

org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStore

All Implemented Interfaces:

AutoCloseable, EventListener, DOMStore, DOMStoreTransactionFactory, DOMStoreTreeChangePublisher, org.opendaylight.yangtools.concepts.Identifiable<String>, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

public class InMemoryDOMDataStore
extends SnapshotBackedWriteTransaction.TransactionReadyPrototype<String>
implements DOMStore, org.opendaylight.yangtools.concepts.Identifiable<String>, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, AutoCloseable, DOMStoreTreeChangePublisher

In-memory DOM Data Store.

Implementation of DOMStore which uses DataTree and other classes such as SnapshotBackedWriteTransaction. SnapshotBackedReadTransaction to implement DOMStore contract.

Constructor Summary

Constructors

Constructor and Description
InMemoryDOMDataStore(String name, org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration config, ExecutorService dataChangeListenerExecutor, int maxDataChangeListenerQueueSize, boolean debugTransactions)
InMemoryDOMDataStore(String name, ExecutorService dataChangeListenerExecutor)
InMemoryDOMDataStore(String name, ExecutorService dataChangeListenerExecutor, int maxDataChangeListenerQueueSize, boolean debugTransactions)
InMemoryDOMDataStore(String name, LogicalDatastoreType type, ExecutorService dataChangeListenerExecutor, int maxDataChangeListenerQueueSize, boolean debugTransactions)

Method Summary

Modifier and Type	Method and Description
void	close()
DOMStoreTransactionChain	createTransactionChain() Creates new transaction chain.
org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager<?,?>	getDataChangeListenerNotificationManager()
boolean	getDebugTransactions()
String	getIdentifier()
DOMStoreReadTransaction	newReadOnlyTransaction() Creates a read only transaction.
DOMStoreReadWriteTransaction	newReadWriteTransaction() Creates Read-Write transaction.
DOMStoreWriteTransaction	newWriteOnlyTransaction() Creates write only transaction.
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)
<L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId, L listener) Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.
void	setCloseable(AutoCloseable closeable)
protected void	transactionAborted(SnapshotBackedWriteTransaction<String> tx) Called when a transaction is closed without being readied.
protected DOMStoreThreePhaseCommitCohort	transactionReady(SnapshotBackedWriteTransaction<String> tx, org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification modification, Exception readyError) Returns a commit coordinator associated with supplied transactions.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryDOMDataStore

public InMemoryDOMDataStore(String name,
                            ExecutorService dataChangeListenerExecutor)

InMemoryDOMDataStore

public InMemoryDOMDataStore(String name,
                            ExecutorService dataChangeListenerExecutor,
                            int maxDataChangeListenerQueueSize,
                            boolean debugTransactions)

InMemoryDOMDataStore

public InMemoryDOMDataStore(String name,
                            LogicalDatastoreType type,
                            ExecutorService dataChangeListenerExecutor,
                            int maxDataChangeListenerQueueSize,
                            boolean debugTransactions)

InMemoryDOMDataStore

public InMemoryDOMDataStore(String name,
                            org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration config,
                            ExecutorService dataChangeListenerExecutor,
                            int maxDataChangeListenerQueueSize,
                            boolean debugTransactions)

Method Detail

getDataChangeListenerNotificationManager

public org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager<?,?> getDataChangeListenerNotificationManager()

setCloseable

public void setCloseable(AutoCloseable closeable)

getIdentifier

public final String getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<String>

newReadOnlyTransaction

public DOMStoreReadTransaction newReadOnlyTransaction()

Description copied from interface: DOMStoreTransactionFactory

Creates a read only transaction.

Creates a new read-only transaction, which provides read access to snapshot of current state.

See DOMStoreReadTransaction for more information.

Specified by:

newReadOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

new DOMStoreReadTransaction

newReadWriteTransaction

public DOMStoreReadWriteTransaction newReadWriteTransaction()

Description copied from interface: DOMStoreTransactionFactory

Creates Read-Write transaction.

See DOMStoreReadWriteTransaction for more information.

Specified by:

newReadWriteTransaction in interface DOMStoreTransactionFactory

Returns:

new DOMStoreWriteTransaction

newWriteOnlyTransaction

public DOMStoreWriteTransaction newWriteOnlyTransaction()

Description copied from interface: DOMStoreTransactionFactory

Creates write only transaction.

See DOMStoreWriteTransaction for more information.

Specified by:

newWriteOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

new DOMStoreWriteTransaction

createTransactionChain

public DOMStoreTransactionChain createTransactionChain()

Description copied from interface: DOMStore

Creates new transaction chain.

Transactions in a chain need to be committed in sequence and each transaction should see the effects of previous transactions as if they happened.

See DOMStoreTransactionChain for more information.

Specified by:

createTransactionChain in interface DOMStore

Returns:

Newly created transaction chain.

onGlobalContextUpdated

public void onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx)

Specified by:

onGlobalContextUpdated in interface org.opendaylight.yangtools.yang.model.api.SchemaContextListener

close

public void close()

Specified by:

close in interface AutoCloseable

getDebugTransactions

public final boolean getDebugTransactions()

registerTreeChangeListener

public <L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId,
                                                                                                                                    L listener)

Description copied from interface: DOMStoreTreeChangePublisher

Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.

You are able to register for notifications for any node or subtree which can be represented using YangInstanceIdentifier.

You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.

If there is any pre-existing data in data tree on path for which you are registering, you will receive initial data change event, which will contain all pre-existing data, marked as created. If the data at the supplied path does not exist, you will also receive initial data change event, which will contain empty data tree modification, marked as unmodified.

This method returns a ListenerRegistration object. To "unregister" your listener for changes call the ListenerRegistration.close() method on this returned object.

You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.

Specified by:

registerTreeChangeListener in interface DOMStoreTreeChangePublisher

Parameters:

treeId - Data tree identifier of the subtree which should be watched for changes.

listener - Listener instance which is being registered

Returns:

Listener registration object, which may be used to unregister your listener using ListenerRegistration.close() to stop delivery of change events.

transactionAborted

protected void transactionAborted(SnapshotBackedWriteTransaction<String> tx)

Description copied from class: SnapshotBackedWriteTransaction.TransactionReadyPrototype

Called when a transaction is closed without being readied. This is not invoked for transactions which are ready.

Specified by:

transactionAborted in class SnapshotBackedWriteTransaction.TransactionReadyPrototype<String>

Parameters:

tx - Transaction which got aborted.

transactionReady

protected DOMStoreThreePhaseCommitCohort transactionReady(SnapshotBackedWriteTransaction<String> tx,
                                                          org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification modification,
                                                          Exception readyError)

Description copied from class: SnapshotBackedWriteTransaction.TransactionReadyPrototype

Returns a commit coordinator associated with supplied transactions. This call must not fail.

Specified by:

transactionReady in class SnapshotBackedWriteTransaction.TransactionReadyPrototype<String>

Parameters:

tx - Transaction on which ready was invoked.

modification - Modified data tree which has been constructed.

readyError - Any error that has already happened when readying.

Returns:

DOMStoreThreePhaseCommitCohort associated with transaction