Allow SnapshotBackedReadTransaction customization
[controller.git] / opendaylight / md-sal / sal-dom-spi / src / main / java / org / opendaylight / controller / sal / core / spi / data / SnapshotBackedReadWriteTransaction.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.controller.sal.core.spi.data;
9
10 import static com.google.common.base.Preconditions.checkNotNull;
11
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.Optional;
14 import com.google.common.util.concurrent.CheckedFuture;
15 import com.google.common.util.concurrent.Futures;
16 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
20 import org.slf4j.Logger;
21 import org.slf4j.LoggerFactory;
22
23 /**
24  * Implementation of Read-Write transaction which is backed by {@link DataTreeSnapshot}
25  * and executed according to {@link TransactionReadyPrototype}.
26  *
27  * @param <T> identifier type
28  */
29 @Beta
30 public final class SnapshotBackedReadWriteTransaction<T> extends SnapshotBackedWriteTransaction<T>
31         implements DOMStoreReadWriteTransaction {
32     private static final Logger LOG = LoggerFactory.getLogger(SnapshotBackedReadWriteTransaction.class);
33
34     SnapshotBackedReadWriteTransaction(final T identifier, final boolean debug,
35             final DataTreeSnapshot snapshot, final TransactionReadyPrototype<T> readyImpl) {
36         super(identifier, debug, snapshot, readyImpl);
37     }
38
39     @Override
40     @SuppressWarnings("checkstyle:IllegalCatch")
41     public CheckedFuture<Optional<NormalizedNode<?,?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
42         LOG.debug("Tx: {} Read: {}", getIdentifier(), path);
43         checkNotNull(path, "Path must not be null.");
44
45         final Optional<NormalizedNode<?, ?>> result;
46         try {
47             result = readSnapshotNode(path);
48         } catch (RuntimeException e) {
49             LOG.error("Tx: {} Failed Read of {}", getIdentifier(), path, e);
50             return Futures.immediateFailedCheckedFuture(new ReadFailedException("Read failed", e));
51         }
52
53         if (result == null) {
54             return Futures.immediateFailedCheckedFuture(new ReadFailedException("Transaction is closed"));
55         } else {
56             return Futures.immediateCheckedFuture(result);
57         }
58     }
59
60     @Override
61     public CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
62         try {
63             return Futures.immediateCheckedFuture(
64                 read(path).checkedGet().isPresent());
65         } catch (ReadFailedException e) {
66             return Futures.immediateFailedCheckedFuture(e);
67         }
68     }
69 }