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.controller.sal.core.spi.data;
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.
22 * If previous write transaction was already commited to data store, new
23 * read-only transaction is same as obtained via {@link DOMStore#newReadOnlyTransaction()}
24 * and contains merged result of previous one and current state of data store.
26 * Otherwise read-only transaction presents isolated view as if previous read-write
27 * transaction was successful. State which was introduced by other transactions
28 * outside this transaction chain after creation of previous transaction is not visible.
30 * @return New transaction in the chain.
31 * @throws IllegalStateException
32 * if the previous transaction was not READY or CANCELLED, or
33 * if the chain has been closed.
36 DOMStoreReadTransaction newReadOnlyTransaction();
39 * Create a new read write transaction which will continue the chain. The
40 * previous read-write transaction has to be either COMMITED or CANCELLED.
42 * If previous write transaction was already commited to data store, new
43 * read-write transaction is same as obtained via {@link DOMStore#newReadWriteTransaction()}
44 * and contains merged result of previous one and current state of data store.
46 * Otherwise read-write transaction presents isolated view as if previous read-write
47 * transaction was successful. State which was introduced by other transactions
48 * outside this transaction chain after creation of previous transaction is not visible.
50 * @return New transaction in the chain.
51 * @throws IllegalStateException
52 * if the previous transaction was not READY or CANCELLED, or
53 * if the chain has been closed.
56 DOMStoreReadWriteTransaction newReadWriteTransaction();
59 * Create a new write-only transaction which will continue the chain. The
60 * previous read-write transaction has to be either READY or CANCELLED.
63 * @return New transaction in the chain.
64 * @throws IllegalStateException
65 * if the previous transaction was not READY or CANCELLED, or
66 * if the chain has been closed.
69 DOMStoreWriteTransaction newWriteOnlyTransaction();
72 * Closes Transaction Chain.
74 * Close method of transaction chain does not guarantee that
75 * last alocated transaction is ready or was submitted.
77 * @throws IllegalStateException If any of the outstanding created transactions was not canceled or ready.