Constructor Detail

• LocalSessionFactoryBuilder

  public LocalSessionFactoryBuilder(@Nullable
                                    javax.sql.DataSource dataSource)

  Create a new LocalSessionFactoryBuilder for the given DataSource.

  Parameters:

  dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

• LocalSessionFactoryBuilder

  public LocalSessionFactoryBuilder(@Nullable
                                    javax.sql.DataSource dataSource,
                                    java.lang.ClassLoader classLoader)

  Create a new LocalSessionFactoryBuilder for the given DataSource.

  Parameters:

  dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

  classLoader - the ClassLoader to load application classes from

• LocalSessionFactoryBuilder

  public LocalSessionFactoryBuilder(@Nullable
                                    javax.sql.DataSource dataSource,
                                    ResourceLoader resourceLoader)

  Create a new LocalSessionFactoryBuilder for the given DataSource.

  Parameters:

  dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

  resourceLoader - the ResourceLoader to load application classes from

• LocalSessionFactoryBuilder

  public LocalSessionFactoryBuilder(@Nullable
                                    javax.sql.DataSource dataSource,
                                    ResourceLoader resourceLoader,
                                    org.hibernate.boot.MetadataSources metadataSources)

  Create a new LocalSessionFactoryBuilder for the given DataSource.

  Parameters:

  dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)

  resourceLoader - the ResourceLoader to load application classes from

  metadataSources - the Hibernate MetadataSources service to use (e.g. reusing an existing one)

  Since:

  4.3

Method Detail

• setJtaTransactionManager

  public LocalSessionFactoryBuilder setJtaTransactionManager(java.lang.Object jtaTransactionManager)

  Set the Spring JtaTransactionManager or the JTA TransactionManager to be used with Hibernate, if any. Allows for using a Spring-managed transaction manager for Hibernate 5's session and cache synchronization, with the "hibernate.transaction.jta.platform" automatically set to it.

  A passed-in Spring JtaTransactionManager needs to contain a JTA TransactionManager reference to be usable here, except for the WebSphere case where we'll automatically set WebSphereExtendedJtaPlatform accordingly.

  Note: If this is set, the Hibernate settings should not contain a JTA platform setting to avoid meaningless double configuration.

• setBeanContainer

  public LocalSessionFactoryBuilder setBeanContainer(ConfigurableListableBeanFactory beanFactory)

  Set a Hibernate BeanContainer for the given Spring ConfigurableListableBeanFactory.

  Note: Bean container integration requires Hibernate 5.3 or higher. It enables autowiring of Hibernate attribute converters and entity listeners.

  Since:

  5.1

  See Also:

  SpringBeanContainer, AvailableSettings.BEAN_CONTAINER

• setCacheRegionFactory

  public LocalSessionFactoryBuilder setCacheRegionFactory(RegionFactory cacheRegionFactory)

  Set the Hibernate RegionFactory to use for the SessionFactory. Allows for using a Spring-managed RegionFactory instance.

  Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.

  Since:

  5.1

  See Also:

  AvailableSettings.CACHE_REGION_FACTORY

• setMultiTenantConnectionProvider

  public LocalSessionFactoryBuilder setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider)

  Set a MultiTenantConnectionProvider to be passed on to the SessionFactory.

  Since:

  4.3

  See Also:

  AvailableSettings.MULTI_TENANT_CONNECTION_PROVIDER

• setCurrentTenantIdentifierResolver

  public void setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)

  Overridden to reliably pass a CurrentTenantIdentifierResolver to the SessionFactory.

  Overrides:

  setCurrentTenantIdentifierResolver in class Configuration

  Since:

  4.3.2

  See Also:

  AvailableSettings.MULTI_TENANT_IDENTIFIER_RESOLVER

• setEntityTypeFilters

  public LocalSessionFactoryBuilder setEntityTypeFilters(TypeFilter... entityTypeFilters)

  Specify custom type filters for Spring-based scanning for entity classes.

  Default is to search all specified packages for classes annotated with @javax.persistence.Entity, @javax.persistence.Embeddable or @javax.persistence.MappedSuperclass.

  See Also:

  scanPackages(java.lang.String...)

• addAnnotatedClasses

  public LocalSessionFactoryBuilder addAnnotatedClasses(java.lang.Class<?>... annotatedClasses)

  Add the given annotated classes in a batch.

  See Also:

  Configuration.addAnnotatedClass(java.lang.Class), scanPackages(java.lang.String...)

• addPackages

  public LocalSessionFactoryBuilder addPackages(java.lang.String... annotatedPackages)

  Add the given annotated packages in a batch.

  See Also:

  Configuration.addPackage(java.lang.String), scanPackages(java.lang.String...)

• scanPackages

  public LocalSessionFactoryBuilder scanPackages(java.lang.String... packagesToScan)
                                          throws HibernateException

  Perform Spring-based scanning for entity classes, registering them as annotated classes with this Configuration.

  Parameters:

  packagesToScan - one or more Java package names

  Throws:

  HibernateException - if scanning fails for any reason

• buildSessionFactory

  public SessionFactory buildSessionFactory(AsyncTaskExecutor bootstrapExecutor)

  Build the Hibernate SessionFactory through background bootstrapping, using the given executor for a parallel initialization phase (e.g. a SimpleAsyncTaskExecutor).

  SessionFactory initialization will then switch into background bootstrap mode, with a SessionFactory proxy immediately returned for injection purposes instead of waiting for Hibernate's bootstrapping to complete. However, note that the first actual call to a SessionFactory method will then block until Hibernate's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid early SessionFactory calls in init methods of related beans, even for metadata introspection purposes.

  Since:

  4.3

  See Also:

  Configuration.buildSessionFactory()