bitronix.tm.resource

Class ResourceRegistrar

java.lang.Object

bitronix.tm.resource.ResourceRegistrar

public final class ResourceRegistrar
extends Object

Collection of initialized XAResourceProducers. All resources must be registered in the ResourceRegistrar before they can be used by the transaction manager.

Note: The implementation is based on a thread safe, read-optimized list (copy-on-write) assuming that the number of registered resources is around 1 to 16 entries and does not change often. If this assumption is not-true it may be required to re-implement this with a ConcurrentMap instead.

Author:

Ludovic Orban, Juergen Kellerer

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	UNIQUE_NAME_CHARSET Specifies the charset that unique names of resources must be encodable with to be storeable in a TX journal.

Method Summary

Modifier and Type	Method and Description
static XAResourceHolder	findXAResourceHolder(XAResource xaResource) Find in the registered XAResourceProducers the XAResourceHolder from which the specified XAResource comes from.
static XAResourceProducer	get(String uniqueName) Get a registered XAResourceProducer.
static Set<String>	getResourcesUniqueNames() Get all XAResourceProducers unique names.
static void	register(XAResourceProducer producer) Register a XAResourceProducer.
static void	unregister(XAResourceProducer producer) Unregister a previously registered XAResourceProducer.

Methods inherited from class java.lang.Object

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

Field Detail

UNIQUE_NAME_CHARSET

public static final Charset UNIQUE_NAME_CHARSET

Specifies the charset that unique names of resources must be encodable with to be storeable in a TX journal.

Method Detail

get

public static XAResourceProducer get(String uniqueName)

Get a registered XAResourceProducer.

Parameters:

uniqueName - the name of the recoverable resource producer.

Returns:

the XAResourceProducer or null if there was none registered under that name.

getResourcesUniqueNames

public static Set<String> getResourcesUniqueNames()

Get all XAResourceProducers unique names.

Returns:

a Set containing all XAResourceProducers unique names.

register

public static void register(XAResourceProducer producer)
                     throws RecoveryException

Register a XAResourceProducer. If registration happens after the transaction manager started, incremental recovery is run on that resource.

Parameters:

producer - the XAResourceProducer.

Throws:

RecoveryException - When an error happens during recovery.

unregister

public static void unregister(XAResourceProducer producer)

Unregister a previously registered XAResourceProducer.

Parameters:

producer - the XAResourceProducer.

findXAResourceHolder

public static XAResourceHolder findXAResourceHolder(XAResource xaResource)

Find in the registered XAResourceProducers the XAResourceHolder from which the specified XAResource comes from.

Parameters:

xaResource - the XAResource to look for

Returns:

the associated XAResourceHolder or null if it cannot be found.