org.wildfly.transaction.client

Interface XAImporter

All Superinterfaces:

XARecoverable, javax.resource.spi.XATerminator

public interface XAImporter
extends javax.resource.spi.XATerminator, XARecoverable

The API which must be implemented by transaction providers that support transaction inflow.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
void	beforeComplete(Xid xid) Perform before-completion processing.
Transaction	beginImported(Xid xid, int timeout) Import a transaction.
void	commit(Xid xid, boolean onePhase) Commit an imported (typically prepared) transaction.
void	forget(Xid xid) Forget an imported, prepared transaction.
int	prepare(Xid xid) Prepare an imported transaction.
Xid[]	recover(int flag) Initiate a recovery scan.
void	rollback(Xid xid) Roll back an imported transaction.

Methods inherited from interface org.wildfly.transaction.client.XARecoverable

from, from

Method Detail

beginImported

Transaction beginImported(Xid xid,
                          int timeout)
                   throws XAException

Import a transaction.

Parameters:

xid - the transaction ID (must not be null)

timeout - the remaining transaction timeout

Returns:

the imported transaction (must not be null)

Throws:

XAException - if the import failed for some reason

beforeComplete

void beforeComplete(Xid xid)
             throws XAException

Perform before-completion processing.

Parameters:

xid - the transaction ID (must not be null)

Throws:

XAException - if the import failed for some reason

commit

void commit(Xid xid,
            boolean onePhase)
     throws XAException

Commit an imported (typically prepared) transaction.

Specified by:

commit in interface XARecoverable

Specified by:

commit in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction ID (must not be null)

onePhase - true to perform prepare and commit in one operation, false otherwise

Throws:

XAException - if the operation fails for some reason

forget

void forget(Xid xid)
     throws XAException

Forget an imported, prepared transaction.

Specified by:

forget in interface XARecoverable

Specified by:

forget in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction ID (must not be null)

Throws:

XAException - if the operation fails for some reason

prepare

int prepare(Xid xid)
     throws XAException

Prepare an imported transaction.

Specified by:

prepare in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction ID (must not be null)

Returns:

XAResource.XA_OK if the prepare is successful or XAResource.XA_RDONLY if there is no commit phase necessary

Throws:

XAException - if the operation fails for some reason

rollback

void rollback(Xid xid)
       throws XAException

Roll back an imported transaction.

Specified by:

rollback in interface javax.resource.spi.XATerminator

Parameters:

xid - the transaction ID (must not be null)

Throws:

XAException - if the operation fails for some reason

recover

Xid[] recover(int flag)
       throws XAException

Initiate a recovery scan.

Specified by:

recover in interface XARecoverable

Specified by:

recover in interface javax.resource.spi.XATerminator

Parameters:

flag - one of XAResource.TMSTARTRSCAN, XAResource.TMNOFLAGS, or XAResource.TMENDRSCAN

Returns:

the array of recovered XIDs (may be SimpleXid.NO_XIDS, must not be null)

Throws:

XAException - if the operation fails for some reason