Package org.hibernate.engine.transaction.jta.platform.internal

Class AbstractJtaPlatform

java.lang.Object

org.hibernate.engine.transaction.jta.platform.internal.AbstractJtaPlatform

All Implemented Interfaces:

Serializable, TransactionManagerAccess, JtaPlatform, Service, Configurable, ServiceRegistryAwareService

Direct Known Subclasses:

AtomikosJtaPlatform, BitronixJtaPlatform, BorlandEnterpriseServerJtaPlatform, JBossAppServerJtaPlatform, JBossStandAloneJtaPlatform, JOnASJtaPlatform, JOTMJtaPlatform, JRun4JtaPlatform, OC4JJtaPlatform, OrionJtaPlatform, ResinJtaPlatform, SapNetWeaverJtaPlatform, SunOneJtaPlatform, TestingJtaPlatformImpl, WeblogicJtaPlatform, WebSphereExtendedJtaPlatform, WebSphereJtaPlatform, WebSphereLibertyJtaPlatform, WildFlyStandAloneJtaPlatform

public abstract class AbstractJtaPlatform
extends Object
implements JtaPlatform, Configurable, ServiceRegistryAwareService, TransactionManagerAccess

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractJtaPlatform()

Method Summary

Modifier and Type	Method	Description
protected boolean	canCacheTransactionManager()
protected boolean	canCacheTransactionManagerByDefault()
protected boolean	canCacheUserTransaction()
protected boolean	canCacheUserTransactionByDefault()
boolean	canRegisterSynchronization()	Can we currently register a Synchronization?
void	configure(Map<String,Object> configValues)	Configure the service.
int	getCurrentStatus()	Obtain the current transaction status using whatever means is preferred for this platform
protected JtaSynchronizationStrategy	getSynchronizationStrategy()
Object	getTransactionIdentifier(jakarta.transaction.Transaction transaction)	Determine an identifier for the given transaction appropriate for use in caching/lookup usages.
jakarta.transaction.TransactionManager	getTransactionManager()	Obtain the transaction manager
void	injectServices(ServiceRegistryImplementor serviceRegistry)	Callback to inject the registry.
protected JndiService	jndiService()
protected abstract jakarta.transaction.TransactionManager	locateTransactionManager()
protected abstract jakarta.transaction.UserTransaction	locateUserTransaction()
void	registerSynchronization(jakarta.transaction.Synchronization synchronization)	Register a JTA Synchronization in the means defined by the platform.
jakarta.transaction.TransactionManager	retrieveTransactionManager()	Locate the TransactionManager.
jakarta.transaction.UserTransaction	retrieveUserTransaction()	Locate the UserTransaction.
protected ServiceRegistry	serviceRegistry()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJtaPlatform

public AbstractJtaPlatform()

Method Detail

injectServices

public void injectServices(ServiceRegistryImplementor serviceRegistry)

Description copied from interface: ServiceRegistryAwareService

Callback to inject the registry.

Specified by:

injectServices in interface ServiceRegistryAwareService

Parameters:

serviceRegistry - The registry

serviceRegistry

protected ServiceRegistry serviceRegistry()

jndiService

protected JndiService jndiService()

locateTransactionManager

protected abstract jakarta.transaction.TransactionManager locateTransactionManager()

locateUserTransaction

protected abstract jakarta.transaction.UserTransaction locateUserTransaction()

configure

public void configure(Map<String,Object> configValues)

Description copied from interface: Configurable

Configure the service.

Specified by:

configure in interface Configurable

Parameters:

configValues - The configuration properties.

canCacheTransactionManagerByDefault

protected boolean canCacheTransactionManagerByDefault()

canCacheUserTransactionByDefault

protected boolean canCacheUserTransactionByDefault()

canCacheTransactionManager

protected boolean canCacheTransactionManager()

canCacheUserTransaction

protected boolean canCacheUserTransaction()

retrieveTransactionManager

public jakarta.transaction.TransactionManager retrieveTransactionManager()

Description copied from interface: JtaPlatform

Locate the TransactionManager.

Specified by:

retrieveTransactionManager in interface JtaPlatform

Returns:

The TransactionManager

getTransactionManager

public jakarta.transaction.TransactionManager getTransactionManager()

Description copied from interface: TransactionManagerAccess

Obtain the transaction manager

Specified by:

getTransactionManager in interface TransactionManagerAccess

Returns:

The transaction manager.

retrieveUserTransaction

public jakarta.transaction.UserTransaction retrieveUserTransaction()

Description copied from interface: JtaPlatform

Locate the UserTransaction.

If AvailableSettings.PREFER_USER_TRANSACTION is enabled, Hibernate will use the UserTransaction in preference to the TransactionManager where possible.

Specified by:

retrieveUserTransaction in interface JtaPlatform

Returns:

The UserTransaction

getTransactionIdentifier

public Object getTransactionIdentifier(jakarta.transaction.Transaction transaction)

Description copied from interface: JtaPlatform

Determine an identifier for the given transaction appropriate for use in caching/lookup usages.

Generally speaking the transaction itself will be returned here. This method was added specifically for use in WebSphere and other unfriendly Java EE containers.

Specified by:

getTransactionIdentifier in interface JtaPlatform

Parameters:

transaction - The transaction to be identified.

Returns:

An appropriate identifier

getSynchronizationStrategy

protected JtaSynchronizationStrategy getSynchronizationStrategy()

registerSynchronization

public void registerSynchronization(jakarta.transaction.Synchronization synchronization)

Description copied from interface: JtaPlatform

Register a JTA Synchronization in the means defined by the platform.

Specified by:

registerSynchronization in interface JtaPlatform

Parameters:

synchronization - The synchronization to register

canRegisterSynchronization

public boolean canRegisterSynchronization()

Description copied from interface: JtaPlatform

Can we currently register a Synchronization?

Specified by:

canRegisterSynchronization in interface JtaPlatform

Returns:

True if registering a Synchronization is currently allowed; false otherwise.

getCurrentStatus

public int getCurrentStatus()
                     throws jakarta.transaction.SystemException

Description copied from interface: JtaPlatform

Obtain the current transaction status using whatever means is preferred for this platform

Specified by:

getCurrentStatus in interface JtaPlatform

Returns:

The current status.

Throws:

jakarta.transaction.SystemException - Indicates a problem access the underlying status