SessionFactoryOptions (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

All Known Implementing Classes:

AbstractDelegatingSessionFactoryOptions, SessionFactoryOptionsBuilder
```
public interface SessionFactoryOptions
```
Aggregator of special options used to build the SessionFactory.

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`doesConnectionProviderDisableAutoCommit()`
`BaselineSessionEventsListenerBuilder`	`getBaselineSessionEventsListenerBuilder()`
`BatchFetchStyle`	`getBatchFetchStyle()`
`Object`	`getBeanManagerReference()`
`String`	`getCacheRegionPrefix()`
`ConnectionReleaseMode`	`getConnectionReleaseMode()` Deprecated. Use `getPhysicalConnectionHandlingMode()` instead
`default LiteralHandlingMode`	`getCriteriaLiteralHandlingMode()`
`CurrentTenantIdentifierResolver`	`getCurrentTenantIdentifierResolver()`
`CustomEntityDirtinessStrategy`	`getCustomEntityDirtinessStrategy()`
`Map<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()`
`Integer`	`getJdbcFetchSize()`
`TimeZone`	`getJdbcTimeZone()`
`JpaCompliance`	`getJpaCompliance()`
`Integer`	`getMaximumFetchDepth()`
`MultiTableBulkIdStrategy`	`getMultiTableBulkIdStrategy()`
`MultiTenancyStrategy`	`getMultiTenancyStrategy()`
`PhysicalConnectionHandlingMode`	`getPhysicalConnectionHandlingMode()`
`Map`	`getQuerySubstitutions()`
`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()`
`Class<? extends Interceptor>`	`getStatelessInterceptorImplementor()` Deprecated. use `getStatelessInterceptorImplementorSupplier()` instead.
`default 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()`
`default boolean`	`inClauseParameterPaddingEnabled()`
`boolean`	`isAllowOutOfTransactionUpdateOperations()`
`default boolean`	`isAllowRefreshDetachedEntity()`
`boolean`	`isAutoCloseSessionEnabled()`
`boolean`	`isAutoEvictCollectionCache()`
`boolean`	`isCheckNullability()`
`boolean`	`isCollectionJoinSubqueryRewriteEnabled()`
`boolean`	`isCommentsEnabled()`
`boolean`	`isConventionalJavaConstants()`
`boolean`	`isDelayBatchFetchLoaderCreationsEnabled()`
`boolean`	`isDirectReferenceCacheEntriesEnabled()`
`default boolean`	`isEnhancementAsProxyEnabled()` Can bytecode-enhanced entity classes be used as a "proxy"?
`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`	`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()`
`default boolean`	`isStrictJpaQueryLanguageCompliance()` Deprecated. Use `JpaCompliance.isJpaQueryComplianceEnabled()` instead via `getJpaCompliance()`
`boolean`	`isStructuredCacheEntriesEnabled()`
`boolean`	`isWrapResultSetsEnabled()`
`boolean`	`jdbcStyleParamsZeroBased()`
`default boolean`	`nativeExceptionHandling51Compliance()`
`void`	`setCheckNullability(boolean enabled)`

- Method Detail
  - getUuid
```
String getUuid()
```
    Get the UUID unique to this SessionFactoryOptions. Will be the same value available as SessionFactoryImplementor.getUuid().
    
    Returns:
    
    The UUID for this SessionFactory.
    
    See Also:
    
    SessionFactoryRegistry.getSessionFactory(java.lang.String), SessionFactoryImplementor.getUuid()
  - getServiceRegistry
```
StandardServiceRegistry getServiceRegistry()
```
    The service registry to use in building the factory.
    
    Returns:
    
    The service registry to use.
  - getBeanManagerReference
```
Object getBeanManagerReference()
```
  - getValidatorFactoryReference
```
Object getValidatorFactoryReference()
```
  - isJpaBootstrap
```
boolean isJpaBootstrap()
```
    Was building of the SessionFactory initiated through JPA bootstrapping, or through Hibernate's native bootstrapping?
    
    Returns:
    
    true indicates the SessionFactory was built through JPA bootstrapping; false indicates it was built through native bootstrapping.
  - isJtaTransactionAccessEnabled
```
boolean isJtaTransactionAccessEnabled()
```
  - isAllowRefreshDetachedEntity
```
default boolean isAllowRefreshDetachedEntity()
```
  - getSessionFactoryName
```
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
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 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()
```
  - isDelayBatchFetchLoaderCreationsEnabled
```
boolean isDelayBatchFetchLoaderCreationsEnabled()
```
  - getDefaultBatchFetchSize
```
int getDefaultBatchFetchSize()
```
  - getMaximumFetchDepth
```
Integer getMaximumFetchDepth()
```
  - getDefaultNullPrecedence
```
NullPrecedence getDefaultNullPrecedence()
```
  - isOrderUpdatesEnabled
```
boolean isOrderUpdatesEnabled()
```
  - isOrderInsertsEnabled
```
boolean isOrderInsertsEnabled()
```
  - getMultiTenancyStrategy
```
MultiTenancyStrategy getMultiTenancyStrategy()
```
  - getCurrentTenantIdentifierResolver
```
CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()
```
  - isJtaTrackByThread
```
boolean isJtaTrackByThread()
```
  - getQuerySubstitutions
```
Map getQuerySubstitutions()
```
  - isStrictJpaQueryLanguageCompliance
```
@Deprecated
default boolean isStrictJpaQueryLanguageCompliance()
```
    Deprecated. Use JpaCompliance.isJpaQueryComplianceEnabled() instead via getJpaCompliance()
  - isNamedQueryStartupCheckingEnabled
```
boolean isNamedQueryStartupCheckingEnabled()
```
  - isConventionalJavaConstants
```
boolean isConventionalJavaConstants()
```
  - isSecondLevelCacheEnabled
```
boolean isSecondLevelCacheEnabled()
```
  - isQueryCacheEnabled
```
boolean isQueryCacheEnabled()
```
  - getTimestampsCacheFactory
```
TimestampsCacheFactory getTimestampsCacheFactory()
```
  - getCacheRegionPrefix
```
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
```
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
```
Map<String,SQLFunction> getCustomSqlFunctionMap()
```
  - setCheckNullability
```
void setCheckNullability(boolean enabled)
```
  - isPreferUserTransaction
```
boolean isPreferUserTransaction()
```
  - isProcedureParameterNullPassingEnabled
```
boolean isProcedureParameterNullPassingEnabled()
```
  - isCollectionJoinSubqueryRewriteEnabled
```
boolean isCollectionJoinSubqueryRewriteEnabled()
```
  - isAllowOutOfTransactionUpdateOperations
```
boolean isAllowOutOfTransactionUpdateOperations()
```
  - isReleaseResourcesOnCloseEnabled
```
boolean isReleaseResourcesOnCloseEnabled()
```
  - getJdbcTimeZone
```
TimeZone getJdbcTimeZone()
```
  - isQueryParametersValidationEnabled
```
default boolean isQueryParametersValidationEnabled()
```
  - getCriteriaLiteralHandlingMode
```
default LiteralHandlingMode getCriteriaLiteralHandlingMode()
```
  - jdbcStyleParamsZeroBased
```
boolean jdbcStyleParamsZeroBased()
```
  - getJpaCompliance
```
JpaCompliance getJpaCompliance()
```
  - isFailOnPaginationOverCollectionFetchEnabled
```
boolean isFailOnPaginationOverCollectionFetchEnabled()
```
  - getImmutableEntityUpdateQueryHandlingMode
```
default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode()
```
  - inClauseParameterPaddingEnabled
```
default boolean inClauseParameterPaddingEnabled()
```
  - nativeExceptionHandling51Compliance
```
default boolean nativeExceptionHandling51Compliance()
```
  - isEnhancementAsProxyEnabled
```
default boolean isEnhancementAsProxyEnabled()
```
    Can bytecode-enhanced entity classes be used as a "proxy"?

Interface SessionFactoryOptions

Method Summary

Method Detail

getUuid

getServiceRegistry

getBeanManagerReference

getValidatorFactoryReference

isJpaBootstrap

isJtaTransactionAccessEnabled

isAllowRefreshDetachedEntity

getSessionFactoryName

isSessionFactoryNameAlsoJndiName

isFlushBeforeCompletionEnabled

isAutoCloseSessionEnabled

isStatisticsEnabled

getInterceptor

getStatelessInterceptorImplementor

getStatelessInterceptorImplementorSupplier

getStatementInspector

getSessionFactoryObservers

getBaselineSessionEventsListenerBuilder

isIdentifierRollbackEnabled

getDefaultEntityMode

getEntityTuplizerFactory

isCheckNullability

isInitializeLazyStateOutsideTransactionsEnabled

getMultiTableBulkIdStrategy

getTempTableDdlTransactionHandling

getBatchFetchStyle

isDelayBatchFetchLoaderCreationsEnabled

getDefaultBatchFetchSize

getMaximumFetchDepth

getDefaultNullPrecedence

isOrderUpdatesEnabled

isOrderInsertsEnabled

getMultiTenancyStrategy

getCurrentTenantIdentifierResolver

isJtaTrackByThread

getQuerySubstitutions

isStrictJpaQueryLanguageCompliance

isNamedQueryStartupCheckingEnabled

isConventionalJavaConstants

isSecondLevelCacheEnabled

isQueryCacheEnabled

getTimestampsCacheFactory

getCacheRegionPrefix

isMinimalPutsEnabled

isStructuredCacheEntriesEnabled

isDirectReferenceCacheEntriesEnabled

isAutoEvictCollectionCache

getSchemaAutoTooling

getJdbcBatchSize

isJdbcBatchVersionedData

isScrollableResultSetsEnabled

isWrapResultSetsEnabled

isGetGeneratedKeysEnabled

getJdbcFetchSize

getPhysicalConnectionHandlingMode

doesConnectionProviderDisableAutoCommit

getConnectionReleaseMode

isCommentsEnabled

getCustomEntityDirtinessStrategy

getEntityNameResolvers

getEntityNotFoundDelegate

getCustomSqlFunctionMap

setCheckNullability

isPreferUserTransaction

isProcedureParameterNullPassingEnabled

isCollectionJoinSubqueryRewriteEnabled

isAllowOutOfTransactionUpdateOperations

isReleaseResourcesOnCloseEnabled

getJdbcTimeZone

isQueryParametersValidationEnabled

getCriteriaLiteralHandlingMode

jdbcStyleParamsZeroBased

getJpaCompliance

isFailOnPaginationOverCollectionFetchEnabled

getImmutableEntityUpdateQueryHandlingMode

inClauseParameterPaddingEnabled

nativeExceptionHandling51Compliance