more Javadoc for JtaPlatform and friends

This commit is contained in:
Gavin King 2022-01-21 16:17:05 +01:00
parent 27b2271130
commit 8327f8567d
3 changed files with 25 additions and 5 deletions

View File

@ -15,7 +15,18 @@ import jakarta.transaction.UserTransaction;
import org.hibernate.service.Service;
/**
* Defines how we interact with various JTA services on the given platform/environment.
* A {@link Service} that defines how Hibernate interacts with JTA on a certain
* platform. In particular, a {@code JtaPlatform} allows Hibernate to obtain
* the {@link TransactionManager} and {@link UserTransaction}, and register
* {@link Synchronization}s.
* <p>
* An implementation may be selected by specifying the configuration property
* {@value org.hibernate.cfg.AvailableSettings#JTA_PLATFORM}. Alternatively,
* a {@link JtaPlatformProvider} or even a custom {@link JtaPlatformResolver}
* may be used.
*
* @see JtaPlatformResolver
* @see JtaPlatformProvider
*
* @author Steve Ebersole
*/

View File

@ -7,8 +7,11 @@
package org.hibernate.engine.transaction.jta.platform.spi;
/**
* A {@link java.util.ServiceLoader}-style provider of {@link JtaPlatform} instances. Used when an
* explicit JtaPlatform is not provided.
* A {@link java.util.ServiceLoader}-style provider of {@link JtaPlatform}
* instances. Used when an explicit {@code JtaPlatform} is not provided.
*
* @see JtaPlatform
* @see JtaPlatformResolver
*
* @author Steve Ebersole
*/

View File

@ -12,8 +12,14 @@ import org.hibernate.service.Service;
import org.hibernate.service.spi.ServiceRegistryImplementor;
/**
* Service for defining how to resolve or determine the {@link JtaPlatform} to use in configurations where the user
* did not explicitly specify one.
* A {@link Service} defining a strategy for obtaining a {@link JtaPlatform}
* in configurations where the application did not explicitly specify one.
* <p>
* An implementation may be selected by specifying the configuration property
* {@value org.hibernate.cfg.AvailableSettings#JTA_PLATFORM_RESOLVER}.
*
* @see JtaPlatform
* @see JtaPlatformProvider
*
* @author Steve Ebersole
*/