org.opendaylight.controller.sal.core.spi.data

Interface DOMStore

All Superinterfaces:

DOMStoreTransactionFactory

public interface DOMStore
extends DOMStoreTransactionFactory

DOM Data Store

DOM Data Store provides transactional tree-like storage for YANG-modeled entities described by YANG schema and represented by NormalizedNode. Read and write access to stored data is provided only via transactions created using DOMStoreTransactionFactory.newReadOnlyTransaction(), DOMStoreTransactionFactory.newWriteOnlyTransaction() and DOMStoreTransactionFactory.newReadWriteTransaction(), or by creating TransactionChain.

Method Summary

Methods

Modifier and Type	Method and Description
DOMStoreTransactionChain	createTransactionChain() Creates new transaction chain.
<L extends org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, L listener, org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope scope) Registers DataChangeListener for Data Change callbacks which will be triggered on the change of provided subpath.

Methods inherited from interface org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Method Detail

registerChangeListener

<L extends org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                                                                                                                                                                                                                                                             L listener,
                                                                                                                                                                                                                                                                                                             org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope scope)

Registers DataChangeListener for Data Change callbacks which will be triggered on the change of provided subpath. What constitutes a change depends on the @scope parameter. Listener upon registration receives an initial callback AsyncDataChangeListener.onDataChanged(org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent) which contains stable view of data tree at the time of registration. @param path Path (subtree identifier) on which client listener will be invoked.

Parameters:

listener - Instance of listener which should be invoked on

scope - Scope of change which triggers callback.

Returns:

Listener Registration object, which client may use to close registration / interest on receiving data changes.

createTransactionChain

DOMStoreTransactionChain createTransactionChain()

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.

Returns:

Newly created transaction chain.