Package org.hibernate.boot.spi

Class AbstractDelegatingSessionFactoryOptions

java.lang.Object

org.hibernate.boot.spi.AbstractDelegatingSessionFactoryOptions

All Implemented Interfaces:

SessionFactoryOptions, QueryEngineOptions

public class AbstractDelegatingSessionFactoryOptions
extends Object
implements SessionFactoryOptions

Convenience base class for custom implementations of SessionFactoryOptions using delegation.

Implementation Note:

Declared non-abstract to ensure that all SessionFactoryOptions methods have at least a default implementation.

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingSessionFactoryOptions(SessionFactoryOptions delegate)

Method Summary

Modifier and Type	Method	Description
boolean	allowImmutableEntityUpdate()
boolean	areJPACallbacksEnabled()	Should JPA entity lifecycle callbacks be processed by the EventEngine and CallbackRegistry?
protected SessionFactoryOptions	delegate()
boolean	doesConnectionProviderDisableAutoCommit()	Do newly-obtained JDBC connections come with autocommit already disabled?
BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()
Object	getBeanManagerReference()
String	getCacheRegionPrefix()	A factory-specific prefix to be applied to all cache region names.
CacheRetrieveMode	getCacheRetrieveMode(Map<String,Object> properties)	Determine the default CacheRetrieveMode, given the current session properties.
CacheStoreMode	getCacheStoreMode(Map<String,Object> properties)	Determine the default CacheStoreMode, given the current session properties.
ValueHandlingMode	getCriteriaValueHandlingMode()
CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()	Obtain a reference to the current tenant identifier resolver, if any, or return null is there is no resolver configured.
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()	A custom strategy for determining if an entity instance is dirty.
HqlTranslator	getCustomHqlTranslator()	Translator for transforming HQL (as an Antlr parse tree) into an SQM tree.
Map<String,SqmFunctionDescriptor>	getCustomSqlFunctionMap()	User defined SQM functions available for use in HQL and Criteria.
SqmFunctionRegistry	getCustomSqmFunctionRegistry()	User supplied registry of SQM functions available for use in HQL and Criteria
SqmMultiTableInsertStrategy	getCustomSqmMultiTableInsertStrategy()	Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.
SqmMultiTableMutationStrategy	getCustomSqmMultiTableMutationStrategy()	Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.
SqmTranslatorFactory	getCustomSqmTranslatorFactory()	Factory for translators transforming an SQM tree into a different form.
int	getDefaultBatchFetchSize()	The default batch size for batch fetching in new sessions.
String	getDefaultCatalog()	The default catalog to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit catalog in XML mapping).
LockOptions	getDefaultLockOptions()	The default lock scope and lock timeout.
Nulls	getDefaultNullPrecedence()	The default precedence of null values in sorted query results.
String	getDefaultSchema()	The default schema to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit schema in XML mapping).
Map<String,Object>	getDefaultSessionProperties()	Default properties for brand-new sessions.
JavaType<Object>	getDefaultTenantIdentifierJavaType()	The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.
TimeZoneStorageStrategy	getDefaultTimeZoneStorageStrategy()
EntityNameResolver[]	getEntityNameResolvers()	An array of custom entity name resolvers.
EntityNotFoundDelegate	getEntityNotFoundDelegate()	Get the delegate for handling entity-not-found exception conditions.
ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()
CacheMode	getInitialSessionCacheMode()	The default initial CacheMode for new sessions.
FlushMode	getInitialSessionFlushMode()	The default initial FlushMode for new sessions.
Interceptor	getInterceptor()	An interceptor instance shared between all sessions created by this factory.
int	getJdbcBatchSize()	The default JDBC statement batch size for new sessions.
Integer	getJdbcFetchSize()
TimeZone	getJdbcTimeZone()	The timezone to use when interacting with JDBC.
JpaCompliance	getJpaCompliance()
FormatMapper	getJsonFormatMapper()	The format mapper to use for serializing/deserializing JSON data.
Integer	getMaximumFetchDepth()
boolean	getNativeJdbcParametersIgnored()
PhysicalConnectionHandlingMode	getPhysicalConnectionHandlingMode()
int	getPreferredSqlTypeCodeForArray()
int	getPreferredSqlTypeCodeForBoolean()
int	getPreferredSqlTypeCodeForDuration()
int	getPreferredSqlTypeCodeForInstant()
int	getPreferredSqlTypeCodeForUuid()
CacheLayout	getQueryCacheLayout()	The layout of entries in the query cache.
int	getQueryStatisticsMaxSize()	The number of QueryStatistics entries that should be stored by Statistics.
SchemaAutoTooling	getSchemaAutoTooling()	Deprecated.
StandardServiceRegistry	getServiceRegistry()	The service registry to use in building the factory.
String	getSessionFactoryName()	The name to be used for the SessionFactory.
SessionFactoryObserver[]	getSessionFactoryObservers()	Observers for events raised by the factory.
Supplier<? extends Interceptor>	getStatelessInterceptorImplementorSupplier()	A stateless Supplier for interceptor instances which are not shared between sessions created by this factory.
StatementInspector	getStatementInspector()	The default StatementInspector for this factory.
TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()	Deprecated.
TimestampsCacheFactory	getTimestampsCacheFactory()	A factory for the TimestampsCache used to track invalidation of cached query result sets.
String	getUuid()	Get the UUID unique to this SessionFactoryOptions.
Object	getValidatorFactoryReference()
FormatMapper	getXmlFormatMapper()	The format mapper to use for serializing/deserializing XML data.
boolean	inClauseParameterPaddingEnabled()
boolean	isAllowOutOfTransactionUpdateOperations()
boolean	isAllowRefreshDetachedEntity()	Deprecated, for removal: This API element is subject to removal in a future version. with no replacement.
boolean	isAutoCloseSessionEnabled()
boolean	isAutoEvictCollectionCache()
boolean	isCheckNullability()	Should Hibernate validate that non-optional attributes have non-null values?
boolean	isCollectionsInDefaultFetchGroupEnabled()
boolean	isCommentsEnabled()	Should explanatory comment text be added to the generated SQL?
boolean	isCriteriaCopyTreeEnabled()
boolean	isCriteriaPlanCacheEnabled()
boolean	isDelayBatchFetchLoaderCreationsEnabled()
boolean	isDirectReferenceCacheEntriesEnabled()
boolean	isFailOnPaginationOverCollectionFetchEnabled()
boolean	isFlushBeforeCompletionEnabled()
boolean	isGetGeneratedKeysEnabled()
boolean	isIdentifierRollbackEnabled()	Should generated identifiers be reset after entity removal?
boolean	isInitializeLazyStateOutsideTransactionsEnabled()	Are detached proxies and collections fetched in a temporary persistence context?
boolean	isJpaBootstrap()	Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate-native bootstrapping?
boolean	isJsonFunctionsEnabled()
boolean	isJtaTrackByThread()
boolean	isJtaTransactionAccessEnabled()
boolean	isMinimalPutsEnabled()	Should we avoid overwriting cache entries with identical entries?
boolean	isMultiTenancyEnabled()	Is there a multi-tenant connection provider configured?
boolean	isNamedQueryStartupCheckingEnabled()	Are named queries validated when the factory is created?
boolean	isOrderInsertsEnabled()
boolean	isOrderUpdatesEnabled()
boolean	isPassProcedureParameterNames()
boolean	isPortableIntegerDivisionEnabled()	Should HQL integer division HQL should produce an integer on Oracle, MySQL, and MariaDB, where the / operator produces a non-integer.
boolean	isPreferJavaTimeJdbcTypesEnabled()
boolean	isPreferJdbcDatetimeTypesInNativeQueriesEnabled()	Should native queries return JDBC datetime types instead of using java.time types.
boolean	isPreferNativeEnumTypesEnabled()
boolean	isPreferUserTransaction()
boolean	isQueryCacheEnabled()	Is the query cache enabled?
boolean	isReleaseResourcesOnCloseEnabled()	Deprecated.
boolean	isScrollableResultSetsEnabled()
boolean	isSecondLevelCacheEnabled()	Is the second-level cache enabled?
Boolean	isSessionFactoryNameAlsoJndiName()	Is the session factory name also a JNDI name, indicating we should bind it into JNDI?
boolean	isStatisticsEnabled()	Is collection of statistics enabled by default for this factory?
boolean	isStructuredCacheEntriesEnabled()	Are second-level cache entries stored in a human-readable format.
boolean	isSubselectFetchEnabled()	Is subselect fetching enabled by default in new sessions?
boolean	isUnownedAssociationTransientCheck()
boolean	isUseOfJdbcNamedParametersEnabled()	Controls whether Hibernate should try to map named parameter names specified in a ProcedureCall or StoredProcedureQuery to named parameters in the JDBC CallableStatement.
boolean	isXmlFormatMapperLegacyFormatEnabled()	Whether to use the legacy format for serializing/deserializing XML data.
boolean	isXmlFunctionsEnabled()
void	setCheckNullability(boolean enabled)	Allows Bean Validation to disable null checking.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.boot.spi.SessionFactoryOptions

buildSessionEventListeners

Constructor Details

AbstractDelegatingSessionFactoryOptions

public AbstractDelegatingSessionFactoryOptions(SessionFactoryOptions delegate)

Method Details

delegate

protected SessionFactoryOptions delegate()

getUuid

public String getUuid()

Description copied from interface: SessionFactoryOptions

Get the UUID unique to this SessionFactoryOptions. Will be the same value available as SessionFactoryImplementor.getUuid().

Specified by:

getUuid in interface QueryEngineOptions

Specified by:

getUuid in interface SessionFactoryOptions

Returns:

The UUID for this SessionFactory.

See Also:

• SessionFactoryRegistry.getSessionFactory(java.lang.String)
• SessionFactoryImplementor.getUuid()

getServiceRegistry

public StandardServiceRegistry getServiceRegistry()

Description copied from interface: SessionFactoryOptions

The service registry to use in building the factory.

Specified by:

getServiceRegistry in interface SessionFactoryOptions

Returns:

The service registry to use.

isJpaBootstrap

public boolean isJpaBootstrap()

Description copied from interface: SessionFactoryOptions

Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate-native bootstrapping?

Specified by:

isJpaBootstrap in interface SessionFactoryOptions

Returns:

true indicates the SessionFactory was built through JPA bootstrapping; false indicates it was built through native bootstrapping.

isJtaTransactionAccessEnabled

public boolean isJtaTransactionAccessEnabled()

Specified by:

isJtaTransactionAccessEnabled in interface SessionFactoryOptions

See Also:

• TransactionSettings.ALLOW_JTA_TRANSACTION_ACCESS

isAllowRefreshDetachedEntity

@Deprecated(since="7.0",
            forRemoval=true)
public boolean isAllowRefreshDetachedEntity()

Deprecated, for removal: This API element is subject to removal in a future version.

with no replacement.

Specified by:

isAllowRefreshDetachedEntity in interface SessionFactoryOptions

getBeanManagerReference

public Object getBeanManagerReference()

Specified by:

getBeanManagerReference in interface SessionFactoryOptions

See Also:

• ManagedBeanSettings.JAKARTA_CDI_BEAN_MANAGER

getValidatorFactoryReference

public Object getValidatorFactoryReference()

Specified by:

getValidatorFactoryReference in interface SessionFactoryOptions

See Also:

• ValidationSettings.JAKARTA_VALIDATION_FACTORY

getSessionFactoryName

public String getSessionFactoryName()

Description copied from interface: SessionFactoryOptions

The name to be used for the SessionFactory. This is used during in-VM serialization; see SessionFactoryRegistry. May also be used as a JNDI name, depending on "hibernate.session_factory_jndi_name" and "hibernate.session_factory_name_is_jndi".

Specified by:

getSessionFactoryName in interface QueryEngineOptions

Specified by:

getSessionFactoryName in interface SessionFactoryOptions

Returns:

The session factory name

See Also:

• PersistenceSettings.SESSION_FACTORY_NAME

isSessionFactoryNameAlsoJndiName

public Boolean isSessionFactoryNameAlsoJndiName()

Description copied from interface: SessionFactoryOptions

Is the session factory name also a JNDI name, indicating we should bind it into JNDI?

Specified by:

isSessionFactoryNameAlsoJndiName in interface SessionFactoryOptions

Returns:

true if the SessionFactory name is also a JNDI name; false otherwise.

See Also:

• PersistenceSettings.SESSION_FACTORY_NAME_IS_JNDI

isFlushBeforeCompletionEnabled

public boolean isFlushBeforeCompletionEnabled()

Specified by:

isFlushBeforeCompletionEnabled in interface SessionFactoryOptions

See Also:

• TransactionSettings.FLUSH_BEFORE_COMPLETION

isAutoCloseSessionEnabled

public boolean isAutoCloseSessionEnabled()

Specified by:

isAutoCloseSessionEnabled in interface SessionFactoryOptions

See Also:

• TransactionSettings.AUTO_CLOSE_SESSION

isStatisticsEnabled

public boolean isStatisticsEnabled()

Description copied from interface: SessionFactoryOptions

Is collection of statistics enabled by default for this factory?

Specified by:

isStatisticsEnabled in interface SessionFactoryOptions

See Also:

• StatisticsSettings.GENERATE_STATISTICS
• Statistics.setStatisticsEnabled(boolean)

getInterceptor

public Interceptor getInterceptor()

Description copied from interface: SessionFactoryOptions

An interceptor instance shared between all sessions created by this factory. Such an interceptor must be thread-safe and may not hold state associated with any given session.

Specified by:

getInterceptor in interface SessionFactoryOptions

Returns:

The interceptor instance to use factory-wide by default. May be null.

See Also:

• SessionEventSettings.INTERCEPTOR
• SessionBuilder.interceptor(Interceptor)

getCustomSqmMultiTableMutationStrategy

public SqmMultiTableMutationStrategy getCustomSqmMultiTableMutationStrategy()

Description copied from interface: QueryEngineOptions

Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries where the target of the mutation is a multi-table entity.

Specified by:

getCustomSqmMultiTableMutationStrategy in interface QueryEngineOptions

See Also:

• QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY

getCustomSqmMultiTableInsertStrategy

public SqmMultiTableInsertStrategy getCustomSqmMultiTableInsertStrategy()

Description copied from interface: QueryEngineOptions

Contract for handling SQM trees representing insertion (INSERT) queries where the target of the mutation is a multi-table entity.

Specified by:

getCustomSqmMultiTableInsertStrategy in interface QueryEngineOptions

See Also:

• QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY

getStatementInspector

public StatementInspector getStatementInspector()

Description copied from interface: SessionFactoryOptions

The default StatementInspector for this factory.

Specified by:

getStatementInspector in interface SessionFactoryOptions

See Also:

• JdbcSettings.STATEMENT_INSPECTOR
• SessionBuilder.statementInspector(StatementInspector)

getSessionFactoryObservers

public SessionFactoryObserver[] getSessionFactoryObservers()

Description copied from interface: SessionFactoryOptions

Observers for events raised by the factory.

Specified by:

getSessionFactoryObservers in interface SessionFactoryOptions

See Also:

• PersistenceSettings.SESSION_FACTORY_OBSERVER

getBaselineSessionEventsListenerBuilder

public BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

Specified by:

getBaselineSessionEventsListenerBuilder in interface SessionFactoryOptions

isIdentifierRollbackEnabled

public boolean isIdentifierRollbackEnabled()

Description copied from interface: SessionFactoryOptions

Should generated identifiers be reset after entity removal?

Specified by:

isIdentifierRollbackEnabled in interface SessionFactoryOptions

See Also:

• AvailableSettings.USE_IDENTIFIER_ROLLBACK
• SessionBuilder.identifierRollback(boolean)

isCheckNullability

public boolean isCheckNullability()

Description copied from interface: SessionFactoryOptions

Should Hibernate validate that non-optional attributes have non-null values?

Specified by:

isCheckNullability in interface SessionFactoryOptions

See Also:

• ValidationSettings.CHECK_NULLABILITY

isInitializeLazyStateOutsideTransactionsEnabled

public boolean isInitializeLazyStateOutsideTransactionsEnabled()

Description copied from interface: SessionFactoryOptions

Are detached proxies and collections fetched in a temporary persistence context?

Specified by:

isInitializeLazyStateOutsideTransactionsEnabled in interface SessionFactoryOptions

See Also:

• TransactionSettings.ENABLE_LAZY_LOAD_NO_TRANS

getTempTableDdlTransactionHandling

@Deprecated
public TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

Deprecated.

Description copied from interface: SessionFactoryOptions

This is unused and will be removed.

Specified by:

getTempTableDdlTransactionHandling in interface SessionFactoryOptions

isDelayBatchFetchLoaderCreationsEnabled

public boolean isDelayBatchFetchLoaderCreationsEnabled()

Specified by:

isDelayBatchFetchLoaderCreationsEnabled in interface SessionFactoryOptions

See Also:

• AvailableSettings.DELAY_ENTITY_LOADER_CREATIONS

getDefaultBatchFetchSize

public int getDefaultBatchFetchSize()

Description copied from interface: SessionFactoryOptions

The default batch size for batch fetching in new sessions.

Specified by:

getDefaultBatchFetchSize in interface SessionFactoryOptions

See Also:

• FetchSettings.DEFAULT_BATCH_FETCH_SIZE
• Session.setFetchBatchSize(int)

getMaximumFetchDepth

public Integer getMaximumFetchDepth()

Specified by:

getMaximumFetchDepth in interface SessionFactoryOptions

See Also:

• FetchSettings.MAX_FETCH_DEPTH

isSubselectFetchEnabled

public boolean isSubselectFetchEnabled()

Description copied from interface: SessionFactoryOptions

Is subselect fetching enabled by default in new sessions?

Specified by:

isSubselectFetchEnabled in interface SessionFactoryOptions

See Also:

• FetchSettings.USE_SUBSELECT_FETCH
• Session.setSubselectFetchingEnabled(boolean)

getDefaultNullPrecedence

public Nulls getDefaultNullPrecedence()

Description copied from interface: SessionFactoryOptions

The default precedence of null values in sorted query results.

Specified by:

getDefaultNullPrecedence in interface SessionFactoryOptions

See Also:

• QuerySettings.DEFAULT_NULL_ORDERING

isOrderUpdatesEnabled

public boolean isOrderUpdatesEnabled()

Specified by:

isOrderUpdatesEnabled in interface SessionFactoryOptions

See Also:

• BatchSettings.ORDER_UPDATES

isOrderInsertsEnabled

public boolean isOrderInsertsEnabled()

Specified by:

isOrderInsertsEnabled in interface SessionFactoryOptions

See Also:

• BatchSettings.ORDER_INSERTS

isMultiTenancyEnabled

public boolean isMultiTenancyEnabled()

Description copied from interface: SessionFactoryOptions

Is there a multi-tenant connection provider configured?

Specified by:

isMultiTenancyEnabled in interface SessionFactoryOptions

See Also:

• MultiTenancySettings.MULTI_TENANT_CONNECTION_PROVIDER

getCurrentTenantIdentifierResolver

public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Description copied from interface: SessionFactoryOptions

Obtain a reference to the current tenant identifier resolver, if any, or return null is there is no resolver configured.

Specified by:

getCurrentTenantIdentifierResolver in interface SessionFactoryOptions

See Also:

• MultiTenancySettings.MULTI_TENANT_IDENTIFIER_RESOLVER

getDefaultTenantIdentifierJavaType

public JavaType<Object> getDefaultTenantIdentifierJavaType()

Description copied from interface: SessionFactoryOptions

The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.

Specified by:

getDefaultTenantIdentifierJavaType in interface SessionFactoryOptions

isJtaTrackByThread

public boolean isJtaTrackByThread()

Specified by:

isJtaTrackByThread in interface SessionFactoryOptions

See Also:

• TransactionSettings.JTA_TRACK_BY_THREAD

isNamedQueryStartupCheckingEnabled

public boolean isNamedQueryStartupCheckingEnabled()

Description copied from interface: SessionFactoryOptions

Are named queries validated when the factory is created?

Specified by:

isNamedQueryStartupCheckingEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.QUERY_STARTUP_CHECKING

isAllowOutOfTransactionUpdateOperations

public boolean isAllowOutOfTransactionUpdateOperations()

Specified by:

isAllowOutOfTransactionUpdateOperations in interface SessionFactoryOptions

See Also:

• TransactionSettings.ALLOW_UPDATE_OUTSIDE_TRANSACTION

isReleaseResourcesOnCloseEnabled

@Deprecated
public boolean isReleaseResourcesOnCloseEnabled()

Deprecated.

Specified by:

isReleaseResourcesOnCloseEnabled in interface SessionFactoryOptions

See Also:

• AvailableSettings.DISCARD_PC_ON_CLOSE

isSecondLevelCacheEnabled

public boolean isSecondLevelCacheEnabled()

Description copied from interface: SessionFactoryOptions

Is the second-level cache enabled?

Specified by:

isSecondLevelCacheEnabled in interface SessionFactoryOptions

See Also:

• CacheSettings.USE_SECOND_LEVEL_CACHE

isQueryCacheEnabled

public boolean isQueryCacheEnabled()

Description copied from interface: SessionFactoryOptions

Is the query cache enabled?

Specified by:

isQueryCacheEnabled in interface SessionFactoryOptions

See Also:

• CacheSettings.USE_QUERY_CACHE

getQueryCacheLayout

public CacheLayout getQueryCacheLayout()

Description copied from interface: SessionFactoryOptions

The layout of entries in the query cache.

Specified by:

getQueryCacheLayout in interface SessionFactoryOptions

See Also:

• CacheSettings.QUERY_CACHE_LAYOUT

getTimestampsCacheFactory

public TimestampsCacheFactory getTimestampsCacheFactory()

Description copied from interface: SessionFactoryOptions

A factory for the TimestampsCache used to track invalidation of cached query result sets.

Specified by:

getTimestampsCacheFactory in interface SessionFactoryOptions

See Also:

• CacheSettings.QUERY_CACHE_FACTORY

getCacheRegionPrefix

public String getCacheRegionPrefix()

Description copied from interface: SessionFactoryOptions

A factory-specific prefix to be applied to all cache region names.

Specified by:

getCacheRegionPrefix in interface SessionFactoryOptions

See Also:

• CacheSettings.CACHE_REGION_PREFIX

isMinimalPutsEnabled

public boolean isMinimalPutsEnabled()

Description copied from interface: SessionFactoryOptions

Should we avoid overwriting cache entries with identical entries?

This is useful if cache writes are much more expensive than cache reads.

Specified by:

isMinimalPutsEnabled in interface SessionFactoryOptions

See Also:

• CacheSettings.USE_MINIMAL_PUTS

isStructuredCacheEntriesEnabled

public boolean isStructuredCacheEntriesEnabled()

Description copied from interface: SessionFactoryOptions

Are second-level cache entries stored in a human-readable format.

Specified by:

isStructuredCacheEntriesEnabled in interface SessionFactoryOptions

See Also:

• CacheSettings.USE_STRUCTURED_CACHE

isDirectReferenceCacheEntriesEnabled

public boolean isDirectReferenceCacheEntriesEnabled()

Specified by:

isDirectReferenceCacheEntriesEnabled in interface SessionFactoryOptions

See Also:

• CacheSettings.USE_DIRECT_REFERENCE_CACHE_ENTRIES

isAutoEvictCollectionCache

public boolean isAutoEvictCollectionCache()

Specified by:

isAutoEvictCollectionCache in interface SessionFactoryOptions

See Also:

• CacheSettings.AUTO_EVICT_COLLECTION_CACHE

getSchemaAutoTooling

@Deprecated
public SchemaAutoTooling getSchemaAutoTooling()

Deprecated.

Specified by:

getSchemaAutoTooling in interface SessionFactoryOptions

See Also:

• SchemaToolingSettings.HBM2DDL_AUTO

getJdbcBatchSize

public int getJdbcBatchSize()

Description copied from interface: SessionFactoryOptions

The default JDBC statement batch size for new sessions.

Specified by:

getJdbcBatchSize in interface SessionFactoryOptions

See Also:

• BatchSettings.STATEMENT_BATCH_SIZE
• SharedSessionContract.setJdbcBatchSize(Integer)

isScrollableResultSetsEnabled

public boolean isScrollableResultSetsEnabled()

Specified by:

isScrollableResultSetsEnabled in interface SessionFactoryOptions

See Also:

• JdbcSettings.USE_SCROLLABLE_RESULTSET

isGetGeneratedKeysEnabled

public boolean isGetGeneratedKeysEnabled()

Specified by:

isGetGeneratedKeysEnabled in interface SessionFactoryOptions

See Also:

• JdbcSettings.USE_GET_GENERATED_KEYS

getJdbcFetchSize

public Integer getJdbcFetchSize()

Specified by:

getJdbcFetchSize in interface SessionFactoryOptions

See Also:

• JdbcSettings.STATEMENT_FETCH_SIZE

getPhysicalConnectionHandlingMode

public PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

Specified by:

getPhysicalConnectionHandlingMode in interface SessionFactoryOptions

See Also:

• JdbcSettings.CONNECTION_HANDLING
• SessionBuilder.connectionHandlingMode(PhysicalConnectionHandlingMode)

doesConnectionProviderDisableAutoCommit

public boolean doesConnectionProviderDisableAutoCommit()

Description copied from interface: SessionFactoryOptions

Do newly-obtained JDBC connections come with autocommit already disabled?

Specified by:

doesConnectionProviderDisableAutoCommit in interface SessionFactoryOptions

See Also:

• JdbcSettings.CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT

isCommentsEnabled

public boolean isCommentsEnabled()

Description copied from interface: SessionFactoryOptions

Should explanatory comment text be added to the generated SQL?

Specified by:

isCommentsEnabled in interface SessionFactoryOptions

See Also:

• JdbcSettings.USE_SQL_COMMENTS

getCustomEntityDirtinessStrategy

public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Description copied from interface: SessionFactoryOptions

A custom strategy for determining if an entity instance is dirty.

Specified by:

getCustomEntityDirtinessStrategy in interface SessionFactoryOptions

See Also:

• AvailableSettings.CUSTOM_ENTITY_DIRTINESS_STRATEGY

getEntityNameResolvers

public EntityNameResolver[] getEntityNameResolvers()

Description copied from interface: SessionFactoryOptions

An array of custom entity name resolvers.

Specified by:

getEntityNameResolvers in interface SessionFactoryOptions

See Also:

• Configuration.addEntityNameResolver(EntityNameResolver)

getEntityNotFoundDelegate

public EntityNotFoundDelegate getEntityNotFoundDelegate()

Description copied from interface: SessionFactoryOptions

Get the delegate for handling entity-not-found exception conditions.

Returns StandardEntityNotFoundDelegate by default.

Specified by:

getEntityNotFoundDelegate in interface SessionFactoryOptions

Returns:

The specific EntityNotFoundDelegate to use, may be null

See Also:

• Configuration.setEntityNotFoundDelegate(org.hibernate.proxy.EntityNotFoundDelegate)

getCustomSqlFunctionMap

public Map<String,SqmFunctionDescriptor> getCustomSqlFunctionMap()

Description copied from interface: QueryEngineOptions

User defined SQM functions available for use in HQL and Criteria.

Ultimately made available to the SqmTranslatorFactory for use in translating an SQM tree.

Can be used in conjunction with QueryEngineOptions.getCustomSqmFunctionRegistry(), but generally one or the other will be used.

Specified by:

getCustomSqlFunctionMap in interface QueryEngineOptions

setCheckNullability

public void setCheckNullability(boolean enabled)

Description copied from interface: SessionFactoryOptions

Allows Bean Validation to disable null checking.

Specified by:

setCheckNullability in interface SessionFactoryOptions

isPreferUserTransaction

public boolean isPreferUserTransaction()

Specified by:

isPreferUserTransaction in interface SessionFactoryOptions

See Also:

• TransactionSettings.PREFER_USER_TRANSACTION

getStatelessInterceptorImplementorSupplier

public Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

Description copied from interface: SessionFactoryOptions

A stateless Supplier for interceptor instances which are not shared between sessions created by this factory. This allows each Interceptor instances itself to hold state associated with its session.

Specified by:

getStatelessInterceptorImplementorSupplier in interface SessionFactoryOptions

Returns:

The interceptor supplier to use by default. May be null.

See Also:

• SessionEventSettings.SESSION_SCOPED_INTERCEPTOR
• SessionBuilder.interceptor(Interceptor)

getCustomHqlTranslator

public HqlTranslator getCustomHqlTranslator()

Description copied from interface: QueryEngineOptions

Translator for transforming HQL (as an Antlr parse tree) into an SQM tree.

Specified by:

getCustomHqlTranslator in interface QueryEngineOptions

See Also:

• org.hibernate.query.hql
• QuerySettings.SEMANTIC_QUERY_PRODUCER

getCustomSqmTranslatorFactory

public SqmTranslatorFactory getCustomSqmTranslatorFactory()

Description copied from interface: QueryEngineOptions

Factory for translators transforming an SQM tree into a different form. For standard ORM implementations this will generally be some form of SQL tree.

Specified by:

getCustomSqmTranslatorFactory in interface QueryEngineOptions

See Also:

• org.hibernate.sql.ast.tree
• QuerySettings.SEMANTIC_QUERY_TRANSLATOR

getJdbcTimeZone

public TimeZone getJdbcTimeZone()

Description copied from interface: SessionFactoryOptions

The timezone to use when interacting with JDBC.

Specified by:

getJdbcTimeZone in interface SessionFactoryOptions

See Also:

• JdbcSettings.JDBC_TIME_ZONE
• SessionBuilder.jdbcTimeZone(TimeZone)

getCriteriaValueHandlingMode

public ValueHandlingMode getCriteriaValueHandlingMode()

Specified by:

getCriteriaValueHandlingMode in interface QueryEngineOptions

See Also:

• QuerySettings.CRITERIA_VALUE_HANDLING_MODE

isCriteriaCopyTreeEnabled

public boolean isCriteriaCopyTreeEnabled()

Specified by:

isCriteriaCopyTreeEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.CRITERIA_COPY_TREE

isCriteriaPlanCacheEnabled

public boolean isCriteriaPlanCacheEnabled()

Specified by:

isCriteriaPlanCacheEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.CRITERIA_PLAN_CACHE_ENABLED

getNativeJdbcParametersIgnored

public boolean getNativeJdbcParametersIgnored()

Specified by:

getNativeJdbcParametersIgnored in interface SessionFactoryOptions

See Also:

• QuerySettings.NATIVE_IGNORE_JDBC_PARAMETERS

getJpaCompliance

public JpaCompliance getJpaCompliance()

Specified by:

getJpaCompliance in interface QueryEngineOptions

Specified by:

getJpaCompliance in interface SessionFactoryOptions

See Also:

• JpaComplianceSettings

isFailOnPaginationOverCollectionFetchEnabled

public boolean isFailOnPaginationOverCollectionFetchEnabled()

Specified by:

isFailOnPaginationOverCollectionFetchEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH

getImmutableEntityUpdateQueryHandlingMode

public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

Specified by:

getImmutableEntityUpdateQueryHandlingMode in interface QueryEngineOptions

See Also:

• QuerySettings.IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE

allowImmutableEntityUpdate

public boolean allowImmutableEntityUpdate()

Specified by:

allowImmutableEntityUpdate in interface QueryEngineOptions

See Also:

• QuerySettings.IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE

getDefaultCatalog

public String getDefaultCatalog()

Description copied from interface: SessionFactoryOptions

The default catalog to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit catalog in XML mapping).

Specified by:

getDefaultCatalog in interface SessionFactoryOptions

Returns:

The default catalog to use.

See Also:

• MappingSettings.DEFAULT_CATALOG

getDefaultSchema

public String getDefaultSchema()

Description copied from interface: SessionFactoryOptions

The default schema to use in generated SQL when a catalog wasn't specified in the mapping, neither explicitly nor implicitly (see the concept of implicit schema in XML mapping).

Specified by:

getDefaultSchema in interface SessionFactoryOptions

Returns:

The default schema to use.

See Also:

• MappingSettings.DEFAULT_SCHEMA

inClauseParameterPaddingEnabled

public boolean inClauseParameterPaddingEnabled()

Specified by:

inClauseParameterPaddingEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.IN_CLAUSE_PARAMETER_PADDING

isJsonFunctionsEnabled

public boolean isJsonFunctionsEnabled()

Specified by:

isJsonFunctionsEnabled in interface QueryEngineOptions

See Also:

• QuerySettings.JSON_FUNCTIONS_ENABLED

isXmlFunctionsEnabled

public boolean isXmlFunctionsEnabled()

Specified by:

isXmlFunctionsEnabled in interface QueryEngineOptions

See Also:

• QuerySettings.XML_FUNCTIONS_ENABLED

isPortableIntegerDivisionEnabled

public boolean isPortableIntegerDivisionEnabled()

Description copied from interface: QueryEngineOptions

Should HQL integer division HQL should produce an integer on Oracle, MySQL, and MariaDB, where the / operator produces a non-integer.

Specified by:

isPortableIntegerDivisionEnabled in interface QueryEngineOptions

See Also:

• QuerySettings.PORTABLE_INTEGER_DIVISION

getQueryStatisticsMaxSize

public int getQueryStatisticsMaxSize()

Description copied from interface: SessionFactoryOptions

The number of QueryStatistics entries that should be stored by Statistics.

Specified by:

getQueryStatisticsMaxSize in interface SessionFactoryOptions

See Also:

• StatisticsSettings.QUERY_STATISTICS_MAX_SIZE

areJPACallbacksEnabled

public boolean areJPACallbacksEnabled()

Description copied from interface: SessionFactoryOptions

Should JPA entity lifecycle callbacks be processed by the EventEngine and CallbackRegistry?

Specified by:

areJPACallbacksEnabled in interface SessionFactoryOptions

See Also:

• PersistenceSettings.JPA_CALLBACKS_ENABLED

isCollectionsInDefaultFetchGroupEnabled

public boolean isCollectionsInDefaultFetchGroupEnabled()

Specified by:

isCollectionsInDefaultFetchGroupEnabled in interface SessionFactoryOptions

isUnownedAssociationTransientCheck

public boolean isUnownedAssociationTransientCheck()

Specified by:

isUnownedAssociationTransientCheck in interface SessionFactoryOptions

See Also:

• PersistenceSettings.UNOWNED_ASSOCIATION_TRANSIENT_CHECK

isUseOfJdbcNamedParametersEnabled

public boolean isUseOfJdbcNamedParametersEnabled()

Description copied from interface: SessionFactoryOptions

Controls whether Hibernate should try to map named parameter names specified in a ProcedureCall or StoredProcedureQuery to named parameters in the JDBC CallableStatement.

As JPA is defined, the use of named parameters is essentially of dubious value since by spec the parameters have to be defined in the order they are defined in the procedure/function declaration - we can always bind them positionally. The whole idea of named parameters for CallableStatement is the ability to bind these in any order, but since we unequivocally know the order anyway binding them via name really gains nothing.

If this is true, we still need to make sure the Dialect supports named binding. Setting this to false simply circumvents that check and always performs positional binding.

Specified by:

isUseOfJdbcNamedParametersEnabled in interface SessionFactoryOptions

Returns:

true indicates we should try to use CallableStatement named parameters, if the Dialect says it is supported; false indicates that we should never try to use CallableStatement named parameters, regardless of what the Dialect says.

See Also:

• QuerySettings.CALLABLE_NAMED_PARAMS_ENABLED

getCustomSqmFunctionRegistry

public SqmFunctionRegistry getCustomSqmFunctionRegistry()

Description copied from interface: QueryEngineOptions

User supplied registry of SQM functions available for use in HQL and Criteria

Can be used in conjunction with QueryEngineOptions.getCustomSqlFunctionMap(), but generally one or the other will be used.

Specified by:

getCustomSqmFunctionRegistry in interface QueryEngineOptions

getPreferredSqlTypeCodeForBoolean

public int getPreferredSqlTypeCodeForBoolean()

Specified by:

getPreferredSqlTypeCodeForBoolean in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE

getPreferredSqlTypeCodeForDuration

public int getPreferredSqlTypeCodeForDuration()

Specified by:

getPreferredSqlTypeCodeForDuration in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFERRED_DURATION_JDBC_TYPE

getPreferredSqlTypeCodeForUuid

public int getPreferredSqlTypeCodeForUuid()

Specified by:

getPreferredSqlTypeCodeForUuid in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFERRED_UUID_JDBC_TYPE

getPreferredSqlTypeCodeForInstant

public int getPreferredSqlTypeCodeForInstant()

Specified by:

getPreferredSqlTypeCodeForInstant in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFERRED_INSTANT_JDBC_TYPE

getPreferredSqlTypeCodeForArray

public int getPreferredSqlTypeCodeForArray()

Specified by:

getPreferredSqlTypeCodeForArray in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFERRED_ARRAY_JDBC_TYPE

getDefaultTimeZoneStorageStrategy

public TimeZoneStorageStrategy getDefaultTimeZoneStorageStrategy()

Specified by:

getDefaultTimeZoneStorageStrategy in interface SessionFactoryOptions

See Also:

• MappingSettings.TIMEZONE_DEFAULT_STORAGE

isPreferJavaTimeJdbcTypesEnabled

public boolean isPreferJavaTimeJdbcTypesEnabled()

Specified by:

isPreferJavaTimeJdbcTypesEnabled in interface SessionFactoryOptions

See Also:

• MappingSettings.JAVA_TIME_USE_DIRECT_JDBC

isPreferNativeEnumTypesEnabled

public boolean isPreferNativeEnumTypesEnabled()

Specified by:

isPreferNativeEnumTypesEnabled in interface SessionFactoryOptions

See Also:

• MappingSettings.PREFER_NATIVE_ENUM_TYPES

getJsonFormatMapper

public FormatMapper getJsonFormatMapper()

Description copied from interface: SessionFactoryOptions

The format mapper to use for serializing/deserializing JSON data.

Specified by:

getJsonFormatMapper in interface SessionFactoryOptions

See Also:

• MappingSettings.JSON_FORMAT_MAPPER

getXmlFormatMapper

public FormatMapper getXmlFormatMapper()

Description copied from interface: SessionFactoryOptions

The format mapper to use for serializing/deserializing XML data.

Specified by:

getXmlFormatMapper in interface SessionFactoryOptions

See Also:

• MappingSettings.XML_FORMAT_MAPPER

isXmlFormatMapperLegacyFormatEnabled

public boolean isXmlFormatMapperLegacyFormatEnabled()

Description copied from interface: SessionFactoryOptions

Whether to use the legacy format for serializing/deserializing XML data.

Specified by:

isXmlFormatMapperLegacyFormatEnabled in interface SessionFactoryOptions

See Also:

• MappingSettings.XML_FORMAT_MAPPER_LEGACY_FORMAT

isPassProcedureParameterNames

public boolean isPassProcedureParameterNames()

Specified by:

isPassProcedureParameterNames in interface SessionFactoryOptions

See Also:

• QuerySettings.QUERY_PASS_PROCEDURE_PARAMETER_NAMES

isPreferJdbcDatetimeTypesInNativeQueriesEnabled

public boolean isPreferJdbcDatetimeTypesInNativeQueriesEnabled()

Description copied from interface: SessionFactoryOptions

Should native queries return JDBC datetime types instead of using java.time types.

Specified by:

isPreferJdbcDatetimeTypesInNativeQueriesEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.NATIVE_PREFER_JDBC_DATETIME_TYPES

getCacheStoreMode

public CacheStoreMode getCacheStoreMode(Map<String,Object> properties)

Description copied from interface: SessionFactoryOptions

Determine the default CacheStoreMode, given the current session properties.

Specified by:

getCacheStoreMode in interface SessionFactoryOptions

Parameters:

properties - the Session properties

Returns:

either the CacheStoreMode as defined in the session-specific properties, or as defined in the properties shared across all sessions (the defaults).

getCacheRetrieveMode

public CacheRetrieveMode getCacheRetrieveMode(Map<String,Object> properties)

Description copied from interface: SessionFactoryOptions

Determine the default CacheRetrieveMode, given the current session properties.

Specified by:

getCacheRetrieveMode in interface SessionFactoryOptions

Parameters:

properties - the Session properties

Returns:

either the CacheRetrieveMode as defined in the session-specific properties, or as defined in the properties shared across all sessions (the defaults).

getDefaultSessionProperties

public Map<String,Object> getDefaultSessionProperties()

Description copied from interface: SessionFactoryOptions

Default properties for brand-new sessions.

Specified by:

getDefaultSessionProperties in interface SessionFactoryOptions

See Also:

• Session.setProperty(String, Object)

getInitialSessionCacheMode

public CacheMode getInitialSessionCacheMode()

Description copied from interface: SessionFactoryOptions

The default initial CacheMode for new sessions.

Specified by:

getInitialSessionCacheMode in interface SessionFactoryOptions

See Also:

• CacheSettings.JAKARTA_SHARED_CACHE_RETRIEVE_MODE
• CacheSettings.JAKARTA_SHARED_CACHE_STORE_MODE
• Session.setCacheMode(CacheMode)

getInitialSessionFlushMode

public FlushMode getInitialSessionFlushMode()

Description copied from interface: SessionFactoryOptions

The default initial FlushMode for new sessions.

Specified by:

getInitialSessionFlushMode in interface SessionFactoryOptions

See Also:

• HibernateHints.HINT_FLUSH_MODE
• SessionBuilder.flushMode(FlushMode)
• Session.setHibernateFlushMode(FlushMode)

getDefaultLockOptions

public LockOptions getDefaultLockOptions()

Description copied from interface: SessionFactoryOptions

The default lock scope and lock timeout.

Specified by:

getDefaultLockOptions in interface SessionFactoryOptions

See Also:

• AvailableSettings.JAKARTA_LOCK_TIMEOUT
• AvailableSettings.JAKARTA_LOCK_SCOPE