org.hibernate.boot.spi

Interface SessionFactoryOptions

All Known Implementing Classes:

AbstractDelegatingSessionFactoryOptions, SessionFactoryOptionsImpl

public interface SessionFactoryOptions

Aggregator of special options used to build the SessionFactory.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
default boolean	doesConnectionProviderDisableAutoCommit()
BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()
BatchFetchStyle	getBatchFetchStyle()
java.lang.Object	getBeanManagerReference()
java.lang.String	getCacheRegionPrefix()
ConnectionReleaseMode	getConnectionReleaseMode() Deprecated. Use getPhysicalConnectionHandlingMode() instead
default LiteralHandlingMode	getCriteriaLiteralHandlingMode()
CurrentTenantIdentifierResolver	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
java.util.Map<java.lang.String,SQLFunction>	getCustomSqlFunctionMap()
int	getDefaultBatchFetchSize()
EntityMode	getDefaultEntityMode()
NullPrecedence	getDefaultNullPrecedence()
EntityNameResolver[]	getEntityNameResolvers()
EntityNotFoundDelegate	getEntityNotFoundDelegate() Get the delegate for handling entity-not-found exception conditions.
EntityTuplizerFactory	getEntityTuplizerFactory()
default ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()
Interceptor	getInterceptor() Get the interceptor to use by default for all sessions opened from this factory.
int	getJdbcBatchSize()
java.lang.Integer	getJdbcFetchSize()
java.util.TimeZone	getJdbcTimeZone()
java.lang.Integer	getMaximumFetchDepth()
MultiTableBulkIdStrategy	getMultiTableBulkIdStrategy()
MultiTenancyStrategy	getMultiTenancyStrategy()
PhysicalConnectionHandlingMode	getPhysicalConnectionHandlingMode()
QueryCacheFactory	getQueryCacheFactory()
java.util.Map	getQuerySubstitutions()
SchemaAutoTooling	getSchemaAutoTooling()
StandardServiceRegistry	getServiceRegistry() The service registry to use in building the factory.
java.lang.String	getSessionFactoryName() The name to be used for the SessionFactory.
SessionFactoryObserver[]	getSessionFactoryObservers()
java.lang.Class<? extends Interceptor>	getStatelessInterceptorImplementor() Deprecated. use getStatelessInterceptorImplementorSupplier() instead.
default java.util.function.Supplier<? extends Interceptor>	getStatelessInterceptorImplementorSupplier() Get the interceptor to use by default for all sessions opened from this factory.
StatementInspector	getStatementInspector()
TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()
java.lang.Object	getValidatorFactoryReference()
default boolean	inClauseParameterPaddingEnabled()
boolean	isAllowOutOfTransactionUpdateOperations()
default boolean	isAllowRefreshDetachedEntity()
boolean	isAutoCloseSessionEnabled()
boolean	isAutoEvictCollectionCache()
boolean	isCheckNullability()
boolean	isCollectionJoinSubqueryRewriteEnabled()
boolean	isCommentsEnabled()
boolean	isConventionalJavaConstants()
boolean	isDirectReferenceCacheEntriesEnabled()
default boolean	isFailOnPaginationOverCollectionFetchEnabled()
boolean	isFlushBeforeCompletionEnabled()
boolean	isGetGeneratedKeysEnabled()
boolean	isIdentifierRollbackEnabled()
boolean	isInitializeLazyStateOutsideTransactionsEnabled()
boolean	isJdbcBatchVersionedData()
boolean	isJpaBootstrap() Deprecated. (since 5.2) In fact added in 5.2 as part of consolidating JPA support directly into Hibernate contracts (SessionFactory, Session); intended to provide transition help in cases where we need to know the difference in JPA/native use for various reasons.
default boolean	isJpaProxyComplianceEnabled()
boolean	isJtaTrackByThread()
boolean	isJtaTransactionAccessEnabled()
boolean	isMinimalPutsEnabled()
boolean	isNamedQueryStartupCheckingEnabled()
boolean	isOrderInsertsEnabled()
boolean	isOrderUpdatesEnabled()
boolean	isPreferUserTransaction()
boolean	isProcedureParameterNullPassingEnabled()
boolean	isQueryCacheEnabled()
default boolean	isQueryParametersValidationEnabled()
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	isStrictJpaQueryLanguageCompliance()
boolean	isStructuredCacheEntriesEnabled()
boolean	isWrapResultSetsEnabled()
void	setCheckNullability(boolean enabled)

Method Detail

getServiceRegistry

StandardServiceRegistry getServiceRegistry()

The service registry to use in building the factory.

Returns:

The service registry to use.

getBeanManagerReference

java.lang.Object getBeanManagerReference()

getValidatorFactoryReference

java.lang.Object getValidatorFactoryReference()

isJpaBootstrap

@Deprecated
boolean isJpaBootstrap()

Deprecated. (since 5.2) In fact added in 5.2 as part of consolidating JPA support directly into Hibernate contracts (SessionFactory, Session); intended to provide transition help in cases where we need to know the difference in JPA/native use for various reasons.

See Also:

SessionFactoryBuilderImplementor.markAsJpaBootstrap()

isJtaTransactionAccessEnabled

boolean isJtaTransactionAccessEnabled()

isAllowRefreshDetachedEntity

default boolean isAllowRefreshDetachedEntity()

getSessionFactoryName

java.lang.String getSessionFactoryName()

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

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

Returns:

The SessionFactory name

isSessionFactoryNameAlsoJndiName

boolean isSessionFactoryNameAlsoJndiName()

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

Returns:

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

isFlushBeforeCompletionEnabled

boolean isFlushBeforeCompletionEnabled()

isAutoCloseSessionEnabled

boolean isAutoCloseSessionEnabled()

isStatisticsEnabled

boolean isStatisticsEnabled()

getInterceptor

Interceptor getInterceptor()

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

Returns:

The interceptor to use factory wide. May be null

getStatelessInterceptorImplementor

@Deprecated
java.lang.Class<? extends Interceptor> getStatelessInterceptorImplementor()

Deprecated. use getStatelessInterceptorImplementorSupplier() instead.

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

Returns:

The interceptor to use factory wide. May be null

getStatelessInterceptorImplementorSupplier

default java.util.function.Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

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

Returns:

The interceptor to use factory wide. May be null

getStatementInspector

StatementInspector getStatementInspector()

getSessionFactoryObservers

SessionFactoryObserver[] getSessionFactoryObservers()

getBaselineSessionEventsListenerBuilder

BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

isIdentifierRollbackEnabled

boolean isIdentifierRollbackEnabled()

getDefaultEntityMode

EntityMode getDefaultEntityMode()

getEntityTuplizerFactory

EntityTuplizerFactory getEntityTuplizerFactory()

isCheckNullability

boolean isCheckNullability()

isInitializeLazyStateOutsideTransactionsEnabled

boolean isInitializeLazyStateOutsideTransactionsEnabled()

getMultiTableBulkIdStrategy

MultiTableBulkIdStrategy getMultiTableBulkIdStrategy()

getTempTableDdlTransactionHandling

TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

getBatchFetchStyle

BatchFetchStyle getBatchFetchStyle()

getDefaultBatchFetchSize

int getDefaultBatchFetchSize()

getMaximumFetchDepth

java.lang.Integer getMaximumFetchDepth()

getDefaultNullPrecedence

NullPrecedence getDefaultNullPrecedence()

isOrderUpdatesEnabled

boolean isOrderUpdatesEnabled()

isOrderInsertsEnabled

boolean isOrderInsertsEnabled()

getMultiTenancyStrategy

MultiTenancyStrategy getMultiTenancyStrategy()

getCurrentTenantIdentifierResolver

CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()

isJtaTrackByThread

boolean isJtaTrackByThread()

getQuerySubstitutions

java.util.Map getQuerySubstitutions()

isStrictJpaQueryLanguageCompliance

boolean isStrictJpaQueryLanguageCompliance()

isNamedQueryStartupCheckingEnabled

boolean isNamedQueryStartupCheckingEnabled()

isConventionalJavaConstants

boolean isConventionalJavaConstants()

isSecondLevelCacheEnabled

boolean isSecondLevelCacheEnabled()

isQueryCacheEnabled

boolean isQueryCacheEnabled()

getQueryCacheFactory

QueryCacheFactory getQueryCacheFactory()

getCacheRegionPrefix

java.lang.String getCacheRegionPrefix()

isMinimalPutsEnabled

boolean isMinimalPutsEnabled()

isStructuredCacheEntriesEnabled

boolean isStructuredCacheEntriesEnabled()

isDirectReferenceCacheEntriesEnabled

boolean isDirectReferenceCacheEntriesEnabled()

isAutoEvictCollectionCache

boolean isAutoEvictCollectionCache()

getSchemaAutoTooling

SchemaAutoTooling getSchemaAutoTooling()

getJdbcBatchSize

int getJdbcBatchSize()

isJdbcBatchVersionedData

boolean isJdbcBatchVersionedData()

isScrollableResultSetsEnabled

boolean isScrollableResultSetsEnabled()

isWrapResultSetsEnabled

boolean isWrapResultSetsEnabled()

isGetGeneratedKeysEnabled

boolean isGetGeneratedKeysEnabled()

getJdbcFetchSize

java.lang.Integer getJdbcFetchSize()

getPhysicalConnectionHandlingMode

PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

doesConnectionProviderDisableAutoCommit

default boolean doesConnectionProviderDisableAutoCommit()

getConnectionReleaseMode

@Deprecated
ConnectionReleaseMode getConnectionReleaseMode()

Deprecated. Use getPhysicalConnectionHandlingMode() instead

isCommentsEnabled

boolean isCommentsEnabled()

getCustomEntityDirtinessStrategy

CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

getEntityNameResolvers

EntityNameResolver[] getEntityNameResolvers()

getEntityNotFoundDelegate

EntityNotFoundDelegate getEntityNotFoundDelegate()

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

Returns:

The specific EntityNotFoundDelegate to use, May be null

getCustomSqlFunctionMap

java.util.Map<java.lang.String,SQLFunction> getCustomSqlFunctionMap()

setCheckNullability

void setCheckNullability(boolean enabled)

isPreferUserTransaction

boolean isPreferUserTransaction()

isProcedureParameterNullPassingEnabled

boolean isProcedureParameterNullPassingEnabled()

isCollectionJoinSubqueryRewriteEnabled

boolean isCollectionJoinSubqueryRewriteEnabled()

isAllowOutOfTransactionUpdateOperations

boolean isAllowOutOfTransactionUpdateOperations()

isReleaseResourcesOnCloseEnabled

boolean isReleaseResourcesOnCloseEnabled()

getJdbcTimeZone

java.util.TimeZone getJdbcTimeZone()

isQueryParametersValidationEnabled

default boolean isQueryParametersValidationEnabled()

getCriteriaLiteralHandlingMode

default LiteralHandlingMode getCriteriaLiteralHandlingMode()

isFailOnPaginationOverCollectionFetchEnabled

default boolean isFailOnPaginationOverCollectionFetchEnabled()

isJpaProxyComplianceEnabled

default boolean isJpaProxyComplianceEnabled()

getImmutableEntityUpdateQueryHandlingMode

default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

inClauseParameterPaddingEnabled

default boolean inClauseParameterPaddingEnabled()