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