org.wildfly.transaction.client.XAImporter Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2016 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.wildfly.transaction.client;

import jakarta.transaction.Transaction;
import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import javax.transaction.xa.Xid;

import org.wildfly.common.annotation.NotNull;

/**
 * The API which must be implemented by transaction providers that support transaction inflow.
 *
 * @author David M. Lloyd
 */
public interface XAImporter extends XARecoverable {
    /**
     * Import a transaction.  If the transaction already exists, it should be returned, otherwise a new transaction
     * should be initiated with the given timeout (in seconds).
     *
     * @param xid the transaction ID (must not be {@code null})
     * @param timeout the remaining transaction timeout, or 0 if the default should be used
     * @param doNotImport {@code true} to indicate that a non-existing transaction should not be imported, {@code false} otherwise
     * @return the transaction import result, or {@code null} if (and only if) {@code doNotImport} is {@code true} and the transaction didn't exist locally
     * @throws XAException if the import failed for some reason
     */
    ImportResult findOrImportTransaction(Xid xid, int timeout, final boolean doNotImport) throws XAException;

    /**
     * Find an existing transaction on this system.  If no such transaction exists, {@code null} is returned.  Normally
     * the transaction is located only by global ID.
     *
     * @param xid the XID to search for (must not be {@code null})
     * @return the transaction object, or {@code null} if the transaction is not known
     * @throws XAException if the transaction manager failed for some reason
     */
    Transaction findExistingTransaction(Xid xid) throws XAException;

    /**
     * Commit an imported (typically prepared) transaction.
     *
     * @param xid the transaction ID (must not be {@code null})
     * @param onePhase {@code true} to perform prepare and commit in one operation, {@code false} otherwise
     * @throws XAException if the operation fails for some reason
     */
    void commit(Xid xid, boolean onePhase) throws XAException;

    /**
     * Forget an imported, prepared transaction.
     *
     * @param xid the transaction ID (must not be {@code null})
     * @throws XAException if the operation fails for some reason
     */
    void forget(Xid xid) throws XAException;

    /**
     * Initiate a recovery scan.
     *
     * @param flag one of {@link XAResource#TMSTARTRSCAN}, {@link XAResource#TMNOFLAGS}, or {@link XAResource#TMENDRSCAN}
     * @param parentName the name of the node to recover on behalf of, or {@code null} for all
     * @return the array of recovered XIDs (may be {@link SimpleXid#NO_XIDS}, must not be {@code null})
     * @throws XAException if the operation fails for some reason
     */
    @NotNull
    Xid[] recover(int flag, String parentName) throws XAException;
}