2 * Copyright (c) 2015 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
9 package org.opendaylight.mdsal.dom.store.inmemory;
11 import static com.google.common.base.Preconditions.checkState;
12 import static java.util.Objects.requireNonNull;
14 import com.google.common.annotations.VisibleForTesting;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
18 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
19 import org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTransaction;
20 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
21 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction;
22 import org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException;
23 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
24 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
25 import org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
29 class InMemoryDOMStoreThreePhaseCommitCohort implements DOMStoreThreePhaseCommitCohort {
30 private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMStoreThreePhaseCommitCohort.class);
31 private static final ListenableFuture<Void> SUCCESSFUL_FUTURE = Futures.immediateFuture(null);
32 private static final ListenableFuture<Boolean> CAN_COMMIT_FUTURE = Futures.immediateFuture(Boolean.TRUE);
34 private final SnapshotBackedWriteTransaction<String> transaction;
35 private final DataTreeModification modification;
36 private final InMemoryDOMDataStore store;
37 private final Exception operationError;
40 DataTreeCandidate candidate;
42 InMemoryDOMStoreThreePhaseCommitCohort(final InMemoryDOMDataStore store,
43 final SnapshotBackedWriteTransaction<String> transaction, final DataTreeModification modification,
44 final Exception operationError) {
45 this.transaction = requireNonNull(transaction);
46 this.modification = requireNonNull(modification);
47 this.store = requireNonNull(store);
48 this.operationError = operationError;
51 private static void warnDebugContext(final AbstractDOMStoreTransaction<?> transaction) {
52 final Throwable ctx = transaction.getDebugContext();
54 LOG.warn("Transaction {} has been allocated in the following context", transaction.getIdentifier(), ctx);
58 @SuppressWarnings("checkstyle:IllegalCatch")
60 public final ListenableFuture<Boolean> canCommit() {
61 if (operationError != null) {
62 return Futures.immediateFailedFuture(operationError);
66 store.validate(modification);
67 LOG.debug("Store Transaction: {} can be committed", getTransaction().getIdentifier());
68 return CAN_COMMIT_FUTURE;
69 } catch (ConflictingModificationAppliedException e) {
70 LOG.warn("Store Tx: {} Conflicting modification for {}.", getTransaction().getIdentifier(),
72 warnDebugContext(getTransaction());
73 return Futures.immediateFailedFuture(new OptimisticLockFailedException("Optimistic lock failed.", e));
74 } catch (DataValidationFailedException e) {
75 LOG.warn("Store Tx: {} Data Precondition failed for {}.", getTransaction().getIdentifier(),
77 warnDebugContext(getTransaction());
79 // For debugging purposes, allow dumping of the modification. Coupled with the above
80 // precondition log, it should allow us to understand what went on.
81 LOG.trace("Store Tx: {} modifications: {} tree: {}", getTransaction().getIdentifier(),
84 return Futures.immediateFailedFuture(
85 new TransactionCommitFailedException("Data did not pass validation.", e));
86 } catch (Exception e) {
87 LOG.warn("Unexpected failure in validation phase", e);
88 return Futures.immediateFailedFuture(e);
92 @SuppressWarnings("checkstyle:IllegalCatch")
94 public final ListenableFuture<Void> preCommit() {
96 candidate = store.prepare(modification);
97 return SUCCESSFUL_FUTURE;
98 } catch (Exception e) {
99 LOG.warn("Unexpected failure in pre-commit phase", e);
100 return Futures.immediateFailedFuture(e);
105 public final ListenableFuture<Void> abort() {
107 return SUCCESSFUL_FUTURE;
110 protected final SnapshotBackedWriteTransaction<String> getTransaction() {
115 public ListenableFuture<Void> commit() {
116 checkState(candidate != null, "Proposed subtree must be computed");
119 * The commit has to occur atomically with regard to listener
122 store.commit(candidate);
123 return SUCCESSFUL_FUTURE;