Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.SessionBuilder

Method Summary

Modifier and Type	Method and Description
public T	Returns: `this`, for method chaining autoClear(boolean Whether the Session should be automatically cleared autoClear) Should the session be automatically cleared on a failed transaction?
public T	Returns: `this`, for method chaining autoClose(boolean Should the session be automatically closed autoClose) Deprecated Only integrations can specify autoClosing behavior of individual sessions. See `org.hibernate.engine.spi.SessionOwner` Should the session be automatically closed after transaction completion?
public T	Returns: `this`, for method chaining autoJoinTransactions(boolean Should JTA transactions be automatically joined autoJoinTransactions) Should the session built automatically join in any ongoing JTA transactions.
public T	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.
public T	Returns: `this`, for method chaining connection(Connection The connection to use. connection) Adds a specific connection to the session options.
public T	Returns: `this`, for method chaining connectionHandlingMode(PhysicalConnectionHandlingMode The connection handling mode to use. mode) Signifies that the connection release mode from the original session should be used to create the new session.
public T	Returns: `this`, for method chaining connectionReleaseMode(ConnectionReleaseMode The connection release mode to use. connectionReleaseMode) Deprecated (since 5.2) use `connectionHandlingMode` instead Use a specific connection release mode for these session options.
public T	Returns: `this`, for method chaining eventListeners(SessionEventListener... The listeners to incorporate into the built Session listeners) Apply one or more SessionEventListener instances to the listeners for the Session to be built.
public default T	Returns: `this`, for method chaining flushBeforeCompletion(boolean Should the session be automatically flushed flushBeforeCompletion) Deprecated (since 5.2) use `flushMode(FlushMode)` instead. Should the session be automatically flushed during the "before completion" phase of transaction handling.
public T	Returns: `this`, for method chaining flushMode(FlushMode The initial FlushMode to use for the opened Session flushMode) Specify the initial FlushMode to use for the opened Session
public T	Returns: `this`, for method chaining interceptor(Interceptor The interceptor to use. interceptor) Adds a specific interceptor to the session options.
public T	jdbcTimeZone(TimeZone timeZone)
public T	Returns: `this`, for method chaining noInterceptor() Signifies that no `Interceptor` should be used.
public Session	Returns: The session openSession() Deprecated as a consequence of `Session` being deprecated. Opens a session with the specified options.
public default T	Returns: `this`, for method chaining setQueryParameterValidation(boolean `true` indicates the validation should be performed, `false` otherwise The default value is `true` enabled) Should `org.hibernate.query.Query#setParameter` perform parameter validation when the Session is bootstrapped via JPA `javax.persistence.EntityManagerFactory`
public T	Returns: `this`, for method chaining statementInspector(StatementInspector The StatementInspector to use. statementInspector) Applies a specific StatementInspector to the session options.
public T	Returns: `this`, for method chaining tenantIdentifier(String The tenant identifier. tenantIdentifier) Define the tenant identifier to be associated with the opened session.

Method Detail

autoClear back to summary

autoClear	back to summary
public T autoClear(boolean autoClear) Should the session be automatically cleared on a failed transaction? Parameters autoClear:boolean Whether the Session should be automatically cleared Returns:T `this`, for method chaining

public T autoClear(boolean autoClear)

Should the session be automatically cleared on a failed transaction?

Parameters

autoClear:boolean: Whether the Session should be automatically cleared

Returns:T

this, for method chaining

autoClose back to summary

autoClose	back to summary
public T autoClose(boolean autoClose) Deprecated Only integrations can specify autoClosing behavior of individual sessions. See `org.hibernate.engine.spi.SessionOwner` Should the session be automatically closed after transaction completion? Parameters autoClose:boolean Should the session be automatically closed Returns:T `this`, for method chaining Annotations @Deprecated See Also `javax.persistence.PersistenceContextType`

public T autoClose(boolean autoClose)

Deprecated

Only integrations can specify autoClosing behavior of individual sessions. See org.hibernate.engine.spi.SessionOwner

Should the session be automatically closed after transaction completion?

Parameters

autoClose:boolean: Should the session be automatically closed

Returns:T

this, for method chaining

Annotations

@Deprecated

autoJoinTransactions back to summary

autoJoinTransactions	back to summary
public T autoJoinTransactions(boolean autoJoinTransactions) Should the session built automatically join in any ongoing JTA transactions. Parameters autoJoinTransactions:boolean Should JTA transactions be automatically joined Returns:T `this`, for method chaining See Also `javax.persistence.SynchronizationType#SYNCHRONIZED`

public T autoJoinTransactions(boolean autoJoinTransactions)

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

Parameters

autoJoinTransactions:boolean: Should JTA transactions be automatically joined

Returns:T

this, for method chaining

clearEventListeners	back to summary
public T 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. `this`, for method chaining

connection back to summary

connection	back to summary
public T connection(Connection connection) Adds a specific connection to the session options. Parameters connection:Connection The connection to use. Returns:T `this`, for method chaining

public T connection(Connection connection)

Adds a specific connection to the session options.

Parameters

connection:Connection: The connection to use.

Returns:T

this, for method chaining

connectionHandlingMode back to summary

connectionHandlingMode	back to summary
public T connectionHandlingMode(PhysicalConnectionHandlingMode mode) Signifies that the connection release mode from the original session should be used to create the new session. Parameters mode:PhysicalConnectionHandlingMode The connection handling mode to use. Returns:T `this`, for method chaining

public T connectionHandlingMode(PhysicalConnectionHandlingMode mode)

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

Parameters

mode:PhysicalConnectionHandlingMode: The connection handling mode to use.

Returns:T

this, for method chaining

connectionReleaseMode back to summary

connectionReleaseMode	back to summary
public T connectionReleaseMode(ConnectionReleaseMode connectionReleaseMode) Deprecated (since 5.2) use `connectionHandlingMode` instead Use a specific connection release mode for these session options. Parameters connectionReleaseMode:ConnectionReleaseMode The connection release mode to use. Returns:T `this`, for method chaining Annotations @Deprecated

public T connectionReleaseMode(ConnectionReleaseMode connectionReleaseMode)

Deprecated

(since 5.2) use connectionHandlingMode instead

Use a specific connection release mode for these session options.

Parameters

connectionReleaseMode:ConnectionReleaseMode: The connection release mode to use.

Returns:T

this, for method chaining

Annotations

@Deprecated

eventListeners back to summary

eventListeners	back to summary
public T eventListeners(SessionEventListener... listeners) Apply one or more SessionEventListener instances to the listeners for the Session to be built. Parameters listeners:SessionEventListener[] The listeners to incorporate into the built Session Returns:T `this`, for method chaining

public T eventListeners(SessionEventListener... listeners)

Apply one or more SessionEventListener instances to the listeners for the Session to be built.

Parameters

listeners:SessionEventListener[]: The listeners to incorporate into the built Session

Returns:T

this, for method chaining

flushBeforeCompletion back to summary

flushBeforeCompletion	back to summary
public default T flushBeforeCompletion(boolean flushBeforeCompletion) Deprecated (since 5.2) use `flushMode(FlushMode)` instead. Should the session be automatically flushed during the "before completion" phase of transaction handling. Parameters flushBeforeCompletion:boolean Should the session be automatically flushed Returns:T `this`, for method chaining Annotations @Deprecated @SuppressWarnings:unchecked

public default T flushBeforeCompletion(boolean flushBeforeCompletion)

Deprecated

(since 5.2) use flushMode(FlushMode) instead.

Should the session be automatically flushed during the "before completion" phase of transaction handling.

Parameters

flushBeforeCompletion:boolean: Should the session be automatically flushed

Returns:T

this, for method chaining

Annotations

@Deprecated
@SuppressWarnings:unchecked

flushMode back to summary

flushMode	back to summary
public T flushMode(FlushMode flushMode) Specify the initial FlushMode to use for the opened Session Parameters flushMode:FlushMode The initial FlushMode to use for the opened Session Returns:T `this`, for method chaining See Also `javax.persistence.PersistenceContextType`

public T flushMode(FlushMode flushMode)

Specify the initial FlushMode to use for the opened Session

Parameters

flushMode:FlushMode: The initial FlushMode to use for the opened Session

Returns:T

this, for method chaining

interceptor back to summary

interceptor	back to summary
public T interceptor(Interceptor interceptor) Adds a specific interceptor to the session options. Parameters interceptor:Interceptor The interceptor to use. Returns:T `this`, for method chaining

public T interceptor(Interceptor interceptor)

Adds a specific interceptor to the session options.

Parameters

interceptor:Interceptor: The interceptor to use.

Returns:T

this, for method chaining

jdbcTimeZone	back to summary
public T jdbcTimeZone(TimeZone timeZone)

noInterceptor back to summary

noInterceptor	back to summary
public T noInterceptor() Signifies that no `Interceptor` should be used. By default the `Interceptor` associated with the `SessionFactory` is passed to the `Session` whenever we open one without the user having specified a specific interceptor to use. Calling `interceptor(Interceptor)` with null has the same net effect. Returns:T `this`, for method chaining

public T noInterceptor()

Signifies that no Interceptor should be used.

By default the Interceptor associated with the SessionFactory is passed to the Session whenever we open one without the user having specified a specific interceptor to use.

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

Returns:T: this, for method chaining

openSession back to summary

openSession	back to summary
public Session openSession() Deprecated as a consequence of `Session` being deprecated. See corresponding docs for further information. Opens a session with the specified options. Returns:Session The session

public Session openSession()

Deprecated

as a consequence of Session being deprecated. See corresponding docs for further information.

Opens a session with the specified options.

Returns:Session: The session

setQueryParameterValidation back to summary

setQueryParameterValidation	back to summary
public default T setQueryParameterValidation(boolean enabled) Should `org.hibernate.query.Query#setParameter` perform parameter validation when the Session is bootstrapped via JPA `javax.persistence.EntityManagerFactory` Parameters enabled:boolean `true` indicates the validation should be performed, `false` otherwise The default value is `true` Returns:T `this`, for method chaining

public default T setQueryParameterValidation(boolean enabled)

Should org.hibernate.query.Query#setParameter perform parameter validation when the Session is bootstrapped via JPA javax.persistence.EntityManagerFactory

Parameters

enabled:boolean

true indicates the validation should be performed, false otherwise

The default value is true

Returns:T

this, for method chaining

statementInspector back to summary

statementInspector	back to summary
public T statementInspector(StatementInspector statementInspector) Applies a specific StatementInspector to the session options. Parameters statementInspector:StatementInspector The StatementInspector to use. Returns:T `this`, for method chaining

public T statementInspector(StatementInspector statementInspector)

Applies a specific StatementInspector to the session options.

Parameters

statementInspector:StatementInspector: The StatementInspector to use.

Returns:T

this, for method chaining

tenantIdentifier back to summary

tenantIdentifier	back to summary
public T tenantIdentifier(String tenantIdentifier) Define the tenant identifier to be associated with the opened session. Parameters tenantIdentifier:String The tenant identifier. Returns:T `this`, for method chaining

public T tenantIdentifier(String tenantIdentifier)

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

Parameters

tenantIdentifier:String: The tenant identifier.

Returns:T

this, for method chaining

public Interface SessionBuilder<T extends org.hibernate.SessionBuilder>

Method Summary

Method Detail