Package org.hibernate

Interface SharedSessionBuilder

All Superinterfaces:

SessionBuilder

All Known Implementing Classes:

AbstractDelegatingSharedSessionBuilder

public interface SharedSessionBuilder
extends SessionBuilder

Specialized SessionBuilder with access to stuff from another session.

See Also:

• Session.sessionWithOptions()

Method Summary

Modifier and Type	Method	Description
SharedSessionBuilder	autoClear(boolean autoClear)	Should the session be automatically cleared on a failed transaction?
SharedSessionBuilder	autoClose()	Signifies that the autoClose flag from the original session should be used to create the new session.
SharedSessionBuilder	autoClose(boolean autoClose)	Should the session be automatically closed after transaction completion?
SharedSessionBuilder	autoJoinTransactions()	Signifies that the autoJoinTransaction flag from the original session should be used to create the new session.
SharedSessionBuilder	autoJoinTransactions(boolean autoJoinTransactions)	Should the session built automatically join in any ongoing JTA transactions.
SharedSessionBuilder	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.
SharedSessionBuilder	connection()	Signifies that the connection from the original session should be used to create the new session.
SharedSessionBuilder	connection(Connection connection)	Adds a specific connection to the session options.
SharedSessionBuilder	connectionHandling(ConnectionAcquisitionMode acquisitionMode, ConnectionReleaseMode releaseMode)	Specifies the connection handling modes for the session.
SharedSessionBuilder	connectionHandlingMode()	Signifies that the connection release mode from the original session should be used to create the new session.
SharedSessionBuilder	connectionHandlingMode(PhysicalConnectionHandlingMode mode)	Deprecated.
SharedSessionBuilder	connectionReleaseMode()	Deprecated. use connectionHandling(org.hibernate.ConnectionAcquisitionMode, org.hibernate.ConnectionReleaseMode) instead.
SharedSessionBuilder	eventListeners(SessionEventListener... listeners)	Add one or more SessionEventListener instances to the list of listeners for the new session to be built.
SharedSessionBuilder	flushMode()	Signifies that the FlushMode from the original session should be used to create the new session.
SharedSessionBuilder	flushMode(FlushMode flushMode)	Specify the initial FlushMode to use for the opened Session
SharedSessionBuilder	identifierRollback(boolean identifierRollback)	Enable identifier rollback after entity removal for the session.
SharedSessionBuilder	interceptor()	Signifies the interceptor from the original session should be used to create the new session.
SharedSessionBuilder	interceptor(Interceptor interceptor)	Adds a specific interceptor to the session options.
SharedSessionBuilder	jdbcTimeZone(TimeZone timeZone)	Specify the JDBC time zone for the session.
SharedSessionBuilder	noInterceptor()	Signifies that no Interceptor should be used.
SessionBuilder	statementInspector(UnaryOperator<String> operator)	Applies the given statement inspection function to the session.
SharedSessionBuilder	statementInspector(StatementInspector statementInspector)	Deprecated.
SharedSessionBuilder	tenantIdentifier(Object tenantIdentifier)	Define the tenant identifier to be associated with the opened session.
SharedSessionBuilder	tenantIdentifier(String tenantIdentifier)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from interface org.hibernate.SessionBuilder

openSession

Method Details

connection

SharedSessionBuilder connection()

Signifies that the connection from the original session should be used to create the new session.

Returns:

this, for method chaining

interceptor

SharedSessionBuilder interceptor()

Signifies the interceptor from the original session should be used to create the new session.

Returns:

this, for method chaining

connectionReleaseMode

@Deprecated(since="6.0")
SharedSessionBuilder connectionReleaseMode()

Deprecated.

use connectionHandling(org.hibernate.ConnectionAcquisitionMode, org.hibernate.ConnectionReleaseMode) instead.

Signifies that the connection release mode from the original session should be used to create the new session.

Returns:

this, for method chaining

connectionHandlingMode

SharedSessionBuilder connectionHandlingMode()

Signifies that the connection release mode from the original session should be used to create the new session.

Returns:

this, for method chaining

autoJoinTransactions

SharedSessionBuilder autoJoinTransactions()

Signifies that the autoJoinTransaction flag from the original session should be used to create the new session.

Returns:

this, for method chaining

flushMode

SharedSessionBuilder flushMode()

Signifies that the FlushMode from the original session should be used to create the new session.

Returns:

this, for method chaining

autoClose

SharedSessionBuilder autoClose()

Signifies that the autoClose flag from the original session should be used to create the new session.

Returns:

this, for method chaining

statementInspector

@Deprecated
SharedSessionBuilder statementInspector(StatementInspector statementInspector)

Deprecated.

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

statementInspector

SessionBuilder statementInspector(UnaryOperator<String> operator)

Description copied from interface: SessionBuilder

Applies the given statement inspection function to the session.

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. Alternatively. the operator may work by side effect, and simply return the original SQL.

Returns:

this, for method chaining

connectionHandlingMode

@Deprecated
SharedSessionBuilder connectionHandlingMode(PhysicalConnectionHandlingMode mode)

Deprecated.

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

connectionHandling

SharedSessionBuilder 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 SessionBuilder

Returns:

this, for method chaining

autoClear

SharedSessionBuilder 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

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

SharedSessionBuilder tenantIdentifier(Object tenantIdentifier)

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

eventListeners

SharedSessionBuilder 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

SharedSessionBuilder 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

SharedSessionBuilder jdbcTimeZone(TimeZone timeZone)

Description copied from interface: SessionBuilder

Specify the JDBC time zone for the session.

Specified by:

jdbcTimeZone in interface SessionBuilder

Returns:

this, for method chaining

interceptor

SharedSessionBuilder interceptor(Interceptor interceptor)

Description copied from interface: SessionBuilder

Adds a specific interceptor to the session options.

Specified by:

interceptor in interface SessionBuilder

Parameters:

interceptor - The interceptor to use.

Returns:

this, for method chaining

noInterceptor

SharedSessionBuilder noInterceptor()

Description copied from interface: SessionBuilder

Signifies 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.

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

Specified by:

noInterceptor in interface SessionBuilder

Returns:

this, for method chaining

connection

SharedSessionBuilder connection(Connection connection)

Description copied from interface: SessionBuilder

Adds a specific connection to the session options.

Specified by:

connection in interface SessionBuilder

Parameters:

connection - The connection to use.

Returns:

this, for method chaining

autoJoinTransactions

SharedSessionBuilder 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

autoClose

SharedSessionBuilder 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

SharedSessionBuilder 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