opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.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.base.Preconditions;
  15 import com.google.common.util.concurrent.CheckedFuture;
  16 import com.google.common.util.concurrent.Futures;
  17 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  21 import org.slf4j.Logger;
  22 import org.slf4j.LoggerFactory;
  23
  24 /**
  25  *
  26  * Implementation of read-only transaction backed by {@link DataTreeSnapshot}
  27  *
  28  * Implementation of read-only transaction backed by {@link DataTreeSnapshot}
  29  * which delegates most of its calls to similar methods provided by underlying snapshot.
  30  *
  31  * @param <T> identifier type
  32  */
  33 @Beta
  34 public final class SnapshotBackedReadTransaction<T> extends AbstractDOMStoreTransaction<T> implements DOMStoreReadTransaction {
  35     private static final Logger LOG = LoggerFactory.getLogger(SnapshotBackedReadTransaction.class);
  36     private volatile DataTreeSnapshot stableSnapshot;
  37
  38     /**
  39      * Creates a new read-only transaction.
  40      *
  41      * @param identifier Transaction Identifier
  42      * @param debug Enable transaction debugging
  43      * @param snapshot Snapshot which will be modified.
  44      */
  45     SnapshotBackedReadTransaction(final T identifier, final boolean debug, final DataTreeSnapshot snapshot) {
  46         super(identifier, debug);
  47         this.stableSnapshot = Preconditions.checkNotNull(snapshot);
  48         LOG.debug("ReadOnly Tx: {} allocated with snapshot {}", identifier, snapshot);
  49     }
  50
  51     @Override
  52     public void close() {
  53         LOG.debug("Store transaction: {} : Closed", getIdentifier());
  54         stableSnapshot = null;
  55     }
  56
  57     @Override
  58     public CheckedFuture<Optional<NormalizedNode<?,?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
  59         LOG.debug("Tx: {} Read: {}", getIdentifier(), path);
  60         checkNotNull(path, "Path must not be null.");
  61
  62         final DataTreeSnapshot snapshot = stableSnapshot;
  63         if (snapshot == null) {
  64             return Futures.immediateFailedCheckedFuture(new ReadFailedException("Transaction is closed"));
  65         }
  66
  67         try {
  68             return Futures.immediateCheckedFuture(Optional.fromJavaUtil(snapshot.readNode(path)));
  69         } catch (Exception e) {
  70             LOG.error("Tx: {} Failed Read of {}", getIdentifier(), path, e);
  71             return Futures.immediateFailedCheckedFuture(new ReadFailedException("Read failed",e));
  72         }
  73     }
  74
  75     @Override
  76     public CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
  77         LOG.debug("Tx: {} Exists: {}", getIdentifier(), path);
  78         checkNotNull(path, "Path must not be null.");
  79
  80         try {
  81             return Futures.immediateCheckedFuture(read(path).checkedGet().isPresent());
  82         } catch (ReadFailedException e) {
  83             return Futures.immediateFailedCheckedFuture(e);
  84         }
  85     }
  86 }