org.hibernate.SessionBuilder Maven / Gradle / Ivy
Show all versions of hibernate-core Show documentation
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate;
import java.sql.Connection;
import java.util.TimeZone;
import org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode;
import org.hibernate.resource.jdbc.spi.StatementInspector;
/**
* Represents a consolidation of all session creation options into a builder style delegate.
*
* @author Steve Ebersole
*/
@SuppressWarnings("UnusedReturnValue")
public interface SessionBuilder {
/**
* Opens a session with the specified options.
*
* @return The session
*/
Session openSession();
/**
* Adds a specific interceptor to the session options.
*
* @param interceptor The interceptor to use.
*
* @return {@code this}, for method chaining
*/
T interceptor(Interceptor interceptor);
/**
* Signifies that no {@link Interceptor} should be used.
*
* By default the {@link Interceptor} associated with the {@link SessionFactory} is passed to the
* {@link Session} whenever we open one without the user having specified a specific interceptor to
* use.
*
* Calling {@link #interceptor(Interceptor)} with null has the same net effect.
*
* @return {@code this}, for method chaining
*/
T noInterceptor();
/**
* Applies a specific StatementInspector to the session options.
*
* @param statementInspector The StatementInspector to use.
*
* @return {@code this}, for method chaining
*/
T statementInspector(StatementInspector statementInspector);
/**
* Adds a specific connection to the session options.
*
* @param connection The connection to use.
*
* @return {@code this}, for method chaining
*/
T connection(Connection connection);
/**
* Signifies that the connection release mode from the original session should be used to create the new session.
*
* @param mode The connection handling mode to use.
*
* @return {@code this}, for method chaining
*/
T connectionHandlingMode(PhysicalConnectionHandlingMode mode);
/**
* Should the session built automatically join in any ongoing JTA transactions.
*
* @param autoJoinTransactions Should JTA transactions be automatically joined
*
* @return {@code this}, for method chaining
*
* @see javax.persistence.SynchronizationType#SYNCHRONIZED
*/
T autoJoinTransactions(boolean autoJoinTransactions);
/**
* Should the session be automatically cleared on a failed transaction?
*
* @param autoClear Whether the Session should be automatically cleared
*
* @return {@code this}, for method chaining
*/
T autoClear(boolean autoClear);
/**
* Specify the initial FlushMode to use for the opened Session
*
* @param flushMode The initial FlushMode to use for the opened Session
*
* @return {@code this}, for method chaining
*
* @see javax.persistence.PersistenceContextType
*/
T flushMode(FlushMode flushMode);
/**
* Define the tenant identifier to be associated with the opened session.
*
* @param tenantIdentifier The tenant identifier.
*
* @return {@code this}, for method chaining
*/
T tenantIdentifier(String tenantIdentifier);
/**
* Apply one or more SessionEventListener instances to the listeners for the Session to be built.
*
* @param listeners The listeners to incorporate into the built Session
*
* @return {@code this}, for method chaining
*/
T eventListeners(SessionEventListener... listeners);
/**
* Remove all listeners intended for the built Session currently held here, including any auto-apply ones; in other
* words, start with a clean slate.
*
* {@code this}, for method chaining
*/
T clearEventListeners();
T jdbcTimeZone(TimeZone timeZone);
/**
* Should {@link org.hibernate.query.Query#setParameter} perform parameter validation
* when the Session is bootstrapped via JPA {@link javax.persistence.EntityManagerFactory}
*
* @param enabled {@code true} indicates the validation should be performed, {@code false} otherwise
*
* The default value is {@code true}
*
* @return {@code this}, for method chaining
*/
default T setQueryParameterValidation(boolean enabled) {
return (T) this;
}
/**
* Should the session be automatically closed after transaction completion?
*
* @param autoClose Should the session be automatically closed
*
* @return {@code this}, for method chaining
*
* @see javax.persistence.PersistenceContextType
*
* @deprecated Only integrations can specify autoClosing behavior of individual sessions. See
* {@link org.hibernate.engine.spi.SessionOwner}
*/
@Deprecated
T autoClose(boolean autoClose);
/**
* Use a specific connection release mode for these session options.
*
* @param connectionReleaseMode The connection release mode to use.
*
* @return {@code this}, for method chaining
*
* @deprecated (since 5.2) use {@link #connectionHandlingMode} instead
*/
@Deprecated
T connectionReleaseMode(ConnectionReleaseMode connectionReleaseMode);
/**
* Should the session be automatically flushed during the "before completion" phase of transaction handling.
*
* @param flushBeforeCompletion Should the session be automatically flushed
*
* @return {@code this}, for method chaining
*
* @deprecated (since 5.2) use {@link #flushMode(FlushMode)} instead.
*/
@Deprecated
@SuppressWarnings("unchecked")
default T flushBeforeCompletion(boolean flushBeforeCompletion) {
if ( flushBeforeCompletion ) {
flushMode( FlushMode.ALWAYS );
}
else {
flushMode( FlushMode.MANUAL );
}
return (T) this;
}
}