public Class LocalContainerEntityManagerFactoryBean

Overrides org.springframework.orm.jpa.AbstractEntityManagerFactoryBean.afterPropertiesSet.

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

Overrides org.springframework.orm.jpa.AbstractEntityManagerFactoryBean.getDataSource.

Implements org.springframework.orm.jpa.EntityManagerFactoryInfo.getDataSource.

Doc from org.springframework.orm.jpa.EntityManagerFactoryInfo.getDataSource.

Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.

Returns:DataSource

the JDBC DataSource, or null if not known

Annotations

@Override

Overrides org.springframework.orm.jpa.AbstractEntityManagerFactoryBean.getPersistenceUnitInfo.

Implements org.springframework.orm.jpa.EntityManagerFactoryInfo.getPersistenceUnitInfo.

Doc from org.springframework.orm.jpa.EntityManagerFactoryInfo.getPersistenceUnitInfo.

Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.

Returns:PersistenceUnitInfo

the PersistenceUnitInfo used to create this EntityManagerFactory, or null if the in-container contract was not used to configure the EntityManagerFactory

Annotations

@Override

@Nullable

Overrides org.springframework.orm.jpa.AbstractEntityManagerFactoryBean.getPersistenceUnitName.

Implements org.springframework.orm.jpa.EntityManagerFactoryInfo.getPersistenceUnitName.

Doc from org.springframework.orm.jpa.EntityManagerFactoryInfo.getPersistenceUnitName.

Return the name of the persistence unit used to create this EntityManagerFactory, or null if it is an unnamed default.

If getPersistenceUnitInfo() returns non-null, the result of getPersistenceUnitName() must be equal to the value returned by PersistenceUnitInfo.getPersistenceUnitName().

Annotations

@Override

@Nullable

Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database. This is an alternative to keeping the JDBC configuration in persistence.xml, passing in a Spring-managed DataSource instead.

In JPA speak, a DataSource passed in here will be used as "nonJtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, as well as overriding data source configuration in persistence.xml (if any). Note that this variant typically works for JTA transaction management as well; if it does not, consider using the explicit setJtaDataSource instead.

See Also

jakarta.persistence.spi.PersistenceUnitInfo#getNonJtaDataSource(), setPersistenceUnitManager

Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database. This is an alternative to keeping the JDBC configuration in persistence.xml, passing in a Spring-managed DataSource instead.

In JPA speak, a DataSource passed in here will be used as "jtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, as well as overriding data source configuration in persistence.xml (if any).

See Also

jakarta.persistence.spi.PersistenceUnitInfo#getJtaDataSource(), setPersistenceUnitManager

Implements org.springframework.context.weaving.LoadTimeWeaverAware.setLoadTimeWeaver.

Specify the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.

It is a not required to specify a LoadTimeWeaver: Most providers will be able to provide a subset of their functionality without class instrumentation as well, or operate with their VM agent specified on JVM startup.

In terms of Spring-provided weaving options, the most important ones are InstrumentationLoadTimeWeaver, which requires a Spring-specific (but very general) VM agent specified on JVM startup, and ReflectiveLoadTimeWeaver, which interacts with an underlying ClassLoader based on specific extended methods being available on it.

Parameters

loadTimeWeaver:LoadTimeWeaver

Doc from org.springframework.context.weaving.LoadTimeWeaverAware.setLoadTimeWeaver.

the LoadTimeWeaver instance (never null)

Annotations

@Override

See Also

org.springframework.instrument.classloading.InstrumentationLoadTimeWeaver, org.springframework.instrument.classloading.ReflectiveLoadTimeWeaver

Set the ManagedClassNameFilter to apply on entity classes discovered using classpath scanning.

Parameters

managedClassNameFilter:ManagedClassNameFilter

a predicate to filter entity classes

Since

6.1.4

See Also

DefaultPersistenceUnitManager#setManagedClassNameFilter

Set the PersistenceManagedTypes to use to build the list of managed types as an alternative to entity scanning.

Parameters

managedTypes:PersistenceManagedTypes

the managed types

Since

6.0

See Also

DefaultPersistenceUnitManager#setManagedTypes(PersistenceManagedTypes)

Specify one or more mapping resources (equivalent to <mapping-file> entries in persistence.xml) for the default persistence unit. Can be used on its own or in combination with entity scanning in the classpath, in both cases avoiding persistence.xml.

Note that mapping resources must be relative to the classpath root, e.g. "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", so that they can be loaded through ClassLoader.getResource.

If no explicit mapping resources have been specified next to packages to scan, Spring's setup looks for a default META-INF/orm.xml file in the classpath, registering it as a mapping resource for the default unit if the mapping file is not co-located with a persistence.xml file (in which case we assume it is only meant to be used with the persistence units defined there, like in standard JPA).

Note that specifying an empty array/list here suppresses the default META-INF/orm.xml check. On the other hand, explicitly specifying META-INF/orm.xml here will register that file even if it happens to be co-located with a persistence.xml file.

See Also

setPersistenceUnitManager, DefaultPersistenceUnitManager#setMappingResources

Set whether to use Spring-based scanning for entity classes in the classpath instead of using JPA's standard scanning of jar files with persistence.xml markers in them. In case of Spring-based scanning, no persistence.xml is necessary; all you need to do is to specify base packages to search here.

Default is none. Specify packages to search for autodetection of your entity classes in the classpath. This is analogous to Spring's component-scan feature (org.springframework.context.annotation.ClassPathBeanDefinitionScanner).

Consider setting a PersistenceManagedTypes instead that allows the scanning logic to be optimized by AOT processing.

Set the PersistenceUnitManager to use for obtaining the JPA persistence unit that this FactoryBean is supposed to build an EntityManagerFactory for.

The default is to rely on the local settings specified on this FactoryBean, such as "persistenceXmlLocation", "dataSource" and "loadTimeWeaver".

For reuse of existing persistence unit configuration or more advanced forms of custom persistence unit handling, consider defining a separate PersistenceUnitManager bean (typically a DefaultPersistenceUnitManager instance) and linking it in here. persistence.xml location, DataSource configuration and LoadTimeWeaver will be defined on that separate DefaultPersistenceUnitManager bean in such a scenario.

See Also

setPersistenceXmlLocation, setDataSource, setLoadTimeWeaver, org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager

Overrides org.springframework.orm.jpa.AbstractEntityManagerFactoryBean.setPersistenceUnitName.

Uses the specified persistence unit name as the name of the default persistence unit, if applicable.

Annotations

@Override

See Also

DefaultPersistenceUnitManager#setDefaultPersistenceUnitName

Set the PersistenceUnitPostProcessors to be applied to the PersistenceUnitInfo used for creating this EntityManagerFactory.

Such post-processors can, for example, register further entity classes and jar files, in addition to the metadata read from persistence.xml.

See Also

setPersistenceUnitManager

Set a persistence unit root location for the default persistence unit.

Default is "classpath:", that is, the root of the current classpath (nearest root directory). To be overridden if unit-specific resolution does not work and the classpath root is not appropriate either.

Since

4.3.3

See Also

DefaultPersistenceUnitManager#setDefaultPersistenceUnitRootLocation

Set the location of the persistence.xml file we want to use. This is a Spring resource location.

Default is "classpath:META-INF/persistence.xml".

Parameters

persistenceXmlLocation:String

a Spring resource String identifying the location of the persistence.xml file that this LocalContainerEntityManagerFactoryBean should parse

See Also

setPersistenceUnitManager

Implements org.springframework.context.ResourceLoaderAware.setResourceLoader.

Doc from org.springframework.context.ResourceLoaderAware.setResourceLoader.

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Parameters

resourceLoader:ResourceLoader

the ResourceLoader object to be used by this object

Annotations

@Override

Specify the JPA 2.0 shared cache mode for this persistence unit, overriding a value in persistence.xml if set.

Since

4.0

See Also

jakarta.persistence.spi.PersistenceUnitInfo#getSharedCacheMode(), setPersistenceUnitManager

Specify the JPA 2.0 validation mode for this persistence unit, overriding a value in persistence.xml if set.

Since

4.0

See Also

jakarta.persistence.spi.PersistenceUnitInfo#getValidationMode(), setPersistenceUnitManager