org.wildfly.transaction.client

Class LocalTransactionContext

java.lang.Object

org.wildfly.transaction.client.LocalTransactionContext

All Implemented Interfaces:

org.wildfly.common.context.Contextual<LocalTransactionContext>

public final class LocalTransactionContext
extends Object
implements org.wildfly.common.context.Contextual<LocalTransactionContext>

The local transaction context, which manages the creation and usage of local transactions.

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor and Description
LocalTransactionContext(LocalTransactionProvider provider) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
LocalTransaction	beginTransaction(int timeout) Begin a new, local transaction.
ImportResult<LocalTransaction>	findOrImportTransaction(Xid xid, int timeout) Attempt to import a transaction, which subsequently may be controlled by its XID or by the returned handle.
static org.wildfly.common.context.ContextManager<LocalTransactionContext>	getContextManager() Get the context manager.
static LocalTransactionContext	getCurrent() Get the current local transaction context.
org.wildfly.common.context.ContextManager<LocalTransactionContext>	getInstanceContextManager() Get the context manager; delegates to getContextManager().
XARecoverable	getRecoveryInterface() Get the recovery interface for this context.
boolean	importProviderTransaction() Attempt to import a provider's current transaction as a local transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wildfly.common.context.Contextual

run, runAction, runBiConsumer, runBiFunction, runBiPredicate, runCallable, runConsumer, runExBiConsumer, runExBiFunction, runExBiPredicate, runExceptionAction, runExConsumer, runExFunction, runExIntFunction, runExLongFunction, runExPredicate, runFunction, runIntFunction, runLongFunction, runPredicate

Constructor Detail

LocalTransactionContext

public LocalTransactionContext(LocalTransactionProvider provider)

Construct a new instance. The given provider will be used to manage local transactions.

Parameters:

provider - the local transaction provider

Method Detail

getContextManager

@NotNull
public static org.wildfly.common.context.ContextManager<LocalTransactionContext> getContextManager()

Get the context manager.

Returns:

the context manager (not null)

getInstanceContextManager

@NotNull
public org.wildfly.common.context.ContextManager<LocalTransactionContext> getInstanceContextManager()

Get the context manager; delegates to getContextManager().

Specified by:

getInstanceContextManager in interface org.wildfly.common.context.Contextual<LocalTransactionContext>

Returns:

the context manager (not null)

getCurrent

@NotNull
public static LocalTransactionContext getCurrent()

Get the current local transaction context. The default context does not support initiating new transactions.

Returns:

the current local transaction context (not null)

beginTransaction

@NotNull
public LocalTransaction beginTransaction(int timeout)
                                           throws SystemException,
                                                  SecurityException

Begin a new, local transaction.

Parameters:

timeout - the transaction timeout to use for this transaction

Returns:

the local transaction (not null)

Throws:

SystemException - if the transaction creation failed for some reason

SecurityException - if the caller is not authorized to create a local transaction in this context

findOrImportTransaction

@NotNull
public ImportResult<LocalTransaction> findOrImportTransaction(Xid xid,
                                                                       int timeout)
                                                                throws XAException

Attempt to import a transaction, which subsequently may be controlled by its XID or by the returned handle.

Parameters:

xid - the XID of the transaction to import (must not be null)

timeout - the transaction timeout to use, if new

Returns:

the transaction import result (not null)

Throws:

XAException - if a problem occurred while importing the transaction

importProviderTransaction

public boolean importProviderTransaction()
                                  throws SystemException,
                                         NotSupportedException

Attempt to import a provider's current transaction as a local transaction.

Returns:

true if the transaction was associated, false if the provider had no current transaction

Throws:

SystemException - if an error occurred acquiring the current transaction from the provider

NotSupportedException - if the thread is already associated with a transaction

getRecoveryInterface

@NotNull
public XARecoverable getRecoveryInterface()

Get the recovery interface for this context. The recovery interface can be used to recover transactions which were imported into this context via findOrImportTransaction(Xid, int).

Returns:

the recovery interface for this context (not null)