jakarta.resource.cci.LocalTransaction Maven / Gradle / Ivy
/*
* 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.cci;
import jakarta.resource.ResourceException;
/** The LocalTransaction defines a transaction demarcation interface for
* resource manager local transactions. Note that this interface is
* used for application level local transaction demarcation. The
* system contract level LocalTransaction interface (as defined in
* the jakarta.resource.spi package) is used by the container
* for local transaction management.
*
* A local transaction is managed internal to a resource manager. There
* is no external transaction manager involved in the coordination of
* such transactions.
*
*
A CCI implementation can (but is not required to) implement the
* LocalTransaction interface. If the LocalTransaction interface is supported
* by a CCI implementation, then the method
* Connection.getLocalTransaction should return a
* LocalTransaction instance. A component can then use the
* returned LocalTransaction to demarcate a resource manager local transaction
* (associated with the Connection instance) on the underlying EIS
* instance.
*
* @author Rahul Sharma
* @since 0.8
* @see jakarta.resource.cci.Connection
**/
public interface LocalTransaction {
/** Begins a local transaction on an EIS instance.
*
* @throws ResourceException Failed to begin a local
* transaction. Examples of
* error cases are:
*
* - Resource adapter internal or EIS-specific
* error
*
- Connection is already participating in a
* local or Jakarta™ Transactions transaction
*
**/
public
void begin() throws ResourceException;
/** Commits the current local transaction and release all locks held
* by the underlying EIS instance.
*
* @throws ResourceException Failed to commit a local
* transaction. Examples of
* error cases are:
*
* - Resource adapter internal or EIS-specific error
*
- Violation of integrity constraints, deadlock
* detection, communication failure during
* transaction completion, or any retry requirement
*
- Connection is participating in an active Jakarta Transactions
* transaction
*
- Invalid transaction context; commit
* operation invoked without an active
* transaction context
*
**/
public
void commit() throws ResourceException;
/** Rollbacks the current resource manager local transaction.
*
* @throws ResourceException Failed to rollback a local
* transaction. Examples of
* error cases are:
*
* - Resource adapter internal or EIS-specific error
*
- Connection is participating in an active Jakarta Transactions
* transaction
*
- Invalid transaction context; rollback
* operation invoked without an active
* transaction context
*
**/
public
void rollback() throws ResourceException;
}