2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.spi.store;
11 * A chain of transactions. Transactions in a chain need to be committed in
12 * sequence and each transaction must see the effects of previous transactions
13 * as if they happened. A chain makes no guarantees of atomicity, in fact
14 * transactions are committed as soon as possible.
16 public interface DOMStoreTransactionChain extends DOMStoreTransactionFactory, AutoCloseable {
19 * Create a new read only transaction which will continue the chain. The
20 * previous write transaction has to be either READY or CANCELLED.
21 * If previous write transaction was already commited to data store, new
22 * read-only transaction is same as obtained via {@link DOMStore#newReadOnlyTransaction()}
23 * and contains merged result of previous one and current state of data store.
24 * Otherwise read-only transaction presents isolated view as if previous read-write
25 * transaction was successful. State which was introduced by other transactions
26 * outside this transaction chain after creation of previous transaction is not visible.
27 * @return New transaction in the chain.
28 * @throws IllegalStateException
29 * if the previous transaction was not READY or CANCELLED, or
30 * if the chain has been closed.
33 DOMStoreReadTransaction newReadOnlyTransaction();
36 * Create a new read write transaction which will continue the chain. The
37 * previous read-write transaction has to be either COMMITED or CANCELLED.
40 * If previous write transaction was already commited to data store, new
41 * read-write transaction is same as obtained via {@link DOMStore#newReadWriteTransaction()}
42 * and contains merged result of previous one and current state of data store.
45 * Otherwise read-write transaction presents isolated view as if previous read-write
46 * transaction was successful. State which was introduced by other transactions
47 * outside this transaction chain after creation of previous transaction is not visible.
49 * @return New transaction in the chain.
50 * @throws IllegalStateException
51 * if the previous transaction was not READY or CANCELLED, or
52 * if the chain has been closed.
55 DOMStoreReadWriteTransaction newReadWriteTransaction();
58 * Create a new write-only transaction which will continue the chain. The
59 * previous read-write transaction has to be either READY or CANCELLED.
61 * @return New transaction in the chain.
62 * @throws IllegalStateException
63 * if the previous transaction was not READY or CANCELLED, or
64 * if the chain has been closed.
67 DOMStoreWriteTransaction newWriteOnlyTransaction();
70 * Closes Transaction Chain.
73 * Close method of transaction chain does not guarantee that
74 * last alocated transaction is ready or was submitted.
76 * @throws IllegalStateException If any of the outstanding created transactions was not canceled or ready.