dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataBroker.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.dom.api;
   9
  10 import org.opendaylight.mdsal.common.api.AsyncDataBroker;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  13
  14 /**
  15  * Data Broker which provides data transaction and data change listener functionality using {@link NormalizedNode}.
  16  *
  17  * <p>
  18  * All operations on the data tree are performed via one of the transactions:
  19  * <ul>
  20  * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
  21  * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
  22  * </ul>
  23  *
  24  * <p>
  25  * These transactions provide a stable isolated view of data tree, which is guaranteed to be not
  26  * affected by other concurrent transactions, until transaction is committed.
  27  *
  28  * <p>
  29  * For a detailed explanation of how transaction are isolated and how transaction-local changes are
  30  * committed to global data tree, see {@link DOMDataTreeReadTransaction}, {@link DOMDataTreeWriteTransaction}
  31  * and {@link DOMDataTreeWriteTransaction#commit()}.
  32  *
  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 DOMDataBroker extends
  46         AsyncDataBroker<YangInstanceIdentifier, NormalizedNode<?, ?>>, DOMTransactionFactory,
  47         DOMExtensibleService<DOMDataBroker, DOMDataBrokerExtension> {
  48     /**
  49      * Create a new transaction chain. The chain will be initialized to read from its backing datastore, with
  50      * no outstanding transaction. Listener will be registered to handle chain-level events.
  51      *
  52      * @param listener Transaction chain event listener
  53      * @return A new transaction chain.
  54      */
  55     DOMTransactionChain createTransactionChain(DOMTransactionChainListener listener);
  56 }