org.opendaylight.controller.cluster.datastore.AbstractShardDataTreeTransaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation
Controller documentation
There is a newer version: 10.0.4
/*
 * Copyright (c) 2015 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.cluster.datastore;

import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;

import com.google.common.base.MoreObjects;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.controller.cluster.datastore.persisted.AbortTransactionPayload;
import org.opendaylight.yangtools.concepts.Identifiable;
import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;

/**
 * Abstract base for transactions running on SharrdDataTree. This class is NOT thread-safe.
 *
 * @param  Backing transaction type.
 */
abstract class AbstractShardDataTreeTransaction
        implements Identifiable {
    private final ShardDataTreeTransactionParent parent;
    private final TransactionIdentifier id;
    private final T snapshot;

    private boolean closed;

    AbstractShardDataTreeTransaction(final ShardDataTreeTransactionParent parent, final TransactionIdentifier id,
        final T snapshot) {
        this.parent = requireNonNull(parent);
        this.snapshot = requireNonNull(snapshot);
        this.id = requireNonNull(id);
    }

    @Override
    public final TransactionIdentifier getIdentifier() {
        return id;
    }

    final ShardDataTreeTransactionParent getParent() {
        return parent;
    }

    final T getSnapshot() {
        return snapshot;
    }

    final boolean isClosed() {
        return closed;
    }

    /**
     * Close this transaction and mark it as closed, allowing idempotent invocations.
     *
     * @return True if the transaction got closed by this method invocation.
     */
    protected final boolean close() {
        if (closed) {
            return false;
        }

        closed = true;
        return true;
    }

    final void abort(final Runnable callback) {
        checkState(close(), "Transaction is already closed");
        parent.abortTransaction(this, callback);
    }

    /**
     * This method is exposed for sake of {@link ShardTransaction}, which is an actor. We need to ensure that
     * the parent is updated to reflect the transaction has been closed, but no journal actions may be invoked.
     *
     * 
     * ShardTransaction is responsible for additionally sending a request to persist an {@link AbortTransactionPayload}
     * via a message to the Shard actor.
     */
    final void abortFromTransactionActor() {
        if (close()) {
            parent.abortFromTransactionActor(this);
        }
    }

    @Override
    public final String toString() {
        return MoreObjects.toStringHelper(this).add("id", id).add("closed", closed).add("snapshot", snapshot)
                .toString();
    }
}