org.wildfly.transaction.client.provider.jboss

Class JBossLocalTransactionProvider

java.lang.Object

org.wildfly.transaction.client.provider.jboss.JBossLocalTransactionProvider

All Implemented Interfaces:

LocalTransactionProvider, TransactionProvider

public final class JBossLocalTransactionProvider
extends Object
implements LocalTransactionProvider

The local transaction provider for JBoss application servers.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JBossLocalTransactionProvider.Builder A builder for a JBoss local transaction provider.

Field Summary

Fields inherited from interface org.wildfly.transaction.client.spi.LocalTransactionProvider

EMPTY

Method Summary

Modifier and Type	Method and Description
static JBossLocalTransactionProvider.Builder	builder()
void	commitLocal(Transaction transaction) Locally commit the given provider transaction.
Transaction	createNewTransaction(int timeout) Create and start a new local transaction, which is not associated with any particular thread.
void	dropLocal(Transaction transaction) Drop a local transaction from memory.
Object	getKey(Transaction transaction) Get a key which has the same equals and hashCode behavior as the given transaction.
String	getNameFromXid(Xid xid) Attempt to derive a node name from an XID.
String	getNodeName() Get the unique node name of this provider.
<T> T	getProviderInterface(Transaction transaction, Class<T> providerInterfaceType) Attempt to acquire a provider interface instance from the given provider transaction.
Object	getResource(Transaction transaction, Object key) Get a resource associated with the given transaction.
boolean	getRollbackOnly(Transaction transaction) Determine if the given transaction is rollback-only.
int	getTimeout(Transaction transaction) Get the configured timeout of the given transaction (not the remaining time).
TransactionManager	getTransactionManager() Get the transaction manager.
XAImporter	getXAImporter() Get the XA importer.
Xid	getXid(Transaction transaction) Get the transaction ID of the given transaction.
boolean	isImported(Transaction transaction) Determine whether the given transaction was imported or originated locally.
void	putResource(Transaction transaction, Object key, Object value) Put a resource on to the given transaction.
void	registerInterposedSynchronization(Transaction transaction, Synchronization sync) Register an interposed synchronization on the given transaction.
void	rollbackLocal(Transaction transaction) Locally roll back the given provider transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static JBossLocalTransactionProvider.Builder builder()

getTransactionManager

@NotNull
public TransactionManager getTransactionManager()

Description copied from interface: LocalTransactionProvider

Get the transaction manager.

Specified by:

getTransactionManager in interface LocalTransactionProvider

Returns:

the transaction manager (must not be null)

getXAImporter

@NotNull
public XAImporter getXAImporter()

Description copied from interface: LocalTransactionProvider

Get the XA importer.

Specified by:

getXAImporter in interface LocalTransactionProvider

Returns:

the XA importer (must not be null)

createNewTransaction

@NotNull
public Transaction createNewTransaction(int timeout)
                                          throws SystemException,
                                                 SecurityException

Description copied from interface: LocalTransactionProvider

Create and start a new local transaction, which is not associated with any particular thread.

Specified by:

createNewTransaction in interface LocalTransactionProvider

Parameters:

timeout - the timeout to use for the new transaction

Returns:

the new transaction (must not be null)

Throws:

SystemException - if the creation of the transaction failed for some reason

SecurityException - if the caller is not authorized to create a transaction

isImported

public boolean isImported(@NotNull
                          Transaction transaction)
                   throws IllegalArgumentException

Description copied from interface: LocalTransactionProvider

Determine whether the given transaction was imported or originated locally.

Specified by:

isImported in interface LocalTransactionProvider

Parameters:

transaction - the transaction to test (not null)

Returns:

true if the transaction was imported, or false if it was created locally

Throws:

IllegalArgumentException - if the transaction does not belong to this provider

registerInterposedSynchronization

public void registerInterposedSynchronization(@NotNull
                                              Transaction transaction,
                                              @NotNull
                                              Synchronization sync)
                                       throws IllegalArgumentException

Description copied from interface: LocalTransactionProvider

Register an interposed synchronization on the given transaction.

Specified by:

registerInterposedSynchronization in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

sync - the synchronization (not null)

Throws:

IllegalArgumentException - if the transaction does not belong to this provider

getResource

public Object getResource(@NotNull
                          Transaction transaction,
                          @NotNull
                          Object key)

Description copied from interface: LocalTransactionProvider

Get a resource associated with the given transaction.

Specified by:

getResource in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

key - the key to look up (not null)

Returns:

the resource, or null if none is set

putResource

public void putResource(@NotNull
                        Transaction transaction,
                        @NotNull
                        Object key,
                        Object value)
                 throws IllegalArgumentException

Description copied from interface: LocalTransactionProvider

Put a resource on to the given transaction.

Specified by:

putResource in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

key - the key to store under (not null)

value - the value to store

Throws:

IllegalArgumentException - if the transaction does not belong to this provider

getRollbackOnly

public boolean getRollbackOnly(@NotNull
                               Transaction transaction)
                        throws IllegalArgumentException

Description copied from interface: LocalTransactionProvider

Determine if the given transaction is rollback-only.

Specified by:

getRollbackOnly in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Returns:

true if the transaction is rollback-only, false otherwise

Throws:

IllegalArgumentException - if the transaction does not belong to this provider

getKey

@NotNull
public Object getKey(@NotNull
                              Transaction transaction)
                       throws IllegalArgumentException

Description copied from interface: LocalTransactionProvider

Get a key which has the same equals and hashCode behavior as the given transaction.

Specified by:

getKey in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Returns:

the key object (must not be null)

Throws:

IllegalArgumentException - if the transaction does not belong to this provider

commitLocal

public void commitLocal(@NotNull
                        Transaction transaction)
                 throws RollbackException,
                        HeuristicMixedException,
                        HeuristicRollbackException,
                        SecurityException,
                        IllegalStateException,
                        SystemException

Description copied from interface: LocalTransactionProvider

Locally commit the given provider transaction. A given provider transaction will only be committed by this method or SubordinateTransactionControl.commit(boolean).

Specified by:

commitLocal in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Throws:

RollbackException - if the local commit operation throws this exception

HeuristicMixedException - if the local commit operation throws this exception

HeuristicRollbackException - if the local commit operation throws this exception

SecurityException - if the local commit operation throws this exception

IllegalStateException - if the local commit operation throws this exception

SystemException - if the local commit operation throws this exception

rollbackLocal

public void rollbackLocal(@NotNull
                          Transaction transaction)
                   throws IllegalStateException,
                          SystemException

Description copied from interface: LocalTransactionProvider

Locally roll back the given provider transaction. A given provider transaction will only be rolled back by this method or SubordinateTransactionControl.rollback().

Specified by:

rollbackLocal in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Throws:

IllegalStateException - if the local commit operation throws this exception

SystemException - if the local commit operation throws this exception

dropLocal

public void dropLocal(@NotNull
                      Transaction transaction)

Description copied from interface: LocalTransactionProvider

Drop a local transaction from memory. The transaction is locally-initiated and contains no remote subordinate enlistments, guaranteeing that the transaction can never reappear on this node.

Specified by:

dropLocal in interface LocalTransactionProvider

Parameters:

transaction - the transaction to drop (not null)

getTimeout

public int getTimeout(@NotNull
                      Transaction transaction)

Description copied from interface: LocalTransactionProvider

Get the configured timeout of the given transaction (not the remaining time).

Specified by:

getTimeout in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Returns:

the number of seconds remaining

getXid

@NotNull
public Xid getXid(@NotNull
                           Transaction transaction)

Description copied from interface: LocalTransactionProvider

Get the transaction ID of the given transaction.

Specified by:

getXid in interface LocalTransactionProvider

Parameters:

transaction - the transaction (not null)

Returns:

the transaction ID (must not be null)

getNodeName

@NotNull
public String getNodeName()

Description copied from interface: LocalTransactionProvider

Get the unique node name of this provider.

Specified by:

getNodeName in interface LocalTransactionProvider

Returns:

the node name (must not be null)

getNameFromXid

public String getNameFromXid(@NotNull
                             Xid xid)

Description copied from interface: LocalTransactionProvider

Attempt to derive a node name from an XID. If the XID is not in a recognized format, null is returned.

Specified by:

getNameFromXid in interface LocalTransactionProvider

Parameters:

xid - the XID (not null)

Returns:

the originating node name

getProviderInterface

public <T> T getProviderInterface(Transaction transaction,
                                  Class<T> providerInterfaceType)

Description copied from interface: LocalTransactionProvider

Attempt to acquire a provider interface instance from the given provider transaction.

Specified by:

getProviderInterface in interface LocalTransactionProvider

Type Parameters:

T - the provider interface type

Parameters:

transaction - the provider transaction (not null)

providerInterfaceType - the provider interface type class (not null)

Returns:

the provider interface instance, or null if none matches

toString

public String toString()

Overrides:

toString in class Object