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

All Known Implementing Classes:

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

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BaselineSessionEventsListenerBuilder`	`getBaselineSessionEventsListenerBuilder()`
`BatchFetchStyle`	`getBatchFetchStyle()`
`Object`	`getBeanManagerReference()`
`String`	`getCacheRegionPrefix()`
`ConnectionReleaseMode`	`getConnectionReleaseMode()` Deprecated. Use `getPhysicalConnectionHandlingMode()` instead
`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()`
`Interceptor`	`getInterceptor()` Get the interceptor to use by default for all sessions opened from this factory.
`int`	`getJdbcBatchSize()`
`Integer`	`getJdbcFetchSize()`
`Integer`	`getMaximumFetchDepth()`
`MultiTableBulkIdStrategy`	`getMultiTableBulkIdStrategy()`
`MultiTenancyStrategy`	`getMultiTenancyStrategy()`
`PhysicalConnectionHandlingMode`	`getPhysicalConnectionHandlingMode()`
`QueryCacheFactory`	`getQueryCacheFactory()`
`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()`
`StatementInspector`	`getStatementInspector()`
`TempTableDdlTransactionHandling`	`getTempTableDdlTransactionHandling()`
`Object`	`getValidatorFactoryReference()`
`boolean`	`isAutoCloseSessionEnabled()`
`boolean`	`isAutoEvictCollectionCache()`
`boolean`	`isCheckNullability()`
`boolean`	`isCollectionJoinSubqueryRewriteEnabled()`
`boolean`	`isCommentsEnabled()`
`boolean`	`isDirectReferenceCacheEntriesEnabled()`
`boolean`	`isFlushBeforeCompletionEnabled()`
`boolean`	`isGetGeneratedKeysEnabled()`
`boolean`	`isIdentifierRollbackEnabled()`
`boolean`	`isInitializeLazyStateOutsideTransactionsEnabled()`
`boolean`	`isJdbcBatchVersionedData()`
`boolean`	`isJtaTrackByThread()`
`boolean`	`isMinimalPutsEnabled()`
`boolean`	`isNamedQueryStartupCheckingEnabled()`
`boolean`	`isOrderInsertsEnabled()`
`boolean`	`isOrderUpdatesEnabled()`
`boolean`	`isPreferUserTransaction()`
`boolean`	`isProcedureParameterNullPassingEnabled()`
`boolean`	`isQueryCacheEnabled()`
`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
```
Object getBeanManagerReference()
```

getValidatorFactoryReference
```
Object getValidatorFactoryReference()
```

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

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
```
Integer getMaximumFetchDepth()
```

getDefaultNullPrecedence

NullPrecedence getDefaultNullPrecedence()

isOrderUpdatesEnabled
```
boolean isOrderUpdatesEnabled()
```

isOrderInsertsEnabled
```
boolean isOrderInsertsEnabled()
```

getMultiTenancyStrategy

MultiTenancyStrategy getMultiTenancyStrategy()

getCurrentTenantIdentifierResolver

CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()

isJtaTrackByThread
```
boolean isJtaTrackByThread()
```

getQuerySubstitutions
```
Map getQuerySubstitutions()
```

isStrictJpaQueryLanguageCompliance

boolean isStrictJpaQueryLanguageCompliance()

isNamedQueryStartupCheckingEnabled

boolean isNamedQueryStartupCheckingEnabled()

isSecondLevelCacheEnabled
```
boolean isSecondLevelCacheEnabled()
```

isQueryCacheEnabled
```
boolean isQueryCacheEnabled()
```

getQueryCacheFactory

QueryCacheFactory getQueryCacheFactory()

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()

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()

Interface SessionFactoryOptions

Method Summary

Method Detail

getServiceRegistry

getBeanManagerReference

getValidatorFactoryReference

getSessionFactoryName

isSessionFactoryNameAlsoJndiName

isFlushBeforeCompletionEnabled

isAutoCloseSessionEnabled

isStatisticsEnabled

getInterceptor

getStatementInspector

getSessionFactoryObservers

getBaselineSessionEventsListenerBuilder

isIdentifierRollbackEnabled

getDefaultEntityMode

getEntityTuplizerFactory

isCheckNullability

isInitializeLazyStateOutsideTransactionsEnabled

getMultiTableBulkIdStrategy

getTempTableDdlTransactionHandling

getBatchFetchStyle

getDefaultBatchFetchSize

getMaximumFetchDepth

getDefaultNullPrecedence

isOrderUpdatesEnabled

isOrderInsertsEnabled

getMultiTenancyStrategy

getCurrentTenantIdentifierResolver

isJtaTrackByThread

getQuerySubstitutions

isStrictJpaQueryLanguageCompliance

isNamedQueryStartupCheckingEnabled

isSecondLevelCacheEnabled

isQueryCacheEnabled

getQueryCacheFactory

getCacheRegionPrefix

isMinimalPutsEnabled

isStructuredCacheEntriesEnabled

isDirectReferenceCacheEntriesEnabled

isAutoEvictCollectionCache

getSchemaAutoTooling

getJdbcBatchSize

isJdbcBatchVersionedData

isScrollableResultSetsEnabled

isWrapResultSetsEnabled

isGetGeneratedKeysEnabled

getJdbcFetchSize

getPhysicalConnectionHandlingMode

getConnectionReleaseMode

isCommentsEnabled

getCustomEntityDirtinessStrategy

getEntityNameResolvers

getEntityNotFoundDelegate

getCustomSqlFunctionMap

setCheckNullability

isPreferUserTransaction

isProcedureParameterNullPassingEnabled

isCollectionJoinSubqueryRewriteEnabled