Package org.hibernate.engine.creation.spi

Interface SessionBuilderImplementor

All Superinterfaces:

CommonBuilder, SessionBuilder

All Known Subinterfaces:

SharedSessionBuilderImplementor

All Known Implementing Classes:

AbstractDelegatingSessionBuilder, AbstractDelegatingSessionBuilderImplementor

public interface SessionBuilderImplementor
extends SessionBuilder

Defines the internal contract between the SessionBuilder and other parts of Hibernate.

See Also:

• SessionBuilder

Method Summary

Modifier and Type	Method	Description
SessionBuilderImplementor	autoClear(boolean autoClear)	Should the session be automatically cleared on a failed transaction?
SessionBuilderImplementor	autoClose(boolean autoClose)	Should the session be automatically closed after transaction completion?
SessionBuilderImplementor	autoJoinTransactions(boolean autoJoinTransactions)	Should the session built automatically join in any ongoing JTA transactions.
SessionBuilderImplementor	clearEventListeners()	Remove all listeners intended for the built session currently held here, including any auto-apply ones; in other words, start with a clean slate.
SessionBuilderImplementor	connection(Connection connection)	Adds a specific connection to the session options.
SessionBuilderImplementor	connectionHandling(ConnectionAcquisitionMode acquisitionMode, ConnectionReleaseMode releaseMode)	Specifies the connection handling modes for the session.
SessionBuilderImplementor	connectionHandlingMode(PhysicalConnectionHandlingMode mode)	Specifies the connection handling mode.
SessionBuilderImplementor	defaultBatchFetchSize(int defaultBatchFetchSize)	Specify the default batch fetch size for the session.
SessionBuilderImplementor	eventListeners(SessionEventListener... listeners)	Add one or more SessionEventListener instances to the list of listeners for the new session to be built.
SessionBuilderImplementor	flushMode(FlushMode flushMode)	Specify the initial FlushMode to use for the opened Session
SessionBuilderImplementor	identifierRollback(boolean identifierRollback)	Enable identifier rollback after entity removal for the session.
SessionBuilderImplementor	initialCacheMode(CacheMode cacheMode)	Specify the initial CacheMode for the session.
SessionBuilderImplementor	interceptor(Interceptor interceptor)	Adds a specific interceptor to the session options.
SessionBuilderImplementor	jdbcTimeZone(TimeZone timeZone)	Specify the JDBC time zone for the session.
SessionBuilderImplementor	noInterceptor()	Specifies that no Interceptor should be used.
SessionBuilderImplementor	noSessionInterceptorCreation()	Specifies that no session-scoped interceptor should be instantiated for the new session.
SessionBuilderImplementor	noStatementInspector()	Signifies that no SQL statement inspector should be used.
SessionImplementor	openSession()	Opens a session with the specified options.
SessionBuilderImplementor	readOnly(boolean readOnly)	Specify a read-only mode for the session.
SessionBuilderImplementor	statementInspector(UnaryOperator<String> operator)	Applies the given statement inspection function to the session.
SessionBuilderImplementor	statementInspector(StatementInspector statementInspector)	Applies the given StatementInspector to the session.
SessionBuilderImplementor	subselectFetchEnabled(boolean subselectFetchEnabled)	Specify whether subselect fetching is enabled for the session.
SessionBuilderImplementor	tenantIdentifier(Object tenantIdentifier)	Define the tenant identifier to be associated with the opened session.
SessionBuilderImplementor	tenantIdentifier(String tenantIdentifier)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

openSession

SessionImplementor openSession()

Description copied from interface: SessionBuilder

Opens a session with the specified options.

Specified by:

openSession in interface SessionBuilder

Returns:

The session

interceptor

SessionBuilderImplementor interceptor(Interceptor interceptor)

Description copied from interface: CommonBuilder

Adds a specific interceptor to the session options.

Specified by:

interceptor in interface CommonBuilder

Specified by:

interceptor in interface SessionBuilder

Parameters:

interceptor - The interceptor to use.

Returns:

this, for method chaining

noInterceptor

SessionBuilderImplementor noInterceptor()

Description copied from interface: CommonBuilder

Specifies that no Interceptor should be used.

By default, if no Interceptor is explicitly specified, the Interceptor associated with the SessionFactory is inherited by the new session. Or, if there is no interceptor associated with the SessionFactory, but a session-scoped interceptor has been configured, a new session-scoped Interceptor will be created for the new session.

Calling interceptor(null) has the same effect.

Specified by:

noInterceptor in interface CommonBuilder

Specified by:

noInterceptor in interface SessionBuilder

Returns:

this, for method chaining

noSessionInterceptorCreation

SessionBuilderImplementor noSessionInterceptorCreation()

Description copied from interface: CommonBuilder

Specifies that no session-scoped interceptor should be instantiated for the new session.

By default, if no Interceptor is explicitly specified, and if there is no interceptor associated with the SessionFactory, but a session-scoped interceptor has been configured, a new session-scoped Interceptor will be created for the new session.

Note that this operation does not disable use of an interceptor associated with the SessionFactory.

Specified by:

noSessionInterceptorCreation in interface CommonBuilder

Specified by:

noSessionInterceptorCreation in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• SessionEventSettings.SESSION_SCOPED_INTERCEPTOR

statementInspector

SessionBuilderImplementor statementInspector(UnaryOperator<String> operator)

Description copied from interface: CommonBuilder

Applies the given statement inspection function to the session.

Specified by:

statementInspector in interface CommonBuilder

Specified by:

statementInspector in interface SessionBuilder

Parameters:

operator - An operator which accepts a SQL string, returning a processed SQL string to be used by Hibernate instead of the given original SQL. The operator may simply return the original SQL.

Returns:

this, for method chaining

statementInspector

SessionBuilderImplementor statementInspector(StatementInspector statementInspector)

Description copied from interface: SessionBuilder

Applies the given StatementInspector to the session.

Specified by:

statementInspector in interface SessionBuilder

Parameters:

statementInspector - The StatementInspector to use.

Returns:

this, for method chaining

connection

SessionBuilderImplementor connection(Connection connection)

Description copied from interface: SessionBuilder

Adds a specific connection to the session options.

Specified by:

connection in interface CommonBuilder

Specified by:

connection in interface SessionBuilder

Parameters:

connection - The connection to use.

Returns:

this, for method chaining

connectionHandling

SessionBuilderImplementor connectionHandling(ConnectionAcquisitionMode acquisitionMode,
 ConnectionReleaseMode releaseMode)

Description copied from interface: SessionBuilder

Specifies the connection handling modes for the session.

Note that if ConnectionAcquisitionMode.IMMEDIATELY is specified, then the release mode must be ConnectionReleaseMode.ON_CLOSE.

Specified by:

connectionHandling in interface CommonBuilder

Specified by:

connectionHandling in interface SessionBuilder

Returns:

this, for method chaining

connectionHandlingMode

SessionBuilderImplementor connectionHandlingMode(PhysicalConnectionHandlingMode mode)

Description copied from interface: SessionBuilder

Specifies the connection handling mode.

Specified by:

connectionHandlingMode in interface SessionBuilder

Parameters:

mode - The connection handling mode to use.

Returns:

this, for method chaining

autoJoinTransactions

SessionBuilderImplementor autoJoinTransactions(boolean autoJoinTransactions)

Description copied from interface: SessionBuilder

Should the session built automatically join in any ongoing JTA transactions.

Specified by:

autoJoinTransactions in interface SessionBuilder

Parameters:

autoJoinTransactions - Should JTA transactions be automatically joined

Returns:

this, for method chaining

See Also:

• SynchronizationType.SYNCHRONIZED

autoClear

SessionBuilderImplementor autoClear(boolean autoClear)

Description copied from interface: SessionBuilder

Should the session be automatically cleared on a failed transaction?

Specified by:

autoClear in interface SessionBuilder

Parameters:

autoClear - Whether the Session should be automatically cleared

Returns:

this, for method chaining

flushMode

SessionBuilderImplementor flushMode(FlushMode flushMode)

Description copied from interface: SessionBuilder

Specify the initial FlushMode to use for the opened Session

Specified by:

flushMode in interface SessionBuilder

Parameters:

flushMode - The initial FlushMode to use for the opened Session

Returns:

this, for method chaining

See Also:

• PersistenceContextType

tenantIdentifier

@Deprecated(forRemoval=true)
SessionBuilderImplementor tenantIdentifier(String tenantIdentifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SessionBuilder

Define the tenant identifier to be associated with the opened session.

Specified by:

tenantIdentifier in interface SessionBuilder

Parameters:

tenantIdentifier - The tenant identifier.

Returns:

this, for method chaining

tenantIdentifier

SessionBuilderImplementor tenantIdentifier(Object tenantIdentifier)

Description copied from interface: SessionBuilder

Define the tenant identifier to be associated with the opened session.

Specified by:

tenantIdentifier in interface CommonBuilder

Specified by:

tenantIdentifier in interface SessionBuilder

Parameters:

tenantIdentifier - The tenant identifier.

Returns:

this, for method chaining

readOnly

SessionBuilderImplementor readOnly(boolean readOnly)

Description copied from interface: CommonBuilder

Specify a read-only mode for the session. If a session is created in read-only mode, then Connection.setReadOnly(boolean) is called when a JDBC connection is obtained.

Furthermore, if read/write replication is in use, then:

• a read-only session will connect to a read-only replica, but
• a non-read-only session will connect to a writable replica.

When read/write replication is in use, it's strongly recommended that the session be created with the initial cache mode set to CacheMode.GET, to avoid writing stale data read from a read-only replica to the second-level cache. Hibernate cannot possibly guarantee that data read from a read-only replica is up to date.

When read/write replication is in use, it's possible that an item read from the second-level cache might refer to data which does not yet exist in the read-only replica. In this situation, an exception occurs when the association is fetched. To completely avoid this possibility, the initial cache mode must be set to CacheMode.IGNORE. However, it's also usually possible to structure data access code in a way which eliminates this possibility.

 try (var readOnlySession =
         sessionFactory.withOptions()
                 .readOnly(true)
                 .initialCacheMode(CacheMode.IGNORE)
                 .openSession()) {
     ...
 }
 

If a session is created in read-only mode, then it cannot be changed to read-write mode, and any call to Session.setDefaultReadOnly(boolean) with fail. On the other hand, if a session is created in read-write mode, then it may later be switched to read-only mode, but all database access is directed to the writable replica.

Specified by:

readOnly in interface CommonBuilder

Specified by:

readOnly in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• MultiTenantConnectionProvider.getReadOnlyConnection(Object)
• MultiTenantConnectionProvider.releaseReadOnlyConnection(Object, Connection)

initialCacheMode

SessionBuilderImplementor initialCacheMode(CacheMode cacheMode)

Description copied from interface: CommonBuilder

Specify the initial CacheMode for the session.

Specified by:

initialCacheMode in interface CommonBuilder

Specified by:

initialCacheMode in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• SharedSessionContract.getCacheMode()

eventListeners

SessionBuilderImplementor eventListeners(SessionEventListener... listeners)

Description copied from interface: SessionBuilder

Add one or more SessionEventListener instances to the list of listeners for the new session to be built.

Specified by:

eventListeners in interface SessionBuilder

Parameters:

listeners - The listeners to incorporate into the built Session

Returns:

this, for method chaining

clearEventListeners

SessionBuilderImplementor clearEventListeners()

Description copied from interface: SessionBuilder

Remove all listeners intended for the built session currently held here, including any auto-apply ones; in other words, start with a clean slate.

Specified by:

clearEventListeners in interface SessionBuilder

Returns:

this, for method chaining

jdbcTimeZone

SessionBuilderImplementor jdbcTimeZone(TimeZone timeZone)

Description copied from interface: SessionBuilder

Specify the JDBC time zone for the session.

Specified by:

jdbcTimeZone in interface CommonBuilder

Specified by:

jdbcTimeZone in interface SessionBuilder

Returns:

this, for method chaining

autoClose

SessionBuilderImplementor autoClose(boolean autoClose)

Description copied from interface: SessionBuilder

Should the session be automatically closed after transaction completion?

Specified by:

autoClose in interface SessionBuilder

Parameters:

autoClose - Should the session be automatically closed

Returns:

this, for method chaining

See Also:

• PersistenceContextType

identifierRollback

SessionBuilderImplementor identifierRollback(boolean identifierRollback)

Description copied from interface: SessionBuilder

Enable identifier rollback after entity removal for the session.

Specified by:

identifierRollback in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• AvailableSettings.USE_IDENTIFIER_ROLLBACK

noStatementInspector

SessionBuilderImplementor noStatementInspector()

Description copied from interface: CommonBuilder

Signifies that no SQL statement inspector should be used.

By default, if no inspector is explicitly specified, the inspector associated with the SessionFactory is inherited by the new session.

Calling CommonBuilder.interceptor(Interceptor) with null has the same effect.

Specified by:

noStatementInspector in interface CommonBuilder

Specified by:

noStatementInspector in interface SessionBuilder

Returns:

this, for method chaining

defaultBatchFetchSize

SessionBuilderImplementor defaultBatchFetchSize(int defaultBatchFetchSize)

Description copied from interface: SessionBuilder

Specify the default batch fetch size for the session.

Specified by:

defaultBatchFetchSize in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• FetchSettings.DEFAULT_BATCH_FETCH_SIZE
• Session.setFetchBatchSize(int)

subselectFetchEnabled

SessionBuilderImplementor subselectFetchEnabled(boolean subselectFetchEnabled)

Description copied from interface: SessionBuilder

Specify whether subselect fetching is enabled for the session.

Specified by:

subselectFetchEnabled in interface SessionBuilder

Returns:

this, for method chaining

See Also:

• FetchSettings.USE_SUBSELECT_FETCH
• Session.setSubselectFetchingEnabled(boolean)