+++ /dev/null
-/*
- * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.controller.sal.core.spi.data;
-
-import static com.google.common.base.Preconditions.checkState;
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.annotations.Beta;
-import com.google.common.base.MoreObjects.ToStringHelper;
-import com.google.common.base.Optional;
-import com.google.common.base.Throwables;
-import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
-import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Implementation of Write transaction which is backed by
- * {@link DataTreeSnapshot} and executed according to
- * {@link org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction.TransactionReadyPrototype}.
- *
- * @param <T> Identifier type
- * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction} instead.
- */
-@Deprecated(forRemoval = true)
-@Beta
-public class SnapshotBackedWriteTransaction<T> extends AbstractDOMStoreTransaction<T>
- implements DOMStoreWriteTransaction {
- private static final Logger LOG = LoggerFactory.getLogger(SnapshotBackedWriteTransaction.class);
- @SuppressWarnings("rawtypes")
- private static final AtomicReferenceFieldUpdater<SnapshotBackedWriteTransaction, TransactionReadyPrototype>
- READY_UPDATER = AtomicReferenceFieldUpdater.newUpdater(SnapshotBackedWriteTransaction.class,
- TransactionReadyPrototype.class, "readyImpl");
- @SuppressWarnings("rawtypes")
- private static final AtomicReferenceFieldUpdater<SnapshotBackedWriteTransaction, DataTreeModification>
- TREE_UPDATER = AtomicReferenceFieldUpdater.newUpdater(SnapshotBackedWriteTransaction.class,
- DataTreeModification.class, "mutableTree");
-
- // non-null when not ready
- private volatile TransactionReadyPrototype<T> readyImpl;
- // non-null when not committed/closed
- private volatile DataTreeModification mutableTree;
-
- SnapshotBackedWriteTransaction(final T identifier, final boolean debug,
- final DataTreeSnapshot snapshot, final TransactionReadyPrototype<T> readyImpl) {
- super(identifier, debug);
- this.readyImpl = requireNonNull(readyImpl, "readyImpl must not be null.");
- mutableTree = snapshot.newModification();
- LOG.debug("Write Tx: {} allocated with snapshot {}", identifier, snapshot);
- }
-
- @Override
- @SuppressWarnings("checkstyle:IllegalCatch")
- public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- checkNotReady();
-
- final DataTreeModification tree = mutableTree;
- LOG.debug("Tx: {} Write: {}:{}", getIdentifier(), path, data);
-
- try {
- tree.write(path, data);
- // FIXME: Add checked exception
- } catch (RuntimeException e) {
- LOG.error("Tx: {}, failed to write {}:{} in {}", getIdentifier(), path, data, tree, e);
- // Rethrow original ones if they are subclasses of RuntimeException
- // or Error
- Throwables.propagateIfPossible(e);
- // FIXME: Introduce proper checked exception
- throw new IllegalArgumentException("Illegal input data.", e);
- }
- }
-
- @Override
- @SuppressWarnings("checkstyle:IllegalCatch")
- public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- checkNotReady();
-
- final DataTreeModification tree = mutableTree;
- LOG.debug("Tx: {} Merge: {}:{}", getIdentifier(), path, data);
-
- try {
- tree.merge(path, data);
- // FIXME: Add checked exception
- } catch (RuntimeException e) {
- LOG.error("Tx: {}, failed to write {}:{} in {}", getIdentifier(), path, data, tree, e);
- // Rethrow original ones if they are subclasses of RuntimeException
- // or Error
- Throwables.propagateIfPossible(e);
- // FIXME: Introduce proper checked exception
- throw new IllegalArgumentException("Illegal input data.", e);
- }
- }
-
- @Override
- @SuppressWarnings("checkstyle:IllegalCatch")
- public void delete(final YangInstanceIdentifier path) {
- checkNotReady();
-
- final DataTreeModification tree = mutableTree;
- LOG.debug("Tx: {} Delete: {}", getIdentifier(), path);
-
- try {
- tree.delete(path);
- // FIXME: Add checked exception
- } catch (RuntimeException e) {
- LOG.error("Tx: {}, failed to delete {} in {}", getIdentifier(), path, tree, e);
- // Rethrow original ones if they are subclasses of RuntimeException
- // or Error
- Throwables.propagateIfPossible(e);
- // FIXME: Introduce proper checked exception
- throw new IllegalArgumentException("Illegal path to delete.", e);
- }
- }
-
- /**
- * Exposed for {@link SnapshotBackedReadWriteTransaction}'s sake only. The contract does
- * not allow data access after the transaction has been closed or readied.
- *
- * @param path Path to read
- * @return null if the the transaction has been closed;
- */
- final Optional<NormalizedNode<?, ?>> readSnapshotNode(final YangInstanceIdentifier path) {
- return readyImpl == null ? null : Optional.fromJavaUtil(mutableTree.readNode(path));
- }
-
- private void checkNotReady() {
- checkState(readyImpl != null, "Transaction %s is no longer open. No further modifications allowed.",
- getIdentifier());
- }
-
- @Override
- @SuppressWarnings("checkstyle:IllegalCatch")
- public DOMStoreThreePhaseCommitCohort ready() {
- @SuppressWarnings("unchecked")
- final TransactionReadyPrototype<T> wasReady = READY_UPDATER.getAndSet(this, null);
- checkState(wasReady != null, "Transaction %s is no longer open", getIdentifier());
-
- LOG.debug("Store transaction: {} : Ready", getIdentifier());
-
- final DataTreeModification tree = mutableTree;
- TREE_UPDATER.lazySet(this, null);
- try {
- tree.ready();
- return wasReady.transactionReady(this, tree, null);
- } catch (RuntimeException e) {
- LOG.debug("Store transaction: {}: unexpected failure when readying", getIdentifier(), e);
- return wasReady.transactionReady(this, tree, e);
- }
- }
-
- @Override
- public void close() {
- @SuppressWarnings("unchecked")
- final TransactionReadyPrototype<T> wasReady = READY_UPDATER.getAndSet(this, null);
- if (wasReady != null) {
- LOG.debug("Store transaction: {} : Closed", getIdentifier());
- TREE_UPDATER.lazySet(this, null);
- wasReady.transactionAborted(this);
- } else {
- LOG.debug("Store transaction: {} : Closed after submit", getIdentifier());
- }
- }
-
- @Override
- protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
- return toStringHelper.add("ready", readyImpl == null);
- }
-
- /**
- * This class is intended to be implemented by Transaction factories responsible for allocation of
- * {@link org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction} and
- * providing underlying logic for applying implementation.
- *
- * @param <T> identifier type
- */
- @Deprecated
- public abstract static class TransactionReadyPrototype<T> {
- /**
- * Called when a transaction is closed without being readied. This is not invoked for
- * transactions which are ready.
- *
- * @param tx Transaction which got aborted.
- */
- protected abstract void transactionAborted(SnapshotBackedWriteTransaction<T> tx);
-
- /**
- * Returns a commit coordinator associated with supplied transactions.
- *
- * <p>
- * This call must not fail.
- *
- * @param tx
- * Transaction on which ready was invoked.
- * @param tree
- * Modified data tree which has been constructed.
- * @param readyError
- * Any error that has already happened when readying.
- * @return DOMStoreThreePhaseCommitCohort associated with transaction
- */
- protected abstract DOMStoreThreePhaseCommitCohort transactionReady(SnapshotBackedWriteTransaction<T> tx,
- DataTreeModification tree,
- @Nullable Exception readyError);
- }
-}
Code Review / controller.git / blobdiff