org.hibernate

Interface SessionBuilder

All Known Subinterfaces:

FullTextSharedSessionBuilder, SessionBuilderImplementor, SharedSessionBuilder

All Known Implementing Classes:

AbstractDelegatingSessionBuilder, AbstractDelegatingSessionBuilderImplementor, AbstractDelegatingSharedSessionBuilder

public interface SessionBuilder

Represents a consolidation of all session creation options into a builder style delegate.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
SessionBuilder	autoClose(boolean autoClose) Deprecated. Only integrations can specify autoClosing behavior of individual sessions. See SessionOwner
SessionBuilder	autoJoinTransactions(boolean autoJoinTransactions) Should the session built automatically join in any ongoing JTA transactions.
SessionBuilder	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.
SessionBuilder	connection(Connection connection) Adds a specific connection to the session options.
SessionBuilder	connectionReleaseMode(ConnectionReleaseMode connectionReleaseMode) Use a specific connection release mode for these session options.
SessionBuilder	eventListeners(SessionEventListener... listeners) Apply one or more SessionEventListener instances to the listeners for the Session to be built.
SessionBuilder	flushBeforeCompletion(boolean flushBeforeCompletion) Should the session be automatically flushed during the "before completion" phase of transaction handling.
SessionBuilder	interceptor(Interceptor interceptor) Adds a specific interceptor to the session options.
SessionBuilder	noInterceptor() Signifies that no Interceptor should be used.
Session	openSession() Opens a session with the specified options.
SessionBuilder	statementInspector(StatementInspector statementInspector) Applies a specific StatementInspector to the session options.
SessionBuilder	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

SessionBuilder interceptor(Interceptor interceptor)

Adds a specific interceptor to the session options.

Parameters:

interceptor - The interceptor to use.

Returns:

this, for method chaining

noInterceptor

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

this, for method chaining

statementInspector

SessionBuilder statementInspector(StatementInspector statementInspector)

Applies a specific StatementInspector to the session options.

Parameters:

statementInspector - The StatementInspector to use.

Returns:

this, for method chaining

connection

SessionBuilder connection(Connection connection)

Adds a specific connection to the session options.

Parameters:

connection - The connection to use.

Returns:

this, for method chaining

connectionReleaseMode

SessionBuilder connectionReleaseMode(ConnectionReleaseMode connectionReleaseMode)

Use a specific connection release mode for these session options.

Parameters:

connectionReleaseMode - The connection release mode to use.

Returns:

this, for method chaining

autoJoinTransactions

SessionBuilder 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

autoClose

@Deprecated
SessionBuilder autoClose(boolean autoClose)

Deprecated. Only integrations can specify autoClosing behavior of individual sessions. See SessionOwner

Should the session be automatically closed after transaction completion.

Parameters:

autoClose - Should the session be automatically closed

Returns:

this, for method chaining

flushBeforeCompletion

SessionBuilder flushBeforeCompletion(boolean flushBeforeCompletion)

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

Parameters:

flushBeforeCompletion - Should the session be automatically flushed

Returns:

this, for method chaining

tenantIdentifier

SessionBuilder 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

SessionBuilder eventListeners(SessionEventListener... listeners)

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

Parameters:

listeners - The listeners to incorporate into the built Session

Returns:

this, for method chaining

clearEventListeners

SessionBuilder 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