jakarta.resource.spi.TransactionSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.resource.spi;

/** 
 * This interface may be optionally implemented by a 
 * ManagedConnectionFactory to provide its level of transaction
 * support at runtime.
 *
 * When a ManagedConnectionFactory implements this interface,
 * the application server uses the TransactionSupportLevel returned
 * by getTransactionSupport() method and not the value specified in the 
 * resource adapter deployment descriptor or deployer configuration
 *
 * @since 1.6
 */
public interface TransactionSupport extends java.io.Serializable {

    /**
     * An enumerated type that represents the levels of transaction support
     * a resource adapter may support.
     *
     * @since 1.6
     */
    public enum TransactionSupportLevel {
        /**
         * The resource adapter supports neither resource manager nor Jakarta™ Transactions 
         * transactions.
         * @since 1.6
         */
        NoTransaction, 
        /**
         * The resource adapter supports resource manager local transactions 
         * by implementing the LocalTransaction interface.
         * @since 1.6
         */
        LocalTransaction, 
        /**
         * The resource adapter supports both resource manager local 
         * and Jakarta Transactions transactions by implementing the LocalTransaction
         * and XAResource interfaces.
         * @since 1.6
         */
        XATransaction 
    }

    /**
     * Get the level of transaction support, supported by the 
     * ManagedConnectionFactory. A resource adapter must always
     * return a level of transaction support whose ordinal value in
     * TransactionSupportLevel enum is equal to or lesser than
     * the resource adapter's transaction support classification.
     * @return transaction support level
     * @since 1.6
     */
    public TransactionSupportLevel getTransactionSupport();
}