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.eclipse.jdt.annotation.NonNull;
  11
  12 /**
  13  * Provides access to a conceptual data tree store and also provides the ability to
  14  * subscribe for changes to data under a given branch of the tree.
  15  *
  16  * <p>
  17  * All operations on the data tree are performed via one of the transactions:
  18  * <ul>
  19  * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
  20  * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
  21  * </ul>
  22  *
  23  * <p>
  24  * These transactions provide a stable isolated view of data tree, which is guaranteed to be not
  25  * affected by other concurrent transactions, until transaction is committed.
  26  *
  27  * <p>
  28  * For a detailed explanation of how transaction are isolated and how transaction-local changes are
  29  * committed to global data tree, see {@link ReadTransaction}, {@link WriteTransaction}
  30  * and {@link WriteTransaction#commit()}.
  31  *
  32  * <p>
  33  * It is strongly recommended to use the type of transaction, which provides only the minimal
  34  * capabilities you need. This allows for optimizations at the data broker / data store level. For
  35  * example, implementations may optimize the transaction for reading if they know ahead of time that
  36  * you only need to read data - such as not keeping additional meta-data, which may be required for
  37  * write transactions.
  38  *
  39  * <p>
  40  * <b>Implementation Note:</b> This interface is not intended to be implemented by users of MD-SAL,
  41  * but only to be consumed by them.
  42  */
  43 public interface DataBroker extends BindingService, TransactionFactory, DataTreeChangeService {
  44     /**
  45      * Create a new transaction chain. The chain will be initialized to read from its backing datastore, with
  46      * no outstanding transaction. Listener will be registered to handle chain-level events.
  47      *
  48      * @param listener Transaction chain event listener
  49      * @return A new transaction chain.
  50      */
  51     @NonNull TransactionChain createTransactionChain(@NonNull TransactionChainListener listener);
  52
  53     /**
  54      * Create a new transaction chain. The chain will be initialized to read from its backing datastore, with
  55      * no outstanding transaction. Listener will be registered to handle chain-level events.
  56      *
  57      * <p>
  58      * Unlike {@link #createTransactionChain(TransactionChainListener)}, the transaction chain returned by this
  59      * method is allowed to merge individual transactions into larger chunks. When transactions are merged, the results
  60      * must be indistinguishable from the result of all operations having been performed on a single transaction.
  61      *
  62      * <p>
  63      * When transactions are merged, {@link TransactionChain#newReadOnlyTransaction()} may actually be backed by
  64      * a read-write transaction, hence an additional restriction on API use is that multiple read-only transactions
  65      * may not be open at the same time.
  66      *
  67      * @param listener Transaction chain event listener
  68      * @return A new transaction chain.
  69      */
  70     @NonNull TransactionChain createMergingTransactionChain(@NonNull TransactionChainListener listener);
  71 }