org.hibernate.boot.spi.SessionFactoryOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* 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.boot.spi;
import java.util.Map;
import java.util.TimeZone;
import java.util.function.Supplier;
import org.hibernate.ConnectionReleaseMode;
import org.hibernate.CustomEntityDirtinessStrategy;
import org.hibernate.EntityNameResolver;
import org.hibernate.HibernateException;
import org.hibernate.Interceptor;
import org.hibernate.MultiTenancyStrategy;
import org.hibernate.NullPrecedence;
import org.hibernate.SessionFactoryObserver;
import org.hibernate.boot.SchemaAutoTooling;
import org.hibernate.boot.TempTableDdlTransactionHandling;
import org.hibernate.boot.registry.StandardServiceRegistry;
import org.hibernate.bytecode.spi.BytecodeProvider;
import org.hibernate.cache.spi.TimestampsCacheFactory;
import org.hibernate.cfg.BaselineSessionEventsListenerBuilder;
import org.hibernate.cfg.Environment;
import org.hibernate.context.spi.CurrentTenantIdentifierResolver;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.jpa.spi.JpaCompliance;
import org.hibernate.loader.BatchFetchStyle;
import org.hibernate.proxy.EntityNotFoundDelegate;
import org.hibernate.query.ImmutableEntityUpdateQueryHandlingMode;
import org.hibernate.query.QueryLiteralRendering;
import org.hibernate.query.criteria.LiteralHandlingMode;
import org.hibernate.query.sqm.consume.multitable.spi.IdTableStrategy;
import org.hibernate.query.sqm.produce.function.SqmFunctionRegistry;
import org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode;
import org.hibernate.resource.jdbc.spi.StatementInspector;
import org.hibernate.stat.Statistics;
/**
* Aggregator of special options used to build the SessionFactory.
*
* @since 5.0
*/
public interface SessionFactoryOptions {
/**
* Get the UUID unique to this SessionFactoryOptions. Will be the
* same value available as {@link SessionFactoryImplementor#getUuid()}.
*
* @apiNote The value is generated as a {@link java.util.UUID}, but kept
* as a String.
*
* @return The UUID for this SessionFactory.
*
* @see org.hibernate.internal.SessionFactoryRegistry#getSessionFactory
* @see SessionFactoryImplementor#getUuid
*/
String getUuid();
/**
* The service registry to use in building the factory.
*
* @return The service registry to use.
*/
StandardServiceRegistry getServiceRegistry();
Object getBeanManagerReference();
Object getValidatorFactoryReference();
/**
* Was building of the SessionFactory initiated through JPA bootstrapping, or
* through Hibernate's native bootstrapping?
*
* @return {@code true} indicates the SessionFactory was built through JPA
* bootstrapping; {@code false} indicates it was built through native bootstrapping.
*/
boolean isJpaBootstrap();
boolean isJtaTransactionAccessEnabled();
default boolean isAllowRefreshDetachedEntity() {
return false;
}
/**
* The name to be used for the SessionFactory. This is use both in:
* - in-VM serialization
* - JNDI binding, depending on {@link #isSessionFactoryNameAlsoJndiName}
*
*
* @return The SessionFactory name
*/
String getSessionFactoryName();
/**
* Is the {@link #getSessionFactoryName SesssionFactory name} also a JNDI name, indicating we
* should bind it into JNDI?
*
* @return {@code true} if the SessionFactory name is also a JNDI name; {@code false} otherwise.
*/
boolean isSessionFactoryNameAlsoJndiName();
boolean isFlushBeforeCompletionEnabled();
boolean isAutoCloseSessionEnabled();
boolean isStatisticsEnabled();
/**
* Get the interceptor to use by default for all sessions opened from this factory.
*
* @return The interceptor to use factory wide. May be {@code null}
*/
Interceptor getInterceptor();
/**
* Get the interceptor to use by default for all sessions opened from this factory.
*
* @return The interceptor to use factory wide. May be {@code null}
* @deprecated use {@link #getStatelessInterceptorImplementorSupplier()} instead.
*/
@Deprecated
Class getStatelessInterceptorImplementor();
/**
* Get the interceptor to use by default for all sessions opened from this factory.
*
* @return The interceptor to use factory wide. May be {@code null}
*/
default Supplier getStatelessInterceptorImplementorSupplier() {
return () -> {
try {
return getStatelessInterceptorImplementor().newInstance();
}
catch (InstantiationException | IllegalAccessException e) {
throw new HibernateException( "Could not supply session-scoped SessionFactory Interceptor", e );
}
};
}
StatementInspector getStatementInspector();
SessionFactoryObserver[] getSessionFactoryObservers();
BaselineSessionEventsListenerBuilder getBaselineSessionEventsListenerBuilder();
boolean isIdentifierRollbackEnabled();
boolean isCheckNullability();
boolean isInitializeLazyStateOutsideTransactionsEnabled();
IdTableStrategy getIdTableStrategy();
TempTableDdlTransactionHandling getTempTableDdlTransactionHandling();
BatchFetchStyle getBatchFetchStyle();
boolean isDelayBatchFetchLoaderCreationsEnabled();
int getDefaultBatchFetchSize();
Integer getMaximumFetchDepth();
NullPrecedence getDefaultNullPrecedence();
boolean isOrderUpdatesEnabled();
boolean isOrderInsertsEnabled();
MultiTenancyStrategy getMultiTenancyStrategy();
CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver();
boolean isJtaTrackByThread();
Map getQuerySubstitutions();
/**
* @deprecated Use {@link JpaCompliance#isJpaQueryComplianceEnabled()} instead
* via {@link #getJpaCompliance()}
*/
@Deprecated
default boolean isStrictJpaQueryLanguageCompliance() {
return getJpaCompliance().isJpaQueryComplianceEnabled();
}
boolean isNamedQueryStartupCheckingEnabled();
boolean isConventionalJavaConstants();
boolean isSecondLevelCacheEnabled();
boolean isQueryCacheEnabled();
TimestampsCacheFactory getTimestampsCacheFactory();
String getCacheRegionPrefix();
boolean isMinimalPutsEnabled();
boolean isStructuredCacheEntriesEnabled();
boolean isDirectReferenceCacheEntriesEnabled();
boolean isAutoEvictCollectionCache();
SchemaAutoTooling getSchemaAutoTooling();
int getJdbcBatchSize();
boolean isJdbcBatchVersionedData();
boolean isScrollableResultSetsEnabled();
boolean isWrapResultSetsEnabled();
boolean isGetGeneratedKeysEnabled();
Integer getJdbcFetchSize();
PhysicalConnectionHandlingMode getPhysicalConnectionHandlingMode();
default boolean doesConnectionProviderDisableAutoCommit() {
return false;
}
/**
* @deprecated Use {@link #getPhysicalConnectionHandlingMode()} instead
*/
@Deprecated
ConnectionReleaseMode getConnectionReleaseMode();
boolean isCommentsEnabled();
CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy();
EntityNameResolver[] getEntityNameResolvers();
/**
* Get the delegate for handling entity-not-found exception conditions.
*
* @return The specific EntityNotFoundDelegate to use, May be {@code null}
*/
EntityNotFoundDelegate getEntityNotFoundDelegate();
SqmFunctionRegistry getSqmFunctionRegistry();
void setCheckNullability(boolean enabled);
/**
* For transaction management in JTA, should we prefer to use
* {@link javax.transaction.UserTransaction} as opposed to
* {@link javax.transaction.Transaction}?
*
* @return {@code true} indicates we should prefer to use
* {@link javax.transaction.UserTransaction}; {@code false} indicates we
* should prefer {@link javax.transaction.Transaction}.
*
* @see org.hibernate.cfg.AvailableSettings#PREFER_USER_TRANSACTION
*/
boolean isPreferUserTransaction();
/**
* For parameters defined as part of {@link org.hibernate.procedure.ProcedureCall}
* or {@link javax.persistence.StoredProcedureQuery} how should we treat {@code null}
* bindings?
*
*/
boolean isProcedureParameterNullPassingEnabled();
boolean isCollectionJoinSubqueryRewriteEnabled();
boolean isAllowOutOfTransactionUpdateOperations();
boolean isReleaseResourcesOnCloseEnabled();
TimeZone getJdbcTimeZone();
/**
* See {@link org.hibernate.cfg.AvailableSettings#NATIVE_QUERY_ORDINAL_PARAMETER_BASE} and
* {@link org.hibernate.boot.SessionFactoryBuilder#applyNonJpaNativeQueryOrdinalParameterBase(Integer)} for details.
*
* @return The base integer for ordinal parameters
*
* @since 6.0
*/
Integer getNonJpaNativeQueryOrdinalParameterBase();
/**
* Controls whether Hibernate should try to map named parameter names
* specified in a {@link org.hibernate.procedure.ProcedureCall} or
* {@link javax.persistence.StoredProcedureQuery} to named parameters in
* the JDBC {@link java.sql.CallableStatement}.
*
* As JPA is defined, the use of named parameters is essentially of dubious
* value since by spec the parameters have to be defined in the order they are
* defined in the procedure/function declaration - we can always bind them
* positionally. The whole idea of named parameters for CallableStatement
* is the ability to bind these in any order, but since we unequivocally
* know the order anyway binding them via name really gains nothing.
*
* If this is {@code true}, we still need to make sure the Dialect supports
* named binding. Setting this to {@code false} simply circumvents that
* check and always performs positional binding.
*
* @return {@code true} indicates we should try to use {@link java.sql.CallableStatement}
* named parameters, if the Dialect says it is supported; {@code false}
* indicates that we should never try to use {@link java.sql.CallableStatement}
* named parameters, regardless of what the Dialect says.
*
* @see org.hibernate.cfg.AvailableSettings#CALLABLE_NAMED_PARAMS_ENABLED
*/
boolean isUseOfJdbcNamedParametersEnabled();
QueryLiteralRendering getQueryLiteralRendering();
default boolean isQueryParametersValidationEnabled(){
return isJpaBootstrap();
}
/**
* @deprecated since 6.0, Use {@link #getQueryLiteralRendering()} instead.
*/
@Deprecated
default LiteralHandlingMode getCriteriaLiteralHandlingMode() {
return LiteralHandlingMode.AUTO;
}
boolean jdbcStyleParamsZeroBased();
JpaCompliance getJpaCompliance();
boolean isFailOnPaginationOverCollectionFetchEnabled();
default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() {
return ImmutableEntityUpdateQueryHandlingMode.WARNING;
}
default boolean inClauseParameterPaddingEnabled() {
return false;
}
default BytecodeProvider getBytecodeProvider() {
/// todo (7.0) : scope the BytecodeProvider per-SF as opposed to static
return Environment.getBytecodeProvider();
}
default boolean nativeExceptionHandling51Compliance() {
return false;
}
default int getQueryStatisticsMaxSize() {
return Statistics.DEFAULT_QUERY_STATISTICS_MAX_SIZE;
}
default boolean isPostInsertIdentifierDelayableEnabled() {
return true;
}
}