Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.boot.spi.SessionFactoryOptions

Method Summary

Modifier and Type	Method and Description
public default boolean	areJPACallbacksEnabled()
public default boolean	doesConnectionProviderDisableAutoCommit()
public BaselineSessionEventsListenerBuilder	getBaselineSessionEventsListenerBuilder()
public BatchFetchStyle	getBatchFetchStyle()
public Object	getBeanManagerReference()
public String	getCacheRegionPrefix()
public ConnectionReleaseMode	getConnectionReleaseMode() Deprecated Use `getPhysicalConnectionHandlingMode()` instead
public default LiteralHandlingMode	getCriteriaLiteralHandlingMode()
public CurrentTenantIdentifierResolver	getCurrentTenantIdentifierResolver()
public CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
public Map<String, SQLFunction>	getCustomSqlFunctionMap()
public int	getDefaultBatchFetchSize()
public default String	Returns: The default catalog to use. 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).
public EntityMode	getDefaultEntityMode()
public NullPrecedence	getDefaultNullPrecedence()
public default String	Returns: The default schema to use. 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).
public EntityNameResolver[]	getEntityNameResolvers()
public EntityNotFoundDelegate	Returns: The specific EntityNotFoundDelegate to use, May be `null` getEntityNotFoundDelegate() Get the delegate for handling entity-not-found exception conditions.
public EntityTuplizerFactory	getEntityTuplizerFactory()
public default ImmutableEntityUpdateQueryHandlingMode	getImmutableEntityUpdateQueryHandlingMode()
public Interceptor	Returns: The interceptor to use factory wide. May be `null` getInterceptor() Get the interceptor to use by default for all sessions opened from this factory.
public int	getJdbcBatchSize()
public Integer	getJdbcFetchSize()
public TimeZone	getJdbcTimeZone()
public JpaCompliance	getJpaCompliance()
public Integer	getMaximumFetchDepth()
public MultiTableBulkIdStrategy	getMultiTableBulkIdStrategy()
public MultiTenancyStrategy	getMultiTenancyStrategy()
public PhysicalConnectionHandlingMode	getPhysicalConnectionHandlingMode()
public default int	getQueryStatisticsMaxSize()
public Map<K, V>	getQuerySubstitutions()
public SchemaAutoTooling	getSchemaAutoTooling()
public StandardServiceRegistry	Returns: The service registry to use. getServiceRegistry() The service registry to use in building the factory.
public String	Returns: The SessionFactory name getSessionFactoryName() The name to be used for the SessionFactory.
public SessionFactoryObserver[]	getSessionFactoryObservers()
public Class<? extends Interceptor>	Returns: The interceptor to use factory wide. May be `null` getStatelessInterceptorImplementor() Deprecated use `getStatelessInterceptorImplementorSupplier()` instead. Get the interceptor to use by default for all sessions opened from this factory.
public default Supplier<? extends Interceptor>	Returns: The interceptor to use factory wide. May be `null` getStatelessInterceptorImplementorSupplier() Get the interceptor to use by default for all sessions opened from this factory.
public StatementInspector	getStatementInspector()
public TempTableDdlTransactionHandling	getTempTableDdlTransactionHandling()
public TimestampsCacheFactory	getTimestampsCacheFactory()
public String	Returns: The UUID for this SessionFactory. getUuid() Get the UUID unique to this SessionFactoryOptions.
public Object	getValidatorFactoryReference()
public default boolean	inClauseParameterPaddingEnabled()
public boolean	isAllowOutOfTransactionUpdateOperations()
public default boolean	isAllowRefreshDetachedEntity()
public boolean	isAutoCloseSessionEnabled()
public boolean	isAutoEvictCollectionCache()
public boolean	isCheckNullability()
public boolean	isCollectionJoinSubqueryRewriteEnabled()
public default boolean	isCollectionsInDefaultFetchGroupEnabled()
public boolean	isCommentsEnabled()
public boolean	isConventionalJavaConstants()
public boolean	isDelayBatchFetchLoaderCreationsEnabled()
public boolean	isDirectReferenceCacheEntriesEnabled()
public default boolean	isEnhancementAsProxyEnabled() Deprecated (since 5.5) use of enhanced proxies is always enabled Can bytecode-enhanced entity classes be used as a "proxy"?
public boolean	isFailOnPaginationOverCollectionFetchEnabled()
public boolean	isFlushBeforeCompletionEnabled()
public boolean	isGetGeneratedKeysEnabled()
public boolean	isIdentifierRollbackEnabled()
public boolean	isInitializeLazyStateOutsideTransactionsEnabled()
public boolean	isJdbcBatchVersionedData()
public boolean	Returns: `true` indicates the SessionFactory was built through JPA bootstrapping; `false` indicates it was built through native bootstrapping. isJpaBootstrap() Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate's native bootstrapping?
public boolean	isJtaTrackByThread()
public boolean	isJtaTransactionAccessEnabled()
public boolean	isMinimalPutsEnabled()
public boolean	isNamedQueryStartupCheckingEnabled()
public boolean	isOmitJoinOfSuperclassTablesEnabled()
public boolean	isOrderInsertsEnabled()
public boolean	isOrderUpdatesEnabled()
public default boolean	isPostInsertIdentifierDelayableEnabled() Deprecated Since 5.4.1, this is no longer used.
public boolean	isPreferUserTransaction()
public boolean	isProcedureParameterNullPassingEnabled() Deprecated with no replacement. See `org.hibernate.cfg.AvailableSettings#PROCEDURE_NULL_PARAM_PASSING` for details
public boolean	isQueryCacheEnabled()
public default boolean	isQueryParametersValidationEnabled()
public boolean	isReleaseResourcesOnCloseEnabled()
public boolean	isScrollableResultSetsEnabled()
public boolean	isSecondLevelCacheEnabled()
public boolean	Returns: `true` if the SessionFactory name is also a JNDI name; `false` otherwise. isSessionFactoryNameAlsoJndiName() Is the `SesssionFactory name` also a JNDI name, indicating we should bind it into JNDI?
public boolean	isStatisticsEnabled()
public default boolean	isStrictJpaQueryLanguageCompliance() Deprecated Use `JpaCompliance#isJpaQueryComplianceEnabled()` instead via `getJpaCompliance()`
public boolean	isStructuredCacheEntriesEnabled()
public boolean	isWrapResultSetsEnabled() Deprecated (since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer needed
public boolean	jdbcStyleParamsZeroBased()
public default boolean	nativeExceptionHandling51Compliance()
public void	setCheckNullability(boolean enabled)

Method Detail

areJPACallbacksEnabled	back to summary
public default boolean areJPACallbacksEnabled()

doesConnectionProviderDisableAutoCommit	back to summary
public default boolean doesConnectionProviderDisableAutoCommit()

getBaselineSessionEventsListenerBuilder	back to summary
public BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder()

getBatchFetchStyle	back to summary
public BatchFetchStyle getBatchFetchStyle()

getBeanManagerReference	back to summary
public Object getBeanManagerReference()

getCacheRegionPrefix	back to summary
public String getCacheRegionPrefix()

getConnectionReleaseMode	back to summary
public ConnectionReleaseMode getConnectionReleaseMode() Deprecated Use `getPhysicalConnectionHandlingMode()` instead Annotations @Deprecated

getCriteriaLiteralHandlingMode	back to summary
public default LiteralHandlingMode getCriteriaLiteralHandlingMode()

getCurrentTenantIdentifierResolver	back to summary
public CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()

getCustomEntityDirtinessStrategy	back to summary
public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

getCustomSqlFunctionMap	back to summary
public Map<String, SQLFunction> getCustomSqlFunctionMap()

getDefaultBatchFetchSize	back to summary
public int getDefaultBatchFetchSize()

getDefaultCatalog	back to summary
public default 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). Returns:String The default catalog to use.

getDefaultCatalog

back to summary

public default 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).

Returns:String: The default catalog to use.

getDefaultEntityMode	back to summary
public EntityMode getDefaultEntityMode()

getDefaultNullPrecedence	back to summary
public NullPrecedence getDefaultNullPrecedence()

getDefaultSchema	back to summary
public default 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). Returns:String The default schema to use.

getDefaultSchema

back to summary

public default 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).

Returns:String: The default schema to use.

getEntityNameResolvers	back to summary
public EntityNameResolver[] getEntityNameResolvers()

getEntityNotFoundDelegate back to summary

getEntityNotFoundDelegate	back to summary
public EntityNotFoundDelegate getEntityNotFoundDelegate() Get the delegate for handling entity-not-found exception conditions. Returns:EntityNotFoundDelegate The specific EntityNotFoundDelegate to use, May be `null`

public EntityNotFoundDelegate getEntityNotFoundDelegate()

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

Returns:EntityNotFoundDelegate: The specific EntityNotFoundDelegate to use, May be null

getEntityTuplizerFactory	back to summary
public EntityTuplizerFactory getEntityTuplizerFactory()

getImmutableEntityUpdateQueryHandlingMode	back to summary
public default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()

getInterceptor back to summary

getInterceptor	back to summary
public Interceptor getInterceptor() Get the interceptor to use by default for all sessions opened from this factory. Returns:Interceptor The interceptor to use factory wide. May be `null`

public Interceptor getInterceptor()

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

Returns:Interceptor: The interceptor to use factory wide. May be null

getJdbcBatchSize	back to summary
public int getJdbcBatchSize()

getJdbcFetchSize	back to summary
public Integer getJdbcFetchSize()

getJdbcTimeZone	back to summary
public TimeZone getJdbcTimeZone()

getJpaCompliance	back to summary
public JpaCompliance getJpaCompliance()

getMaximumFetchDepth	back to summary
public Integer getMaximumFetchDepth()

getMultiTableBulkIdStrategy	back to summary
public MultiTableBulkIdStrategy getMultiTableBulkIdStrategy()

getMultiTenancyStrategy	back to summary
public MultiTenancyStrategy getMultiTenancyStrategy()

getPhysicalConnectionHandlingMode	back to summary
public PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode()

getQueryStatisticsMaxSize	back to summary
public default int getQueryStatisticsMaxSize()

getQuerySubstitutions	back to summary
public Map<K, V> getQuerySubstitutions()

getSchemaAutoTooling	back to summary
public SchemaAutoTooling getSchemaAutoTooling()

getServiceRegistry	back to summary
public StandardServiceRegistry getServiceRegistry() The service registry to use in building the factory. Returns:StandardServiceRegistry The service registry to use.

getServiceRegistry

back to summary

public StandardServiceRegistry getServiceRegistry()

The service registry to use in building the factory.

Returns:StandardServiceRegistry: The service registry to use.

getSessionFactoryName back to summary

getSessionFactoryName	back to summary
public String getSessionFactoryName() The name to be used for the SessionFactory. This is used both in: in-VM serialization JNDI binding, depending on `isSessionFactoryNameAlsoJndiName` Returns:String The SessionFactory name

public String getSessionFactoryName()

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

in-VM serialization
JNDI binding, depending on isSessionFactoryNameAlsoJndiName

Returns:String: The SessionFactory name

getSessionFactoryObservers	back to summary
public SessionFactoryObserver[] getSessionFactoryObservers()

getStatelessInterceptorImplementor back to summary

getStatelessInterceptorImplementor	back to summary
public Class<? extends Interceptor> getStatelessInterceptorImplementor() Deprecated use `getStatelessInterceptorImplementorSupplier()` instead. Get the interceptor to use by default for all sessions opened from this factory. Returns:Class<? extends Interceptor> The interceptor to use factory wide. May be `null` Annotations @Deprecated

public Class<? extends Interceptor> getStatelessInterceptorImplementor()

Deprecated

use getStatelessInterceptorImplementorSupplier() instead.

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

Returns:Class<? extends Interceptor>

The interceptor to use factory wide. May be null

Annotations

@Deprecated

getStatelessInterceptorImplementorSupplier back to summary

getStatelessInterceptorImplementorSupplier	back to summary
public default Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier() Get the interceptor to use by default for all sessions opened from this factory. Returns:Supplier<? extends Interceptor> The interceptor to use factory wide. May be `null`

public default Supplier<? extends Interceptor> getStatelessInterceptorImplementorSupplier()

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

Returns:Supplier<? extends Interceptor>: The interceptor to use factory wide. May be null

getStatementInspector	back to summary
public StatementInspector getStatementInspector()

getTempTableDdlTransactionHandling	back to summary
public TempTableDdlTransactionHandling getTempTableDdlTransactionHandling()

getTimestampsCacheFactory	back to summary
public TimestampsCacheFactory getTimestampsCacheFactory()

getUuid back to summary

getUuid	back to summary
public String getUuid() Get the UUID unique to this SessionFactoryOptions. Will be the same value available as `SessionFactoryImplementor#getUuid()`. API Note The value is generated as a `java.util.UUID`, but kept as a String. Returns:String The UUID for this SessionFactory. See Also `org.hibernate.internal.SessionFactoryRegistry#getSessionFactory`, `SessionFactoryImplementor#getUuid`

public String getUuid()

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

API Note

The value is generated as a java.util.UUID, but kept as a String.

Returns:String: The UUID for this SessionFactory.
See Also: org.hibernate.internal.SessionFactoryRegistry#getSessionFactory, SessionFactoryImplementor#getUuid

getValidatorFactoryReference	back to summary
public Object getValidatorFactoryReference()

inClauseParameterPaddingEnabled	back to summary
public default boolean inClauseParameterPaddingEnabled()

isAllowOutOfTransactionUpdateOperations	back to summary
public boolean isAllowOutOfTransactionUpdateOperations()

isAllowRefreshDetachedEntity	back to summary
public default boolean isAllowRefreshDetachedEntity()

isAutoCloseSessionEnabled	back to summary
public boolean isAutoCloseSessionEnabled()

isAutoEvictCollectionCache	back to summary
public boolean isAutoEvictCollectionCache()

isCheckNullability	back to summary
public boolean isCheckNullability()

isCollectionJoinSubqueryRewriteEnabled	back to summary
public boolean isCollectionJoinSubqueryRewriteEnabled()

isCollectionsInDefaultFetchGroupEnabled	back to summary
public default boolean isCollectionsInDefaultFetchGroupEnabled()

isCommentsEnabled	back to summary
public boolean isCommentsEnabled()

isConventionalJavaConstants	back to summary
public boolean isConventionalJavaConstants()

isDelayBatchFetchLoaderCreationsEnabled	back to summary
public boolean isDelayBatchFetchLoaderCreationsEnabled()

isDirectReferenceCacheEntriesEnabled	back to summary
public boolean isDirectReferenceCacheEntriesEnabled()

isEnhancementAsProxyEnabled

back to summary

public default boolean isEnhancementAsProxyEnabled()

Deprecated

(since 5.5) use of enhanced proxies is always enabled

Can bytecode-enhanced entity classes be used as a "proxy"?

Annotations

@Deprecated

isFailOnPaginationOverCollectionFetchEnabled	back to summary
public boolean isFailOnPaginationOverCollectionFetchEnabled()

isFlushBeforeCompletionEnabled	back to summary
public boolean isFlushBeforeCompletionEnabled()

isGetGeneratedKeysEnabled	back to summary
public boolean isGetGeneratedKeysEnabled()

isIdentifierRollbackEnabled	back to summary
public boolean isIdentifierRollbackEnabled()

isInitializeLazyStateOutsideTransactionsEnabled	back to summary
public boolean isInitializeLazyStateOutsideTransactionsEnabled()

isJdbcBatchVersionedData	back to summary
public boolean isJdbcBatchVersionedData()

isJpaBootstrap back to summary

public boolean isJpaBootstrap()

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

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

isJtaTrackByThread	back to summary
public boolean isJtaTrackByThread()

isJtaTransactionAccessEnabled	back to summary
public boolean isJtaTransactionAccessEnabled()

isMinimalPutsEnabled	back to summary
public boolean isMinimalPutsEnabled()

isNamedQueryStartupCheckingEnabled	back to summary
public boolean isNamedQueryStartupCheckingEnabled()

isOmitJoinOfSuperclassTablesEnabled	back to summary
public boolean isOmitJoinOfSuperclassTablesEnabled()

isOrderInsertsEnabled	back to summary
public boolean isOrderInsertsEnabled()

isOrderUpdatesEnabled	back to summary
public boolean isOrderUpdatesEnabled()

isPostInsertIdentifierDelayableEnabled	back to summary
public default boolean isPostInsertIdentifierDelayableEnabled() Deprecated Since 5.4.1, this is no longer used. Annotations @Deprecated

isPreferUserTransaction	back to summary
public boolean isPreferUserTransaction()

isProcedureParameterNullPassingEnabled	back to summary
public boolean isProcedureParameterNullPassingEnabled() Deprecated with no replacement. See `org.hibernate.cfg.AvailableSettings#PROCEDURE_NULL_PARAM_PASSING` for details Annotations @Deprecated

isQueryCacheEnabled	back to summary
public boolean isQueryCacheEnabled()

isQueryParametersValidationEnabled	back to summary
public default boolean isQueryParametersValidationEnabled()

isReleaseResourcesOnCloseEnabled	back to summary
public boolean isReleaseResourcesOnCloseEnabled()

isScrollableResultSetsEnabled	back to summary
public boolean isScrollableResultSetsEnabled()

isSecondLevelCacheEnabled	back to summary
public boolean isSecondLevelCacheEnabled()

isSessionFactoryNameAlsoJndiName back to summary

public boolean isSessionFactoryNameAlsoJndiName()

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

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

isStatisticsEnabled	back to summary
public boolean isStatisticsEnabled()

isStrictJpaQueryLanguageCompliance	back to summary
public default boolean isStrictJpaQueryLanguageCompliance() Deprecated Use `JpaCompliance#isJpaQueryComplianceEnabled()` instead via `getJpaCompliance()` Annotations @Deprecated

isStructuredCacheEntriesEnabled	back to summary
public boolean isStructuredCacheEntriesEnabled()

isWrapResultSetsEnabled	back to summary
public boolean isWrapResultSetsEnabled() Deprecated (since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer needed Annotations @Deprecated

jdbcStyleParamsZeroBased	back to summary
public boolean jdbcStyleParamsZeroBased()

nativeExceptionHandling51Compliance	back to summary
public default boolean nativeExceptionHandling51Compliance()

setCheckNullability	back to summary
public void setCheckNullability(boolean enabled)

public Interface SessionFactoryOptions

Method Summary

Method Detail