2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.core.spi.data;
10 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
11 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
12 import org.opendaylight.yangtools.concepts.ListenerRegistration;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
20 * DOM Data Store provides transactional tree-like storage for YANG-modeled
21 * entities described by YANG schema and represented by {@link NormalizedNode}.
23 * Read and write access to stored data is provided only via transactions
24 * created using {@link #newReadOnlyTransaction()},
25 * {@link #newWriteOnlyTransaction()} and {@link #newReadWriteTransaction()}, or
26 * by creating {@link org.opendaylight.controller.md.sal.common.api.data.TransactionChain}.
29 public interface DOMStore extends DOMStoreTransactionFactory {
32 * Registers {@link org.opendaylight.controller.md.sal.common.api.data.DataChangeListener} for Data Change callbacks which will
33 * be triggered on the change of provided subpath. What constitutes a change
34 * depends on the @scope parameter.
36 * Listener upon registration receives an initial callback
37 * {@link AsyncDataChangeListener#onDataChanged(org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent)}
38 * which contains stable view of data tree at the time of registration.
40 * @param path Path (subtree identifier) on which client listener will be
44 * Instance of listener which should be invoked on
46 * Scope of change which triggers callback.
47 * @return Listener Registration object, which client may use to close
48 * registration / interest on receiving data changes.
51 <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
52 YangInstanceIdentifier path, L listener, DataChangeScope scope);
56 * Creates new transaction chain.
58 * Transactions in a chain need to be committed in sequence and each
59 * transaction should see the effects of previous transactions as if they
62 * See {@link DOMStoreTransactionChain} for more information.
64 * @return Newly created transaction chain.
66 DOMStoreTransactionChain createTransactionChain();