binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataBroker.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.api;
   9
  10 import org.opendaylight.mdsal.common.api.AsyncDataBroker;
  11 import org.opendaylight.yangtools.yang.binding.DataObject;
  12 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  13
  14 /**
  15  * Provides access to a conceptual data tree store and also provides the ability to
  16  * subscribe for changes to data under a given branch of the tree.
  17  *
  18  * <p>
  19  * All operations on the data tree are performed via one of the transactions:
  20  * <ul>
  21  * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
  22  * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
  23  * </ul>
  24  *
  25  * <p>
  26  * These transactions provide a stable isolated view of data tree, which is guaranteed to be not
  27  * affected by other concurrent transactions, until transaction is committed.
  28  *
  29  * <p>
  30  * For a detailed explanation of how transaction are isolated and how transaction-local changes are
  31  * committed to global data tree, see {@link ReadTransaction}, {@link WriteTransaction}
  32  * and {@link WriteTransaction#commit()}.
  33  *
  34  * <p>
  35  * It is strongly recommended to use the type of transaction, which provides only the minimal
  36  * capabilities you need. This allows for optimizations at the data broker / data store level. For
  37  * example, implementations may optimize the transaction for reading if they know ahead of time that
  38  * you only need to read data - such as not keeping additional meta-data, which may be required for
  39  * write transactions.
  40  *
  41  * <p>
  42  * <b>Implementation Note:</b> This interface is not intended to be implemented by users of MD-SAL,
  43  * but only to be consumed by them.
  44  */
  45 public interface DataBroker extends AsyncDataBroker<InstanceIdentifier<?>, DataObject>, TransactionFactory,
  46         BindingService, DataTreeChangeService {
  47     /**
  48      * Create a new transaction chain. The chain will be initialized to read from its backing datastore, with
  49      * no outstanding transaction. Listener will be registered to handle chain-level events.
  50      *
  51      * @param listener Transaction chain event listener
  52      * @return A new transaction chain.
  53      */
  54     TransactionChain createTransactionChain(TransactionChainListener listener);
  55 }