Package org.hibernate
Interface SessionBuilder<T extends SessionBuilder>
-
- All Known Subinterfaces:
SessionBuilderImplementor<T>
,SharedSessionBuilder<T>
- All Known Implementing Classes:
AbstractDelegatingSessionBuilder
,AbstractDelegatingSessionBuilderImplementor
,AbstractDelegatingSharedSessionBuilder
public interface SessionBuilder<T extends SessionBuilder>
Allows creation of a newSession
with specific options.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description T
autoClear(boolean autoClear)
Should the session be automatically cleared on a failed transaction?T
autoClose(boolean autoClose)
Should the session be automatically closed after transaction completion?T
autoJoinTransactions(boolean autoJoinTransactions)
Should the session built automatically join in any ongoing JTA transactions.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.T
connection(Connection connection)
Adds a specific connection to the session options.T
connectionHandlingMode(PhysicalConnectionHandlingMode mode)
Signifies that the connection release mode from the original session should be used to create the new session.T
eventListeners(SessionEventListener... listeners)
Add one or moreSessionEventListener
instances to the list of listeners for the new session to be built.T
flushMode(FlushMode flushMode)
Specify the initial FlushMode to use for the opened SessionT
interceptor(Interceptor interceptor)
Adds a specific interceptor to the session options.T
jdbcTimeZone(TimeZone timeZone)
T
noInterceptor()
Signifies that noInterceptor
should be used.Session
openSession()
Opens a session with the specified options.T
statementInspector(StatementInspector statementInspector)
Applies the givenStatementInspector
to the session.T
tenantIdentifier(String tenantIdentifier)
Define the tenant identifier to be associated with the opened session.
-
-
-
Method Detail
-
openSession
Session openSession()
Opens a session with the specified options.- Returns:
- The session
-
interceptor
T interceptor(Interceptor interceptor)
Adds a specific interceptor to the session options.- Parameters:
interceptor
- The interceptor to use.- Returns:
this
, for method chaining
-
noInterceptor
T noInterceptor()
Signifies that noInterceptor
should be used. By default, if noInterceptor
is explicitly specified, theInterceptor
associated with theSessionFactory
is inherited by the newSession
. Callinginterceptor(Interceptor)
with null has the same effect.- Returns:
this
, for method chaining
-
statementInspector
T statementInspector(StatementInspector statementInspector)
Applies the givenStatementInspector
to the session.- Parameters:
statementInspector
- The StatementInspector to use.- Returns:
this
, for method chaining
-
connection
T connection(Connection connection)
Adds a specific connection to the session options.- Parameters:
connection
- The connection to use.- Returns:
this
, for method chaining
-
connectionHandlingMode
T connectionHandlingMode(PhysicalConnectionHandlingMode mode)
Signifies that the connection release mode from the original session should be used to create the new session.- Parameters:
mode
- The connection handling mode to use.- Returns:
this
, for method chaining
-
autoJoinTransactions
T autoJoinTransactions(boolean autoJoinTransactions)
Should the session built automatically join in any ongoing JTA transactions.- Parameters:
autoJoinTransactions
- Should JTA transactions be automatically joined- Returns:
this
, for method chaining- See Also:
SynchronizationType.SYNCHRONIZED
-
autoClear
T autoClear(boolean autoClear)
Should the session be automatically cleared on a failed transaction?- Parameters:
autoClear
- Whether the Session should be automatically cleared- Returns:
this
, for method chaining
-
flushMode
T flushMode(FlushMode flushMode)
Specify the initial FlushMode to use for the opened Session- Parameters:
flushMode
- The initial FlushMode to use for the opened Session- Returns:
this
, for method chaining- See Also:
PersistenceContextType
-
tenantIdentifier
T tenantIdentifier(String tenantIdentifier)
Define the tenant identifier to be associated with the opened session.- Parameters:
tenantIdentifier
- The tenant identifier.- Returns:
this
, for method chaining
-
eventListeners
T eventListeners(SessionEventListener... listeners)
Add one or moreSessionEventListener
instances to the list of listeners for the new session to be built.- Parameters:
listeners
- The listeners to incorporate into the built Session- Returns:
this
, for method chaining
-
clearEventListeners
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
-
autoClose
T autoClose(boolean autoClose)
Should the session be automatically closed after transaction completion?- Parameters:
autoClose
- Should the session be automatically closed- Returns:
this
, for method chaining- See Also:
PersistenceContextType
-
-