Module io.helidon.integrations.cdi.hibernate

Package io.helidon.integrations.cdi.hibernate

Class DataSourceBackedDialectFactory

java.lang.Object

io.helidon.integrations.cdi.hibernate.DataSourceBackedDialectFactory

All Implemented Interfaces:

Serializable, StandardServiceInitiator<DialectFactory>, DialectFactory, Service, ServiceContributor, ServiceInitiator<DialectFactory>

public final class DataSourceBackedDialectFactory
extends Object
implements DialectFactory, ServiceContributor, StandardServiceInitiator<DialectFactory>

A DialectFactory implementation (and a ServiceContributor, and a StandardServiceInitiator<DialectFactory>) that introspects DatabaseMetaData from a configured DataSource.

Hibernate is guaranteed to perform each of the following invocations, once, ever, in order:

1. (The zero-argument constructor)
2. The contribute(StandardServiceRegistryBuilder) method
3. The initiateService(Map, ServiceRegistryImplementor) method (if applicable)

Then, at application runtime, after the sole instance of this class has been installed following the protocol above, Hibernate will call the buildDialect(Map, DialectResolutionInfoSource) method as appropriate.

See Also:

• contribute(StandardServiceRegistryBuilder)
• initiateService(Map, ServiceRegistryImplementor)
• buildDialect(Map, DialectResolutionInfoSource)
• Custom Service Implementations (overriding) in the Hibernate Integration Guide
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DataSourceBackedDialectFactory()	Deprecated. For use by ServiceLoader instances only.

Method Summary

Modifier and Type	Method	Description
Dialect	buildDialect(Map<String,Object> settings, DialectResolutionInfoSource dialectResolutionInfoSource)	Deprecated. For Hibernate use only.
void	contribute(StandardServiceRegistryBuilder standardServiceRegistryBuilder)	Deprecated. For Hibernate use only.
Class<DialectFactory>	getServiceInitiated()	Deprecated. For Hibernate use only.
DataSourceBackedDialectFactory	initiateService(Map<String,Object> settings, ServiceRegistryImplementor serviceRegistry)	Deprecated. For Hibernate use only.

Methods inherited from class java.lang.Object

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

Constructor Details

DataSourceBackedDialectFactory

@Deprecated
public DataSourceBackedDialectFactory()

Deprecated.

For use by ServiceLoader instances only.

Creates a new DataSourceBackedDialectFactory.

Method Details

buildDialect

@Deprecated
public Dialect buildDialect(Map<String,Object> settings,
 DialectResolutionInfoSource dialectResolutionInfoSource)

Deprecated.

For Hibernate use only.

Retrieves the DataSource stored in the supplied Map under the AvailableSettings.JAKARTA_JTA_DATASOURCE key, and uses it to ultimately acquire a DatabaseMetaData instance to adapt into a DialectResolutionInfo instance, such that a DialectResolutionInfoSource can be constructed, in the case where the supplied dialectResolutionInfoSource is null, and passes the resulting DialectResolutionInfoSource to the standard DialectFactory that Hibernate uses by default, such that Hibernate can determine what Dialect to use when database connectivity is established via a META-INF/persistence.xml's jta-data-source element.

Specified by:

buildDialect in interface DialectFactory

Parameters:

settings - a Map containing the settings returned by an invocation of the StandardServiceRegistryBuilder.getSettings() method; must not be null

dialectResolutionInfoSource - a DialectResolutionInfoSource supplied by Hibernate; may be, and often is, null

Returns:

a Dialect; never null

Throws:

NullPointerException - if settings is null

HibernateException - if a Dialect could not be constructed

See Also:

• DialectFactoryImpl.buildDialect(Map, DialectResolutionInfoSource)
• AvailableSettings.JAKARTA_JTA_DATASOURCE
• DatabaseMetaDataDialectResolutionInfoAdapter

contribute

@Deprecated
public void contribute(StandardServiceRegistryBuilder standardServiceRegistryBuilder)

Deprecated.

For Hibernate use only.

Contributes this DataSourceBackedDialectFactory as a StandardServiceInitiator<DialectFactory> if and only if certain requirements are met.

This method will call standardServiceRegistryBuilder.addInitiator(this) if and only if all of the following preconditions hold:

• settings.get(DIALECT) returns an object that is either null or a blank String
• settings.get(JAKARTA_JTA_DATASOURCE) returns a non-null DataSource

If any other state of affairs holds, this method takes no action.

Specified by:

contribute in interface ServiceContributor

Parameters:

standardServiceRegistryBuilder - a StandardServiceRegistryBuilder whose StandardServiceRegistryBuilder.addInitiator(StandardServiceInitiator) may be called with this as its sole argument; must not be null

getServiceInitiated

@Deprecated
public Class<DialectFactory> getServiceInitiated()

Deprecated.

For Hibernate use only.

Returns Class<DialectFactory> when invoked, thus describing the type of service the initiateService(Map, ServiceRegistryImplementor) will initiate.

Specified by:

getServiceInitiated in interface ServiceInitiator<DialectFactory>

Returns:

Class<DialectFactory> when invoked

See Also:

• ServiceInitiator.getServiceInitiated()

initiateService

@Deprecated
public DataSourceBackedDialectFactory initiateService(Map<String,Object> settings,
 ServiceRegistryImplementor serviceRegistry)

Deprecated.

For Hibernate use only.

Returns this when invoked.

Specified by:

initiateService in interface StandardServiceInitiator<DialectFactory>

Parameters:

settings - ignored

serviceRegistry - a ServiceRegistryImplementor supplied by Hibernate

Returns:

this when invoked