Package org.hibernate.boot.internal

Class SessionFactoryOptionsBuilder

java.lang.Object

org.hibernate.boot.internal.SessionFactoryOptionsBuilder

All Implemented Interfaces:

SessionFactoryOptions, QueryEngineOptions

public class SessionFactoryOptionsBuilder
extends Object
implements SessionFactoryOptions

In-flight state of SessionFactoryOptions during SessionFactoryBuilder processing.

The intention is that SessionFactoryBuilder internally creates and populates this builder, which is then used to construct the SessionFactoryOptions as part of building the SessionFactory from SessionFactoryBuilder.build().

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor	Description
SessionFactoryOptionsBuilder(StandardServiceRegistry serviceRegistry, BootstrapContext context)

Method Summary

Modifier and Type	Method	Description
void	addEntityNameResolvers(EntityNameResolver... entityNameResolvers)
void	addSessionFactoryObservers(SessionFactoryObserver... observers)
void	allowDirectReferenceCacheEntries(boolean enabled)
void	allowLazyInitializationOutsideTransaction(boolean enabled)
void	allowOutOfTransactionUpdateOperations(boolean allow)
void	applyBatchFetchStyle(BatchFetchStyle style)	Deprecated. : No longer used internally
void	applyBeanManager(Object beanManager)
void	applyCacheRegionPrefix(String prefix)
void	applyConnectionHandlingMode(PhysicalConnectionHandlingMode mode)
void	applyConnectionProviderDisablesAutoCommit(boolean providerDisablesAutoCommit)
void	applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver)
void	applyCustomEntityDirtinessStrategy(CustomEntityDirtinessStrategy strategy)
void	applyDefaultBatchFetchSize(int size)
void	applyDefaultNullPrecedence(NullPrecedence nullPrecedence)
void	applyDelayedEntityLoaderCreations(boolean delay)
void	applyEntityNotFoundDelegate(EntityNotFoundDelegate entityNotFoundDelegate)
void	applyInterceptor(Interceptor interceptor)
void	applyJdbcBatchSize(int size)
void	applyJdbcFetchSize(int size)
void	applyJsonFormatMapper(FormatMapper jsonFormatMapper)
void	applyMaximumFetchDepth(int depth)
void	applyMultiTenancy(boolean enabled)
void	applyQueryCacheLayout(CacheLayout queryCacheLayout)
void	applySessionFactoryName(String sessionFactoryName)
void	applySqlFunction(String registrationName, SqmFunctionDescriptor sqlFunction)
void	applySqmFunctionRegistry(SqmFunctionRegistry sqmFunctionRegistry)
void	applyStatelessInterceptor(Class<? extends Interceptor> statelessInterceptorClass)
void	applyStatelessInterceptorSupplier(Supplier<? extends Interceptor> statelessInterceptorSupplier)
void	applyStatementInspector(StatementInspector statementInspector)
void	applySubselectFetchEnabled(boolean subselectFetchEnabled)
void	applyTempTableDdlTransactionHandling(TempTableDdlTransactionHandling handling)
void	applyTimestampsCacheFactory(TimestampsCacheFactory factory)
void	applyValidatorFactory(Object validatorFactory)
void	applyXmlFormatMapper(FormatMapper xmlFormatMapper)
boolean	areJPACallbacksEnabled()
SessionFactoryOptions	buildOptions()
void	disableJtaTransactionAccess()
void	disableRefreshDetachedEntity()
boolean	doesConnectionProviderDisableAutoCommit()
void	enableAutoEvictCollectionCaches(boolean enabled)
void	enableCollectionInDefaultFetchGroup(boolean enabled)
void	enableCommentsSupport(boolean enabled)
void	enabledStructuredCacheEntries(boolean enabled)
void	enableGeneratedKeysSupport(boolean enabled)
void	enableGeneratorNameScopeCompliance(boolean enabled)
void	enableIdentifierRollbackSupport(boolean enabled)
void	enableJdbcBatchingForVersionedEntities(boolean enabled)
void	enableJpaCachingCompliance(boolean enabled)
void	enableJpaCascadeCompliance(boolean enabled)
void	enableJpaClosedCompliance(boolean enabled)
void	enableJpaListCompliance(boolean enabled)
void	enableJpaOrderByMappingCompliance(boolean enabled)
void	enableJpaProxyCompliance(boolean enabled)
void	enableJpaQueryCompliance(boolean enabled)
void	enableJpaTransactionCompliance(boolean enabled)
void	enableJtaTrackingByThread(boolean enabled)
void	enableMinimalPuts(boolean enabled)
void	enableNamedQueryCheckingOnStartup(boolean enabled)
void	enableNullabilityChecking(boolean enabled)
void	enableOrderingOfInserts(boolean enabled)
void	enableOrderingOfUpdates(boolean enabled)
void	enablePreferUserTransaction(boolean preferUserTransaction)
void	enableQueryCacheSupport(boolean enabled)
void	enableReleaseResourcesOnClose(boolean enable)
void	enableScrollableResultSupport(boolean enabled)
void	enableSecondLevelCacheSupport(boolean enabled)
void	enableSessionAutoClosing(boolean autoClosingEnabled)
void	enableSessionAutoFlushing(boolean flushBeforeCompletionEnabled)
void	enableSessionFactoryNameAsJndiName(boolean isJndiName)
void	enableStatisticsSupport(boolean enabled)
BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()
BatchFetchStyle	getBatchFetchStyle()
Object	getBeanManagerReference()
String	getCacheRegionPrefix()
ValueHandlingMode	getCriteriaValueHandlingMode()
CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
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()
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).
NullPrecedence	getDefaultNullPrecedence()
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).
TimeZoneStorageStrategy	getDefaultTimeZoneStorageStrategy()
EntityNameResolver[]	getEntityNameResolvers()
EntityNotFoundDelegate	getEntityNotFoundDelegate()	Get the delegate for handling entity-not-found exception conditions.
ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()
Interceptor	getInterceptor()	Get the interceptor to use by default for all sessions opened from this factory.
int	getJdbcBatchSize()
Integer	getJdbcFetchSize()
TimeZone	getJdbcTimeZone()
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()
int	getQueryStatisticsMaxSize()
SchemaAutoTooling	getSchemaAutoTooling()
StandardServiceRegistry	getServiceRegistry()	The service registry to use in building the factory.
String	getSessionFactoryName()	The name to be used for the SessionFactory.
SessionFactoryObserver[]	getSessionFactoryObservers()
Supplier<? extends Interceptor>	getStatelessInterceptorImplementorSupplier()	Get the interceptor to use by default for all sessions opened from this factory.
StatementInspector	getStatementInspector()
TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()
TimestampsCacheFactory	getTimestampsCacheFactory()
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()
boolean	isAutoCloseSessionEnabled()
boolean	isAutoEvictCollectionCache()
boolean	isCheckNullability()
boolean	isCollectionsInDefaultFetchGroupEnabled()
boolean	isCommentsEnabled()
boolean	isCriteriaCopyTreeEnabled()
boolean	isDelayBatchFetchLoaderCreationsEnabled()
boolean	isDirectReferenceCacheEntriesEnabled()
boolean	isFailOnPaginationOverCollectionFetchEnabled()
boolean	isFlushBeforeCompletionEnabled()
boolean	isGetGeneratedKeysEnabled()
boolean	isIdentifierRollbackEnabled()
boolean	isInitializeLazyStateOutsideTransactionsEnabled()
boolean	isJdbcBatchVersionedData()
boolean	isJpaBootstrap()	Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate's native bootstrapping?
boolean	isJtaTrackByThread()
boolean	isJtaTransactionAccessEnabled()
boolean	isMinimalPutsEnabled()
boolean	isMultiTenancyEnabled()
boolean	isNamedQueryStartupCheckingEnabled()
boolean	isOrderInsertsEnabled()
boolean	isOrderUpdatesEnabled()
boolean	isPassProcedureParameterNames()
boolean	isPortableIntegerDivisionEnabled()
boolean	isPreferJavaTimeJdbcTypesEnabled()
boolean	isPreferNativeEnumTypesEnabled()
boolean	isPreferUserTransaction()
boolean	isQueryCacheEnabled()
boolean	isReleaseResourcesOnCloseEnabled()
boolean	isScrollableResultSetsEnabled()
boolean	isSecondLevelCacheEnabled()
boolean	isSessionFactoryNameAlsoJndiName()	Is the SesssionFactory name also a JNDI name, indicating we should bind it into JNDI?
boolean	isStatisticsEnabled()
boolean	isStructuredCacheEntriesEnabled()
boolean	isSubselectFetchEnabled()
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.
void	setCheckNullability(boolean enabled)

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

getDefaultTenantIdentifierJavaType

Constructor Details

SessionFactoryOptionsBuilder

public SessionFactoryOptionsBuilder(StandardServiceRegistry serviceRegistry,
 BootstrapContext context)

Method Details

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 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's 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

isAllowRefreshDetachedEntity

public boolean isAllowRefreshDetachedEntity()

Specified by:

isAllowRefreshDetachedEntity in interface SessionFactoryOptions

isAllowOutOfTransactionUpdateOperations

public boolean isAllowOutOfTransactionUpdateOperations()

Specified by:

isAllowOutOfTransactionUpdateOperations in interface SessionFactoryOptions

isReleaseResourcesOnCloseEnabled

public boolean isReleaseResourcesOnCloseEnabled()

Specified by:

isReleaseResourcesOnCloseEnabled in interface SessionFactoryOptions

getBeanManagerReference

public Object getBeanManagerReference()

Specified by:

getBeanManagerReference in interface SessionFactoryOptions

getValidatorFactoryReference

public Object getValidatorFactoryReference()

Specified by:

getValidatorFactoryReference in interface SessionFactoryOptions

getSessionFactoryName

public String getSessionFactoryName()

Description copied from interface: SessionFactoryOptions

The name to be used for the SessionFactory. This is used both in:

• in-VM serialization
• JNDI binding, depending on SessionFactoryOptions.isSessionFactoryNameAlsoJndiName()

Specified by:

getSessionFactoryName in interface SessionFactoryOptions

Returns:

The SessionFactory name

isSessionFactoryNameAlsoJndiName

public boolean isSessionFactoryNameAlsoJndiName()

Description copied from interface: SessionFactoryOptions

Is the SesssionFactory 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.

isFlushBeforeCompletionEnabled

public boolean isFlushBeforeCompletionEnabled()

Specified by:

isFlushBeforeCompletionEnabled in interface SessionFactoryOptions

isAutoCloseSessionEnabled

public boolean isAutoCloseSessionEnabled()

Specified by:

isAutoCloseSessionEnabled in interface SessionFactoryOptions

isStatisticsEnabled

public boolean isStatisticsEnabled()

Specified by:

isStatisticsEnabled in interface SessionFactoryOptions

getInterceptor

public Interceptor getInterceptor()

Description copied from interface: SessionFactoryOptions

Get the interceptor to use by default for all sessions opened from this factory.

Specified by:

getInterceptor in interface SessionFactoryOptions

Returns:

The interceptor to use factory wide. May be null

getStatelessInterceptorImplementorSupplier

public Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

Description copied from interface: SessionFactoryOptions

Get the interceptor to use by default for all sessions opened from this factory.

Specified by:

getStatelessInterceptorImplementorSupplier in interface SessionFactoryOptions

Returns:

The interceptor to use factory wide. May be null

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

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

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

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

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

getStatementInspector

public StatementInspector getStatementInspector()

Specified by:

getStatementInspector in interface SessionFactoryOptions

getSessionFactoryObservers

public SessionFactoryObserver[] getSessionFactoryObservers()

Specified by:

getSessionFactoryObservers in interface SessionFactoryOptions

getBaselineSessionEventsListenerBuilder

public BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

Specified by:

getBaselineSessionEventsListenerBuilder in interface SessionFactoryOptions

isIdentifierRollbackEnabled

public boolean isIdentifierRollbackEnabled()

Specified by:

isIdentifierRollbackEnabled in interface SessionFactoryOptions

isCheckNullability

public boolean isCheckNullability()

Specified by:

isCheckNullability in interface SessionFactoryOptions

isInitializeLazyStateOutsideTransactionsEnabled

public boolean isInitializeLazyStateOutsideTransactionsEnabled()

Specified by:

isInitializeLazyStateOutsideTransactionsEnabled in interface SessionFactoryOptions

getTempTableDdlTransactionHandling

public TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

Specified by:

getTempTableDdlTransactionHandling in interface SessionFactoryOptions

getBatchFetchStyle

public BatchFetchStyle getBatchFetchStyle()

Specified by:

getBatchFetchStyle in interface SessionFactoryOptions

isDelayBatchFetchLoaderCreationsEnabled

public boolean isDelayBatchFetchLoaderCreationsEnabled()

Specified by:

isDelayBatchFetchLoaderCreationsEnabled in interface SessionFactoryOptions

getDefaultBatchFetchSize

public int getDefaultBatchFetchSize()

Specified by:

getDefaultBatchFetchSize in interface SessionFactoryOptions

getMaximumFetchDepth

public Integer getMaximumFetchDepth()

Specified by:

getMaximumFetchDepth in interface SessionFactoryOptions

isSubselectFetchEnabled

public boolean isSubselectFetchEnabled()

Specified by:

isSubselectFetchEnabled in interface SessionFactoryOptions

getDefaultNullPrecedence

public NullPrecedence getDefaultNullPrecedence()

Specified by:

getDefaultNullPrecedence in interface SessionFactoryOptions

isOrderUpdatesEnabled

public boolean isOrderUpdatesEnabled()

Specified by:

isOrderUpdatesEnabled in interface SessionFactoryOptions

isOrderInsertsEnabled

public boolean isOrderInsertsEnabled()

Specified by:

isOrderInsertsEnabled in interface SessionFactoryOptions

isMultiTenancyEnabled

public boolean isMultiTenancyEnabled()

Specified by:

isMultiTenancyEnabled in interface SessionFactoryOptions

getCurrentTenantIdentifierResolver

public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Specified by:

getCurrentTenantIdentifierResolver in interface SessionFactoryOptions

isJtaTrackByThread

public boolean isJtaTrackByThread()

Specified by:

isJtaTrackByThread in interface SessionFactoryOptions

isNamedQueryStartupCheckingEnabled

public boolean isNamedQueryStartupCheckingEnabled()

Specified by:

isNamedQueryStartupCheckingEnabled in interface SessionFactoryOptions

isSecondLevelCacheEnabled

public boolean isSecondLevelCacheEnabled()

Specified by:

isSecondLevelCacheEnabled in interface SessionFactoryOptions

isQueryCacheEnabled

public boolean isQueryCacheEnabled()

Specified by:

isQueryCacheEnabled in interface SessionFactoryOptions

getQueryCacheLayout

public CacheLayout getQueryCacheLayout()

Specified by:

getQueryCacheLayout in interface SessionFactoryOptions

getTimestampsCacheFactory

public TimestampsCacheFactory getTimestampsCacheFactory()

Specified by:

getTimestampsCacheFactory in interface SessionFactoryOptions

getCacheRegionPrefix

public String getCacheRegionPrefix()

Specified by:

getCacheRegionPrefix in interface SessionFactoryOptions

isMinimalPutsEnabled

public boolean isMinimalPutsEnabled()

Specified by:

isMinimalPutsEnabled in interface SessionFactoryOptions

isStructuredCacheEntriesEnabled

public boolean isStructuredCacheEntriesEnabled()

Specified by:

isStructuredCacheEntriesEnabled in interface SessionFactoryOptions

isDirectReferenceCacheEntriesEnabled

public boolean isDirectReferenceCacheEntriesEnabled()

Specified by:

isDirectReferenceCacheEntriesEnabled in interface SessionFactoryOptions

isAutoEvictCollectionCache

public boolean isAutoEvictCollectionCache()

Specified by:

isAutoEvictCollectionCache in interface SessionFactoryOptions

getSchemaAutoTooling

public SchemaAutoTooling getSchemaAutoTooling()

Specified by:

getSchemaAutoTooling in interface SessionFactoryOptions

getJdbcBatchSize

public int getJdbcBatchSize()

Specified by:

getJdbcBatchSize in interface SessionFactoryOptions

isJdbcBatchVersionedData

public boolean isJdbcBatchVersionedData()

Specified by:

isJdbcBatchVersionedData in interface SessionFactoryOptions

isScrollableResultSetsEnabled

public boolean isScrollableResultSetsEnabled()

Specified by:

isScrollableResultSetsEnabled in interface SessionFactoryOptions

isGetGeneratedKeysEnabled

public boolean isGetGeneratedKeysEnabled()

Specified by:

isGetGeneratedKeysEnabled in interface SessionFactoryOptions

getJdbcFetchSize

public Integer getJdbcFetchSize()

Specified by:

getJdbcFetchSize in interface SessionFactoryOptions

getPhysicalConnectionHandlingMode

public PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

Specified by:

getPhysicalConnectionHandlingMode in interface SessionFactoryOptions

setCheckNullability

public void setCheckNullability(boolean enabled)

Specified by:

setCheckNullability in interface SessionFactoryOptions

doesConnectionProviderDisableAutoCommit

public boolean doesConnectionProviderDisableAutoCommit()

Specified by:

doesConnectionProviderDisableAutoCommit in interface SessionFactoryOptions

isCommentsEnabled

public boolean isCommentsEnabled()

Specified by:

isCommentsEnabled in interface SessionFactoryOptions

getCustomEntityDirtinessStrategy

public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Specified by:

getCustomEntityDirtinessStrategy in interface SessionFactoryOptions

getEntityNameResolvers

public EntityNameResolver[] getEntityNameResolvers()

Specified by:

getEntityNameResolvers in interface SessionFactoryOptions

getEntityNotFoundDelegate

public EntityNotFoundDelegate getEntityNotFoundDelegate()

Description copied from interface: SessionFactoryOptions

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

Specified by:

getEntityNotFoundDelegate in interface SessionFactoryOptions

Returns:

The specific EntityNotFoundDelegate to use, May be null

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

isPreferUserTransaction

public boolean isPreferUserTransaction()

Specified by:

isPreferUserTransaction in interface SessionFactoryOptions

getJdbcTimeZone

public TimeZone getJdbcTimeZone()

Specified by:

getJdbcTimeZone in interface SessionFactoryOptions

getCriteriaValueHandlingMode

public ValueHandlingMode getCriteriaValueHandlingMode()

Specified by:

getCriteriaValueHandlingMode in interface QueryEngineOptions

Specified by:

getCriteriaValueHandlingMode in interface SessionFactoryOptions

See Also:

• QuerySettings.CRITERIA_VALUE_HANDLING_MODE

isCriteriaCopyTreeEnabled

public boolean isCriteriaCopyTreeEnabled()

Specified by:

isCriteriaCopyTreeEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.CRITERIA_COPY_TREE

getNativeJdbcParametersIgnored

public boolean getNativeJdbcParametersIgnored()

Specified by:

getNativeJdbcParametersIgnored in interface SessionFactoryOptions

See Also:

• QuerySettings.NATIVE_IGNORE_JDBC_PARAMETERS

getImmutableEntityUpdateQueryHandlingMode

public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

Specified by:

getImmutableEntityUpdateQueryHandlingMode in interface SessionFactoryOptions

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.

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.

isFailOnPaginationOverCollectionFetchEnabled

public boolean isFailOnPaginationOverCollectionFetchEnabled()

Specified by:

isFailOnPaginationOverCollectionFetchEnabled in interface SessionFactoryOptions

inClauseParameterPaddingEnabled

public boolean inClauseParameterPaddingEnabled()

Specified by:

inClauseParameterPaddingEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.IN_CLAUSE_PARAMETER_PADDING

isPortableIntegerDivisionEnabled

public boolean isPortableIntegerDivisionEnabled()

Specified by:

isPortableIntegerDivisionEnabled in interface QueryEngineOptions

Specified by:

isPortableIntegerDivisionEnabled in interface SessionFactoryOptions

See Also:

• QuerySettings.PORTABLE_INTEGER_DIVISION

getJpaCompliance

public JpaCompliance getJpaCompliance()

Specified by:

getJpaCompliance in interface QueryEngineOptions

Specified by:

getJpaCompliance in interface SessionFactoryOptions

getQueryStatisticsMaxSize

public int getQueryStatisticsMaxSize()

Specified by:

getQueryStatisticsMaxSize in interface SessionFactoryOptions

areJPACallbacksEnabled

public boolean areJPACallbacksEnabled()

Specified by:

areJPACallbacksEnabled in interface SessionFactoryOptions

isCollectionsInDefaultFetchGroupEnabled

public boolean isCollectionsInDefaultFetchGroupEnabled()

Specified by:

isCollectionsInDefaultFetchGroupEnabled in interface SessionFactoryOptions

isUnownedAssociationTransientCheck

public boolean isUnownedAssociationTransientCheck()

Specified by:

isUnownedAssociationTransientCheck in interface SessionFactoryOptions

getPreferredSqlTypeCodeForBoolean

public int getPreferredSqlTypeCodeForBoolean()

Specified by:

getPreferredSqlTypeCodeForBoolean in interface SessionFactoryOptions

getPreferredSqlTypeCodeForDuration

public int getPreferredSqlTypeCodeForDuration()

Specified by:

getPreferredSqlTypeCodeForDuration in interface SessionFactoryOptions

getPreferredSqlTypeCodeForUuid

public int getPreferredSqlTypeCodeForUuid()

Specified by:

getPreferredSqlTypeCodeForUuid in interface SessionFactoryOptions

getPreferredSqlTypeCodeForInstant

public int getPreferredSqlTypeCodeForInstant()

Specified by:

getPreferredSqlTypeCodeForInstant in interface SessionFactoryOptions

getPreferredSqlTypeCodeForArray

public int getPreferredSqlTypeCodeForArray()

Specified by:

getPreferredSqlTypeCodeForArray in interface SessionFactoryOptions

getDefaultTimeZoneStorageStrategy

public TimeZoneStorageStrategy getDefaultTimeZoneStorageStrategy()

Specified by:

getDefaultTimeZoneStorageStrategy in interface SessionFactoryOptions

isPreferJavaTimeJdbcTypesEnabled

public boolean isPreferJavaTimeJdbcTypesEnabled()

Specified by:

isPreferJavaTimeJdbcTypesEnabled in interface SessionFactoryOptions

isPreferNativeEnumTypesEnabled

public boolean isPreferNativeEnumTypesEnabled()

Specified by:

isPreferNativeEnumTypesEnabled in interface SessionFactoryOptions

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

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

isPassProcedureParameterNames

public boolean isPassProcedureParameterNames()

Specified by:

isPassProcedureParameterNames in interface SessionFactoryOptions

applyBeanManager

public void applyBeanManager(Object beanManager)

applyValidatorFactory

public void applyValidatorFactory(Object validatorFactory)

applyJsonFormatMapper

public void applyJsonFormatMapper(FormatMapper jsonFormatMapper)

applyXmlFormatMapper

public void applyXmlFormatMapper(FormatMapper xmlFormatMapper)

applySessionFactoryName

public void applySessionFactoryName(String sessionFactoryName)

enableSessionFactoryNameAsJndiName

public void enableSessionFactoryNameAsJndiName(boolean isJndiName)

enableSessionAutoClosing

public void enableSessionAutoClosing(boolean autoClosingEnabled)

enableSessionAutoFlushing

public void enableSessionAutoFlushing(boolean flushBeforeCompletionEnabled)

enableJtaTrackingByThread

public void enableJtaTrackingByThread(boolean enabled)

enablePreferUserTransaction

public void enablePreferUserTransaction(boolean preferUserTransaction)

enableStatisticsSupport

public void enableStatisticsSupport(boolean enabled)

addSessionFactoryObservers

public void addSessionFactoryObservers(SessionFactoryObserver... observers)

applyInterceptor

public void applyInterceptor(Interceptor interceptor)

applyStatelessInterceptor

public void applyStatelessInterceptor(Class<? extends Interceptor> statelessInterceptorClass)

applyStatelessInterceptorSupplier

public void applyStatelessInterceptorSupplier(Supplier<? extends Interceptor> statelessInterceptorSupplier)

applySqmFunctionRegistry

public void applySqmFunctionRegistry(SqmFunctionRegistry sqmFunctionRegistry)

applyStatementInspector

public void applyStatementInspector(StatementInspector statementInspector)

applyCustomEntityDirtinessStrategy

public void applyCustomEntityDirtinessStrategy(CustomEntityDirtinessStrategy strategy)

addEntityNameResolvers

public void addEntityNameResolvers(EntityNameResolver... entityNameResolvers)

applyEntityNotFoundDelegate

public void applyEntityNotFoundDelegate(EntityNotFoundDelegate entityNotFoundDelegate)

enableIdentifierRollbackSupport

public void enableIdentifierRollbackSupport(boolean enabled)

enableNullabilityChecking

public void enableNullabilityChecking(boolean enabled)

allowLazyInitializationOutsideTransaction

public void allowLazyInitializationOutsideTransaction(boolean enabled)

applyTempTableDdlTransactionHandling

public void applyTempTableDdlTransactionHandling(TempTableDdlTransactionHandling handling)

applyBatchFetchStyle

@Deprecated(since="6.0")
public void applyBatchFetchStyle(BatchFetchStyle style)

Deprecated.

: No longer used internally

applyDelayedEntityLoaderCreations

public void applyDelayedEntityLoaderCreations(boolean delay)

applyDefaultBatchFetchSize

public void applyDefaultBatchFetchSize(int size)

applyMaximumFetchDepth

public void applyMaximumFetchDepth(int depth)

applySubselectFetchEnabled

public void applySubselectFetchEnabled(boolean subselectFetchEnabled)

applyDefaultNullPrecedence

public void applyDefaultNullPrecedence(NullPrecedence nullPrecedence)

enableOrderingOfInserts

public void enableOrderingOfInserts(boolean enabled)

enableOrderingOfUpdates

public void enableOrderingOfUpdates(boolean enabled)

applyMultiTenancy

public void applyMultiTenancy(boolean enabled)

applyCurrentTenantIdentifierResolver

public void applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver)

enableNamedQueryCheckingOnStartup

public void enableNamedQueryCheckingOnStartup(boolean enabled)

enableSecondLevelCacheSupport

public void enableSecondLevelCacheSupport(boolean enabled)

enableQueryCacheSupport

public void enableQueryCacheSupport(boolean enabled)

applyQueryCacheLayout

public void applyQueryCacheLayout(CacheLayout queryCacheLayout)

applyTimestampsCacheFactory

public void applyTimestampsCacheFactory(TimestampsCacheFactory factory)

applyCacheRegionPrefix

public void applyCacheRegionPrefix(String prefix)

enableMinimalPuts

public void enableMinimalPuts(boolean enabled)

enabledStructuredCacheEntries

public void enabledStructuredCacheEntries(boolean enabled)

allowDirectReferenceCacheEntries

public void allowDirectReferenceCacheEntries(boolean enabled)

enableAutoEvictCollectionCaches

public void enableAutoEvictCollectionCaches(boolean enabled)

applyJdbcBatchSize

public void applyJdbcBatchSize(int size)

enableJdbcBatchingForVersionedEntities

public void enableJdbcBatchingForVersionedEntities(boolean enabled)

enableScrollableResultSupport

public void enableScrollableResultSupport(boolean enabled)

enableGeneratedKeysSupport

public void enableGeneratedKeysSupport(boolean enabled)

applyJdbcFetchSize

public void applyJdbcFetchSize(int size)

applyConnectionHandlingMode

public void applyConnectionHandlingMode(PhysicalConnectionHandlingMode mode)

applyConnectionProviderDisablesAutoCommit

public void applyConnectionProviderDisablesAutoCommit(boolean providerDisablesAutoCommit)

enableCommentsSupport

public void enableCommentsSupport(boolean enabled)

applySqlFunction

public void applySqlFunction(String registrationName,
 SqmFunctionDescriptor sqlFunction)

allowOutOfTransactionUpdateOperations

public void allowOutOfTransactionUpdateOperations(boolean allow)

enableReleaseResourcesOnClose

public void enableReleaseResourcesOnClose(boolean enable)

enableJpaQueryCompliance

public void enableJpaQueryCompliance(boolean enabled)

enableJpaTransactionCompliance

public void enableJpaTransactionCompliance(boolean enabled)

enableJpaListCompliance

public void enableJpaListCompliance(boolean enabled)

enableJpaCascadeCompliance

public void enableJpaCascadeCompliance(boolean enabled)

enableJpaClosedCompliance

public void enableJpaClosedCompliance(boolean enabled)

enableJpaProxyCompliance

public void enableJpaProxyCompliance(boolean enabled)

enableJpaCachingCompliance

public void enableJpaCachingCompliance(boolean enabled)

enableJpaOrderByMappingCompliance

public void enableJpaOrderByMappingCompliance(boolean enabled)

enableGeneratorNameScopeCompliance

public void enableGeneratorNameScopeCompliance(boolean enabled)

enableCollectionInDefaultFetchGroup

public void enableCollectionInDefaultFetchGroup(boolean enabled)

disableRefreshDetachedEntity

public void disableRefreshDetachedEntity()

disableJtaTransactionAccess

public void disableJtaTransactionAccess()

buildOptions

public SessionFactoryOptions buildOptions()