org.neo4j.kernel.impl.transaction.log.Commitment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 2025.02.0

Show newest version

/*
 * Copyright (c) 2002-2015 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.kernel.impl.transaction.log;


/**
 * A way to mark a transaction as committed after
 * {@link TransactionAppender#append(org.neo4j.kernel.impl.transaction.TransactionRepresentation, long) appended}
 * and manually {@link TransactionAppender#force() forced} and later closed after
 * {@link org.neo4j.kernel.impl.api.TransactionRepresentationStoreApplier#apply(
 * org.neo4j.kernel.impl.transaction.TransactionRepresentation, org.neo4j.kernel.impl.api.index.ValidatedIndexUpdates,
 *  org.neo4j.kernel.impl.locking.LockGroup, long, org.neo4j.kernel.impl.api.TransactionApplicationMode)} .
 */
public interface Commitment
{
    /**
     * 
     *     Marks the transaction as committed and makes this fact public.
     * 
     */
    void publishAsCommitted();

    /**
     * 
     *     Marks the transaction as closed and makes this fact public.
     * 
     */
    void publishAsApplied();

    /**
     * @return the commitment transaction id
     */
    long transactionId();

    boolean markedAsCommitted();
}