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.mdsal.binding.api;
10 import org.opendaylight.mdsal.common.api.AsyncDataBroker;
11 import org.opendaylight.mdsal.common.api.TransactionChainFactory;
12 import org.opendaylight.mdsal.common.api.TransactionChainListener;
13 import org.opendaylight.yangtools.yang.binding.DataObject;
14 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
17 * Provides access to a conceptual data tree store and also provides the ability to
18 * subscribe for changes to data under a given branch of the tree.
21 * All operations on the data tree are performed via one of the transactions:
23 * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
24 * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
28 * These transactions provide a stable isolated view of data tree, which is guaranteed to be not
29 * affected by other concurrent transactions, until transaction is committed.
32 * For a detailed explanation of how transaction are isolated and how transaction-local changes are
33 * committed to global data tree, see {@link ReadTransaction}, {@link WriteTransaction}
34 * and {@link WriteTransaction#commit()}.
37 * It is strongly recommended to use the type of transaction, which provides only the minimal
38 * capabilities you need. This allows for optimizations at the data broker / data store level. For
39 * example, implementations may optimize the transaction for reading if they know ahead of time that
40 * you only need to read data - such as not keeping additional meta-data, which may be required for
44 * <b>Implementation Note:</b> This interface is not intended to be implemented by users of MD-SAL,
45 * but only to be consumed by them.
47 public interface DataBroker extends AsyncDataBroker<InstanceIdentifier<?>, DataObject>,
48 TransactionChainFactory<InstanceIdentifier<?>, DataObject>, TransactionFactory, BindingService,
49 DataTreeChangeService {
52 BindingTransactionChain createTransactionChain(TransactionChainListener listener);