Package org.hibernate.jpa

Class HibernatePersistenceConfiguration

java.lang.Object

jakarta.persistence.PersistenceConfiguration

org.hibernate.jpa.HibernatePersistenceConfiguration

public class HibernatePersistenceConfiguration
extends PersistenceConfiguration

Hibernate extension to the Jakarta Persistence PersistenceConfiguration contract.

Since:

7.0

API Note:

The specification explicitly encourages implementors to extend PersistenceConfiguration to accommodate vendor-specific extensions in a more typesafe way. Of course, programs which desire configuration logic to be portable between JPA providers should use PersistenceConfiguration directly.

Field Summary

Fields inherited from class jakarta.persistence.PersistenceConfiguration

CACHE_MODE, JDBC_DATASOURCE, JDBC_DRIVER, JDBC_PASSWORD, JDBC_URL, JDBC_USER, LOCK_TIMEOUT, QUERY_TIMEOUT, SCHEMAGEN_CREATE_SCRIPT_SOURCE, SCHEMAGEN_CREATE_SOURCE, SCHEMAGEN_CREATE_TARGET, SCHEMAGEN_DATABASE_ACTION, SCHEMAGEN_DROP_SCRIPT_SOURCE, SCHEMAGEN_DROP_SOURCE, SCHEMAGEN_DROP_TARGET, SCHEMAGEN_SCRIPTS_ACTION, VALIDATION_FACTORY, VALIDATION_GROUP_PRE_PERSIST, VALIDATION_GROUP_PRE_REMOVE, VALIDATION_GROUP_PRE_UPDATE

Constructor Summary

Constructors

Constructor	Description
HibernatePersistenceConfiguration(String name)	Create a new empty configuration.

Method Summary

Modifier and Type	Method	Description
HibernatePersistenceConfiguration	caching(CachingType type)	Enable or disable the second-level and query caches.
HibernatePersistenceConfiguration	cachingAccessType(AccessType type)	If data caching is enabled, configure the type of concurrency access that should be applied if not explicitly specified on a cache region.
HibernatePersistenceConfiguration	cachingCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling of proxies.
HibernatePersistenceConfiguration	closedCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling around calls to EntityManager.close(), EntityManager.isOpen(), EntityManagerFactory.close() and EntityManagerFactory.isOpen()
HibernatePersistenceConfiguration	collectStatistics(boolean enabled)	Configures whether Hibernate should collect Statistics.
SessionFactory	createEntityManagerFactory()	Create a new SessionFactory based on this configuration.
HibernatePersistenceConfiguration	defaultCatalog(String catalogName)	Configure a default catalog name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.
HibernatePersistenceConfiguration	defaultSchema(String schemaName)	Configure a default schema name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.
HibernatePersistenceConfiguration	globalGeneratorCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for in terms of collecting all named value generators globally, regardless of location.
HibernatePersistenceConfiguration	jdbcCredentials(String username, String password)	Username and password for non-DataSource JDBC connection.
HibernatePersistenceConfiguration	jdbcDriver(String driverName)	JDBC driver class name for non-DataSource connection.
HibernatePersistenceConfiguration	jdbcPassword(String password)	Password for non-DataSource JDBC connection.
HibernatePersistenceConfiguration	jdbcUrl(String url)	JDBC URL of non-DataSource JDBC connection.
HibernatePersistenceConfiguration	jdbcUsername(String username)	Username for non-DataSource JDBC connection.
HibernatePersistenceConfiguration	jtaDataSource(String dataSourceJndiName)
HibernatePersistenceConfiguration	loadByIdCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for the allowed type of identifier value passed to EntityManager.getReference(java.lang.Class<T>, java.lang.Object) and EntityManager.find(java.lang.Class<T>, java.lang.Object)
HibernatePersistenceConfiguration	managedClass(Class<?> managedClass)
HibernatePersistenceConfiguration	managedClasses(Class<?>... managedClasses)	Add the specified classes as managed classes.
HibernatePersistenceConfiguration	managedClasses(Collection<Class<?>> managedClasses)	Add the specified classes as managed classes.
HibernatePersistenceConfiguration	mappingFile(String name)
HibernatePersistenceConfiguration	mappingFiles(String... names)	Add the specified resource names as mapping files.
HibernatePersistenceConfiguration	mappingFiles(Collection<String> names)	Add the specified resource names as mapping files.
HibernatePersistenceConfiguration	nationalizedCharacterData(boolean enabled)	Configure a default schema name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.
HibernatePersistenceConfiguration	nonJtaDataSource(String dataSourceJndiName)
HibernatePersistenceConfiguration	orderByMappingCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for the interpretation of OrderBy.
HibernatePersistenceConfiguration	properties(Map<String,?> properties)
HibernatePersistenceConfiguration	property(String name, Object value)
HibernatePersistenceConfiguration	provider(String providerClassName)
HibernatePersistenceConfiguration	proxyCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling of proxies.
HibernatePersistenceConfiguration	queryCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for all aspects of Query handling.
HibernatePersistenceConfiguration	schemaToolingAction(Action action)	Specify the action to take in terms of automatic database schema tooling.
HibernatePersistenceConfiguration	sharedCacheMode(SharedCacheMode sharedCacheMode)
HibernatePersistenceConfiguration	showSql(boolean showSql, boolean formatSql, boolean highlightSql)	Enables SQL logging to the console.
HibernatePersistenceConfiguration	statementInspector(Class<? extends StatementInspector> inspectorImpl)	Specify a StatementInspector to be applied to all Sessions/EntityManagers
HibernatePersistenceConfiguration	statementInspector(StatementInspector inspector)	Specify a StatementInspector to be applied to all Sessions/EntityManagers
HibernatePersistenceConfiguration	transactionCompliance(boolean enabled)	Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for all aspects of transaction handling.
HibernatePersistenceConfiguration	transactionType(PersistenceUnitTransactionType transactionType)
HibernatePersistenceConfiguration	validationMode(ValidationMode validationMode)
HibernatePersistenceConfiguration	xmlMappings(boolean enabled)	Configures whether Hibernate should process XML mappings (orm.xml files).
HibernatePersistenceConfiguration	xmlValidation(boolean enabled)	Configures whether Hibernate should validate (via schema descriptor) XML files.

Methods inherited from class jakarta.persistence.PersistenceConfiguration

jtaDataSource, managedClasses, mappingFiles, name, nonJtaDataSource, properties, provider, sharedCacheMode, transactionType, validationMode

Methods inherited from class java.lang.Object

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

Constructor Details

HibernatePersistenceConfiguration

public HibernatePersistenceConfiguration(String name)

Create a new empty configuration. An empty configuration does not typically hold enough information for successful invocation of createEntityManagerFactory().

Parameters:

name - the name of the persistence unit, which may be used by the persistence provider for logging and error reporting

Method Details

createEntityManagerFactory

public SessionFactory createEntityManagerFactory()

Create a new SessionFactory based on this configuration.

Overrides:

createEntityManagerFactory in class PersistenceConfiguration

jdbcDriver

public HibernatePersistenceConfiguration jdbcDriver(String driverName)

JDBC driver class name for non-DataSource connection.

See Also:

• PersistenceConfiguration.JDBC_DRIVER

jdbcUrl

public HibernatePersistenceConfiguration jdbcUrl(String url)

JDBC URL of non-DataSource JDBC connection.

See Also:

• PersistenceConfiguration.JDBC_URL

jdbcUsername

public HibernatePersistenceConfiguration jdbcUsername(String username)

Username for non-DataSource JDBC connection.

See Also:

• PersistenceConfiguration.JDBC_USER
• jdbcPassword(java.lang.String)

jdbcPassword

public HibernatePersistenceConfiguration jdbcPassword(String password)

Password for non-DataSource JDBC connection.

See Also:

• PersistenceConfiguration.JDBC_PASSWORD
• jdbcUsername(java.lang.String)

jdbcCredentials

public HibernatePersistenceConfiguration jdbcCredentials(String username,
 String password)

Username and password for non-DataSource JDBC connection.

See Also:

• PersistenceConfiguration.JDBC_USER
• PersistenceConfiguration.JDBC_PASSWORD
• jdbcUsername(java.lang.String)
• jdbcPassword(java.lang.String)

showSql

public HibernatePersistenceConfiguration showSql(boolean showSql,
 boolean formatSql,
 boolean highlightSql)

Enables SQL logging to the console.

Sets "hibernate.show_sql", "hibernate.format_sql", and "hibernate.highlight_sql".

Parameters:

showSql - should SQL be logged to console?

formatSql - should logged SQL be formatted

highlightSql - should logged SQL be highlighted with pretty colors

queryCompliance

public HibernatePersistenceConfiguration queryCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for all aspects of Query handling.

See Also:

• JpaComplianceSettings.JPA_QUERY_COMPLIANCE

transactionCompliance

public HibernatePersistenceConfiguration transactionCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for all aspects of transaction handling.

See Also:

• JpaComplianceSettings.JPA_TRANSACTION_COMPLIANCE

closedCompliance

public HibernatePersistenceConfiguration closedCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling around calls to EntityManager.close(), EntityManager.isOpen(), EntityManagerFactory.close() and EntityManagerFactory.isOpen()

See Also:

• JpaComplianceSettings.JPA_CLOSED_COMPLIANCE

proxyCompliance

public HibernatePersistenceConfiguration proxyCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling of proxies.

See Also:

• JpaComplianceSettings.JPA_PROXY_COMPLIANCE

cachingCompliance

public HibernatePersistenceConfiguration cachingCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for handling of proxies.

See Also:

• JpaComplianceSettings.JPA_PROXY_COMPLIANCE

globalGeneratorCompliance

public HibernatePersistenceConfiguration globalGeneratorCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for in terms of collecting all named value generators globally, regardless of location.

See Also:

• JpaComplianceSettings.JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE

orderByMappingCompliance

public HibernatePersistenceConfiguration orderByMappingCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for the interpretation of OrderBy.

See Also:

• JpaComplianceSettings.JPA_ORDER_BY_MAPPING_COMPLIANCE

loadByIdCompliance

public HibernatePersistenceConfiguration loadByIdCompliance(boolean enabled)

Specifies whether Hibernate will strictly adhere to compliance with Jakarta Persistence for the allowed type of identifier value passed to EntityManager.getReference(java.lang.Class<T>, java.lang.Object) and EntityManager.find(java.lang.Class<T>, java.lang.Object)

See Also:

• JpaComplianceSettings.JPA_LOAD_BY_ID_COMPLIANCE

caching

public HibernatePersistenceConfiguration caching(CachingType type)

Enable or disable the second-level and query caches.

cachingAccessType

public HibernatePersistenceConfiguration cachingAccessType(AccessType type)

If data caching is enabled, configure the type of concurrency access that should be applied if not explicitly specified on a cache region.

See Also:

• Cache.usage()
• CacheSettings.DEFAULT_CACHE_CONCURRENCY_STRATEGY

statementInspector

public HibernatePersistenceConfiguration statementInspector(Class<? extends StatementInspector> inspectorImpl)

Specify a StatementInspector to be applied to all Sessions/EntityManagers

See Also:

• JdbcSettings.STATEMENT_INSPECTOR

statementInspector

public HibernatePersistenceConfiguration statementInspector(StatementInspector inspector)

Specify a StatementInspector to be applied to all Sessions/EntityManagers

See Also:

• JdbcSettings.STATEMENT_INSPECTOR

defaultCatalog

public HibernatePersistenceConfiguration defaultCatalog(String catalogName)

Configure a default catalog name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.

See Also:

• MappingSettings.DEFAULT_CATALOG

defaultSchema

public HibernatePersistenceConfiguration defaultSchema(String schemaName)

Configure a default schema name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.

See Also:

• MappingSettings.DEFAULT_SCHEMA

nationalizedCharacterData

public HibernatePersistenceConfiguration nationalizedCharacterData(boolean enabled)

Configure a default schema name to be used for database objects (tables, sequences, etc) which do not explicitly specify one.

See Also:

• MappingSettings.USE_NATIONALIZED_CHARACTER_DATA

xmlMappings

public HibernatePersistenceConfiguration xmlMappings(boolean enabled)

Configures whether Hibernate should process XML mappings (orm.xml files).

See Also:

• MappingSettings.XML_MAPPING_ENABLED

xmlValidation

public HibernatePersistenceConfiguration xmlValidation(boolean enabled)

Configures whether Hibernate should validate (via schema descriptor) XML files.

See Also:

• MappingSettings.VALIDATE_XML

collectStatistics

public HibernatePersistenceConfiguration collectStatistics(boolean enabled)

Configures whether Hibernate should collect Statistics.

See Also:

• StatisticsSettings.GENERATE_STATISTICS

managedClasses

public HibernatePersistenceConfiguration managedClasses(Class<?>... managedClasses)

Add the specified classes as managed classes.

See Also:

• managedClass(java.lang.Class<?>)

managedClasses

public HibernatePersistenceConfiguration managedClasses(Collection<Class<?>> managedClasses)

Add the specified classes as managed classes.

See Also:

• managedClass(java.lang.Class<?>)

mappingFiles

public HibernatePersistenceConfiguration mappingFiles(String... names)

Add the specified resource names as mapping files.

See Also:

• mappingFiles(java.lang.String...)

mappingFiles

public HibernatePersistenceConfiguration mappingFiles(Collection<String> names)

Add the specified resource names as mapping files.

See Also:

• mappingFiles(java.lang.String...)

schemaToolingAction

public HibernatePersistenceConfiguration schemaToolingAction(Action action)

Specify the action to take in terms of automatic database schema tooling.

See Also:

• SchemaToolingSettings.HBM2DDL_AUTO

API Note:

This only controls tooling as exported directly to the database. To output tooling commands to scripts, use config properties instead with appropriate settings.

provider

public HibernatePersistenceConfiguration provider(String providerClassName)

Overrides:

provider in class PersistenceConfiguration

jtaDataSource

public HibernatePersistenceConfiguration jtaDataSource(String dataSourceJndiName)

Overrides:

jtaDataSource in class PersistenceConfiguration

nonJtaDataSource

public HibernatePersistenceConfiguration nonJtaDataSource(String dataSourceJndiName)

Overrides:

nonJtaDataSource in class PersistenceConfiguration

managedClass

public HibernatePersistenceConfiguration managedClass(Class<?> managedClass)

Overrides:

managedClass in class PersistenceConfiguration

mappingFile

public HibernatePersistenceConfiguration mappingFile(String name)

Overrides:

mappingFile in class PersistenceConfiguration

transactionType

public HibernatePersistenceConfiguration transactionType(PersistenceUnitTransactionType transactionType)

Overrides:

transactionType in class PersistenceConfiguration

sharedCacheMode

public HibernatePersistenceConfiguration sharedCacheMode(SharedCacheMode sharedCacheMode)

Overrides:

sharedCacheMode in class PersistenceConfiguration

validationMode

public HibernatePersistenceConfiguration validationMode(ValidationMode validationMode)

Overrides:

validationMode in class PersistenceConfiguration

property

public HibernatePersistenceConfiguration property(String name,
 Object value)

Overrides:

property in class PersistenceConfiguration

properties

public HibernatePersistenceConfiguration properties(Map<String,?> properties)

Overrides:

properties in class PersistenceConfiguration