001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019/**
020 * Indicates the transaction result reported to post-transaction operations and completion observers.
021 *
022 * @author <a href="https://www.revetkn.com">Mark Allen</a>
023 * @since 2.0.0
024 */
025public enum TransactionResult {
026        /**
027         * Commit completed successfully.
028         */
029        COMMITTED,
030        /**
031         * Pyranid can prove that no application transaction work committed.
032         * <p>
033         * This includes a successful rollback before commit, a successful follow-up rollback after the physical commit reports a
034         * narrowly proven serialization abort, a successful rollback after pre-commit validation or a savepoint-scope ownership conflict refused the commit
035         * before it was issued, and a failed physical-transaction begin whose candidate connection Pyranid discarded before
036         * application transaction work could execute. Therefore, this result does not necessarily mean that Pyranid invoked the
037         * JDBC {@code rollback()} method.
038         */
039        ROLLED_BACK,
040        /**
041         * Pyranid cannot prove the final database outcome because an issued JDBC commit failed without narrow affirmative
042         * serialization-abort evidence followed by acknowledged rollback, or because rollback was not acknowledged after
043         * application transaction work could have executed. A failure before JDBC commit dispatch does not make the outcome
044         * uncertain when the follow-up rollback succeeds. Acknowledged commit or rollback retains its known database result
045         * even if subsequent diagnostics fail. General serialization diagnostics, including a secondary {@code 40001} under
046         * an uncertain primary commit failure, do not by themselves prove rollback. Validation success likewise does not prove
047         * that a later failed commit aborted.
048         * <p>
049         * For example, the database may have committed successfully but the client may not have received the acknowledgement, or
050         * rollback may have failed before the database confirmed that pending work was discarded.
051         * A rollback failure while cleaning up a failed physical-transaction begin is not {@code IN_DOUBT} when application
052         * transaction work could not have executed; Pyranid discards the candidate connection and reports {@link #ROLLED_BACK}.
053         * A savepoint-scope ownership conflict that refuses the commit before it is issued is not {@code IN_DOUBT} when the
054         * follow-up rollback succeeds; the database never received the commit, so Pyranid reports {@link #ROLLED_BACK}. The same
055         * conflict followed by a failed rollback remains {@code IN_DOUBT}.
056         *
057         * @since 4.2.0
058         */
059        IN_DOUBT
060}