binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/TransactionFactory.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  * A factory which allocates new transactions to operate on the data tree.
  14  *
  15  * <p>
  16  * <b>Note:</b> This interface is not intended to be used directly, but rather via subinterfaces
  17  * which introduces additional semantics to allocated transactions.
  18  * <ul>
  19  * <li> {@link DataBroker}
  20  * <li> {@link TransactionChain}
  21  * </ul>
  22  *
  23  * <p>
  24  * All operations on the data tree are performed via one of the transactions:
  25  * <ul>
  26  * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
  27  * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
  28  * </ul>
  29  *
  30  * <p>
  31  * These transactions provides a stable isolated view of the data tree, which is guaranteed to be
  32  * not affected by other concurrent transactions, until transaction is committed.
  33  *
  34  * <p>
  35  * For a detailed explanation of how transaction are isolated and how transaction-local changes are
  36  * committed to global data tree, see {@link ReadTransaction}, {@link WriteTransaction}
  37  * and {@link WriteTransaction#commit()}.
  38  *
  39  * <p>
  40  * It is strongly recommended to use the type of transaction, which provides only the minimal
  41  * capabilities you need. This allows for optimizations at the data broker / data store level. For
  42  * example, implementations may optimize the transaction for reading if they know ahead of time that
  43  * you only need to read data - such as not keeping additional meta-data, which may be required for
  44  * write transactions.
  45  *
  46  * <p>
  47  * <b>Implementation Note:</b> This interface is not intended to be implemented by users of MD-SAL,
  48  * but only to be consumed by them.
  49  *
  50  * @see DataBroker
  51 */
  52 public interface TransactionFactory {
  53     /**
  54      * Allocates a new read-only transaction which provides an immutable snapshot of the data tree. The view of data
  55      * tree is an immutable snapshot of current data tree state when transaction was allocated.
  56      *
  57      * @return A new read-only transaction
  58      */
  59     @NonNull ReadTransaction newReadOnlyTransaction();
  60
  61     /**
  62      * Allocates new read-write transaction which provides a mutable view of the data tree.
  63      *
  64      * <p>
  65      * Preconditions for mutation of data tree are captured from the snapshot of data tree state, when the transaction
  66      * is allocated. If data was changed during transaction in an incompatible way then the commit of this transaction
  67      * will fail. See {@link ReadWriteTransaction#commit()} for more details about conflicting and non-conflicting
  68      * changes and failure scenarios.
  69      *
  70      * @return new read-write transaction
  71      */
  72     @NonNull ReadWriteTransaction newReadWriteTransaction();
  73
  74     /**
  75      * Allocates new write-only transaction based on latest state of data tree.
  76      *
  77      * <p>
  78      * Preconditions for mutation of data tree are captured from the snapshot of data tree state, when the transaction
  79      * is allocated. If data was changed during transaction in an incompatible way then the commit of this transaction
  80      * will fail. See {@link WriteTransaction#commit()} for more details about conflicting and not-conflicting changes
  81      * and failure scenarios.
  82      *
  83      * <p>
  84      * Since this transaction does not provide a view of the data it SHOULD BE used only by callers who are exclusive
  85      * writers (exporters of data) to the subtree they modify. This prevents optimistic lock failures as described in
  86      * {@link WriteTransaction#commit()}.
  87      *
  88      * <p>
  89      * Exclusivity of writers to particular subtree SHOULD BE enforced by external locking mechanism.
  90      *
  91      * @return new write-only transaction
  92      */
  93     @NonNull WriteTransaction newWriteOnlyTransaction();
  94 }