efeab63ea2f2ec7d134c1d45864e374f86ad154c
[mdsal.git] / dom / mdsal-dom-broker / src / main / java / org / opendaylight / mdsal / dom / broker / DOMForwardedReadWriteTransaction.java
1 /*
2  * Copyright (c) 2017 Brocade Communications 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.broker;
9
10 import com.google.common.base.Optional;
11 import com.google.common.util.concurrent.CheckedFuture;
12 import java.util.Map;
13 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
14 import org.opendaylight.mdsal.common.api.ReadFailedException;
15 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
16 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
19
20 /**
21  * Read-Write Transaction, which is composed of several
22  * {@link DOMStoreReadWriteTransaction} transactions. Subtransaction is selected by
23  * {@link LogicalDatastoreType} type parameter in:
24  *
25  * <ul>
26  * <li>{@link #read(LogicalDatastoreType, YangInstanceIdentifier)}
27  * <li>{@link #put(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
28  * <li>{@link #delete(LogicalDatastoreType, YangInstanceIdentifier)}
29  * <li>{@link #merge(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode)}
30  * </ul>
31  *
32  * <p>
33  * {@link #submit()} will result in invocation of
34  * {@link DOMDataCommitImplementation#submit(org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction, Iterable)}
35  * invocation with all
36  * {@link org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort} for
37  * underlying transactions.
38  */
39 final class DOMForwardedReadWriteTransaction extends DOMForwardedWriteTransaction<DOMStoreReadWriteTransaction>
40         implements DOMDataTreeReadWriteTransaction {
41
42     protected DOMForwardedReadWriteTransaction(final Object identifier,
43             final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> backingTxs,
44             final AbstractDOMForwardedTransactionFactory<?> commitImpl) {
45         super(identifier, backingTxs, commitImpl);
46     }
47
48     @Override
49     public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final LogicalDatastoreType store,
50             final YangInstanceIdentifier path) {
51         return getSubtransaction(store).read(path);
52     }
53
54     @Override
55     public CheckedFuture<Boolean, ReadFailedException> exists(final LogicalDatastoreType store,
56             final YangInstanceIdentifier path) {
57         return getSubtransaction(store).exists(path);
58     }
59
60     @Override
61     public void close() {
62         closeSubtransactions();
63     }
64 }