Package org.hibernate.engine.spi

Class AbstractDelegatingSessionBuilder

java.lang.Object

org.hibernate.engine.spi.AbstractDelegatingSessionBuilder

All Implemented Interfaces:

SessionBuilder

Direct Known Subclasses:

AbstractDelegatingSessionBuilderImplementor

public abstract class AbstractDelegatingSessionBuilder
extends Object
implements SessionBuilder

Base class for SessionBuilder implementations that wish to implement only parts of that contract themselves while forwarding other method invocations to a delegate instance.

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingSessionBuilder(SessionBuilder delegate)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractDelegatingSessionBuilder

public AbstractDelegatingSessionBuilder(SessionBuilder delegate)

Method Details

getThis

protected SessionBuilder getThis()

delegate

protected SessionBuilder delegate()

openSession

public Session openSession()

Description copied from interface: SessionBuilder

Opens a session with the specified options.

Specified by:

openSession in interface SessionBuilder

Returns:

The session

interceptor

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

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

statementInspector

@Deprecated
public SessionBuilder 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

public 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

connection

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

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

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

tenantIdentifier

@Deprecated(forRemoval=true)
public SessionBuilder 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

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

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

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

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

connectionHandlingMode

@Deprecated
public SessionBuilder 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

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

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

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

identifierRollback

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