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

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