Spring Object/Relational Mapping 6.1.4 · org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager

Modifier and Type	Field and Description
private DataSourceLookup	dataSourceLookup
private static final String	DEFAULT_ORM_XML_RESOURCE
public static final String	DEFAULT_PERSISTENCE_XML_LOCATION Default location of the `persistence.xml` file: "classpath*:META-INF/persistence.xml".
private DataSource	defaultDataSource
private DataSource	defaultJtaDataSource
private String	defaultPersistenceUnitName
private String	defaultPersistenceUnitRootLocation
private LoadTimeWeaver	loadTimeWeaver
protected final Log	logger
private ManagedClassNameFilter	managedClassNameFilter
private PersistenceManagedTypes	managedTypes
private String[]	mappingResources
public static final String	ORIGINAL_DEFAULT_PERSISTENCE_UNIT_NAME Default persistence unit name.
public static final String	ORIGINAL_DEFAULT_PERSISTENCE_UNIT_ROOT_LOCATION Default location for the persistence unit root URL: "classpath:", indicating the root of the classpath.
private String[]	packagesToScan
private static final String	PERSISTENCE_XML_FILENAME
private final Set<String>	persistenceUnitInfoNames
private final Map<String, PersistenceUnitInfo>	persistenceUnitInfos
private PersistenceUnitPostProcessor[]	persistenceUnitPostProcessors
private String[]	persistenceXmlLocations
private ResourcePatternResolver	resourcePatternResolver
private SharedCacheMode	sharedCacheMode
private ValidationMode	validationMode

Access	Constructor and Description
public	DefaultPersistenceUnitManager()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements 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.
private void	applyManagedTypes(SpringPersistenceUnitInfo scannedUnit, PersistenceManagedTypes managedTypes)
private SpringPersistenceUnitInfo	buildDefaultPersistenceUnitInfo() Perform Spring-based scanning for entity classes.
private URL	Returns: the persistence unit root URL to pass to the JPA PersistenceProvider determineDefaultPersistenceUnitRootUrl() Try to determine the persistence unit root URL based on the given "defaultPersistenceUnitRootLocation".
public DataSourceLookup	getDataSourceLookup() Return the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in `persistence.xml` against Spring-managed DataSource instances.
public DataSource	getDefaultDataSource() Return the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`.
public DataSource	getDefaultJtaDataSource() Return the JTA-aware DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`.
public LoadTimeWeaver	getLoadTimeWeaver() Return the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.
private Resource	getOrmXmlForDefaultPersistenceUnit() Determine JPA's default "META-INF/orm.xml" resource for use with Spring's default persistence unit, if any.
protected final MutablePersistenceUnitInfo	Returns: the PersistenceUnitInfo in mutable form, or `null` if not available getPersistenceUnitInfo(String the name of the desired persistence unit persistenceUnitName) Return the specified PersistenceUnitInfo from this manager's cache of processed persistence units, keeping it in the cache (i.e. not 'obtaining' it for use but rather just accessing it for post-processing).
public PersistenceUnitPostProcessor[]	getPersistenceUnitPostProcessors() Return the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.
protected boolean	isPersistenceUnitOverrideAllowed() Return whether an override of a same-named persistence unit is allowed.
public PersistenceUnitInfo	obtainDefaultPersistenceUnitInfo() Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainDefaultPersistenceUnitInfo. Obtain the default PersistenceUnitInfo from this manager.
public PersistenceUnitInfo	obtainPersistenceUnitInfo(String the name of the desired persistence unit persistenceUnitName) Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainPersistenceUnitInfo. Obtain the specified PersistenceUnitInfo from this manager.
protected void	postProcessPersistenceUnitInfo(MutablePersistenceUnitInfo the chosen PersistenceUnitInfo, as read from `persistence.xml`. Passed in as MutablePersistenceUnitInfo. pui) Hook method allowing subclasses to customize each PersistenceUnitInfo.
public void	preparePersistenceUnitInfos() Prepare the PersistenceUnitInfos according to the configuration of this manager: scanning for `persistence.xml` files, parsing all matching files, configuring and post-processing them.
private List<SpringPersistenceUnitInfo>	readPersistenceUnitInfos() Read all persistence unit infos from `persistence.xml`, as defined in the JPA specification.
public void	setDataSourceLookup(DataSourceLookup dataSourceLookup) Specify the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in `persistence.xml` against Spring-managed DataSource instances.
public void	setDataSources(Map<String, DataSource> dataSources) Specify the JDBC DataSources that the JPA persistence provider is supposed to use for accessing the database, resolving data source names in `persistence.xml` against Spring-managed DataSources.
public void	setDefaultDataSource(DataSource defaultDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`.
public void	setDefaultJtaDataSource(DataSource defaultJtaDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`.
public void	setDefaultPersistenceUnitName(String defaultPersistenceUnitName) Specify the name of the default persistence unit, if any.
public void	setDefaultPersistenceUnitRootLocation(String defaultPersistenceUnitRootLocation) Set the default persistence unit root location, to be applied if no unit-specific persistence unit root could be determined.
public void	setLoadTimeWeaver(LoadTimeWeaver the `LoadTimeWeaver` instance (never `null`) loadTimeWeaver) Implements org.springframework.context.weaving.LoadTimeWeaverAware.setLoadTimeWeaver. Specify the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.
public void	setManagedClassNameFilter(ManagedClassNameFilter a predicate to filter entity classes managedClassNameFilter) Set the `ManagedClassNameFilter` to apply on entity classes discovered using classpath scanning.
public void	setManagedTypes(PersistenceManagedTypes the managed types managedTypes) Set the `PersistenceManagedTypes` to use to build the list of managed types as an alternative to entity scanning.
public void	setMappingResources(String... mappingResources) Specify one or more mapping resources (equivalent to `<mapping-file>` entries in `persistence.xml`) for the default persistence unit.
public void	setPackagesToScan(String... packagesToScan) 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.
public void	setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor... postProcessors) Set the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.
public void	setPersistenceXmlLocation(String persistenceXmlLocation) Specify the location of the `persistence.xml` files to load.
public void	setPersistenceXmlLocations(String... an array of Spring resource Strings identifying the location of the `persistence.xml` files to read persistenceXmlLocations) Specify multiple locations of `persistence.xml` files to load.
public void	setResourceLoader(ResourceLoader the ResourceLoader object to be used by this object resourceLoader) Implements 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`.
public void	setSharedCacheMode(SharedCacheMode sharedCacheMode) Specify the JPA 2.0 shared cache mode for all of this manager's persistence units, overriding any value in `persistence.xml` if set.
public void	setValidationMode(ValidationMode validationMode) Specify the JPA 2.0 validation mode for all of this manager's persistence units, overriding any value in `persistence.xml` if set.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dataSourceLookup	back to summary
private DataSourceLookup dataSourceLookup

DEFAULT_ORM_XML_RESOURCE	back to summary
private static final String DEFAULT_ORM_XML_RESOURCE

DEFAULT_PERSISTENCE_XML_LOCATION	back to summary
public static final String DEFAULT_PERSISTENCE_XML_LOCATION Default location of the `persistence.xml` file: "classpath*:META-INF/persistence.xml".

defaultDataSource	back to summary
private DataSource defaultDataSource Annotations @Nullable

defaultJtaDataSource	back to summary
private DataSource defaultJtaDataSource Annotations @Nullable

defaultPersistenceUnitName	back to summary
private String defaultPersistenceUnitName Annotations @Nullable

defaultPersistenceUnitRootLocation	back to summary
private String defaultPersistenceUnitRootLocation Annotations @Nullable

loadTimeWeaver	back to summary
private LoadTimeWeaver loadTimeWeaver Annotations @Nullable

logger	back to summary
protected final Log logger

managedClassNameFilter	back to summary
private ManagedClassNameFilter managedClassNameFilter Annotations @Nullable

managedTypes	back to summary
private PersistenceManagedTypes managedTypes Annotations @Nullable

mappingResources	back to summary
private String[] mappingResources Annotations @Nullable

ORIGINAL_DEFAULT_PERSISTENCE_UNIT_NAME	back to summary
public static final String ORIGINAL_DEFAULT_PERSISTENCE_UNIT_NAME Default persistence unit name.

ORIGINAL_DEFAULT_PERSISTENCE_UNIT_ROOT_LOCATION	back to summary
public static final String ORIGINAL_DEFAULT_PERSISTENCE_UNIT_ROOT_LOCATION Default location for the persistence unit root URL: "classpath:", indicating the root of the classpath.

packagesToScan	back to summary
private String[] packagesToScan Annotations @Nullable

PERSISTENCE_XML_FILENAME	back to summary
private static final String PERSISTENCE_XML_FILENAME

persistenceUnitInfoNames	back to summary
private final Set<String> persistenceUnitInfoNames

persistenceUnitInfos	back to summary
private final Map<String, PersistenceUnitInfo> persistenceUnitInfos

persistenceUnitPostProcessors	back to summary
private PersistenceUnitPostProcessor[] persistenceUnitPostProcessors Annotations @Nullable

persistenceXmlLocations	back to summary
private String[] persistenceXmlLocations

resourcePatternResolver	back to summary
private ResourcePatternResolver resourcePatternResolver

sharedCacheMode	back to summary
private SharedCacheMode sharedCacheMode Annotations @Nullable

validationMode	back to summary
private ValidationMode validationMode Annotations @Nullable

DefaultPersistenceUnitManager	back to summary
public DefaultPersistenceUnitManager()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void 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

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

applyManagedTypes	back to summary
private void applyManagedTypes(SpringPersistenceUnitInfo scannedUnit, PersistenceManagedTypes managedTypes)

buildDefaultPersistenceUnitInfo back to summary

buildDefaultPersistenceUnitInfo	back to summary
private SpringPersistenceUnitInfo buildDefaultPersistenceUnitInfo() Perform Spring-based scanning for entity classes. See Also `setPackagesToScan`

private SpringPersistenceUnitInfo buildDefaultPersistenceUnitInfo()

Perform Spring-based scanning for entity classes.

See Also: setPackagesToScan

determineDefaultPersistenceUnitRootUrl back to summary

determineDefaultPersistenceUnitRootUrl	back to summary
private URL determineDefaultPersistenceUnitRootUrl() Try to determine the persistence unit root URL based on the given "defaultPersistenceUnitRootLocation". Returns:URL the persistence unit root URL to pass to the JPA PersistenceProvider Annotations @Nullable See Also `setDefaultPersistenceUnitRootLocation`

private URL determineDefaultPersistenceUnitRootUrl()

Try to determine the persistence unit root URL based on the given "defaultPersistenceUnitRootLocation".

Returns:URL

the persistence unit root URL to pass to the JPA PersistenceProvider

Annotations

@Nullable

See Also

setDefaultPersistenceUnitRootLocation

getDataSourceLookup back to summary

getDataSourceLookup	back to summary
public DataSourceLookup getDataSourceLookup() Return the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in `persistence.xml` against Spring-managed DataSource instances. Annotations @Nullable

public DataSourceLookup getDataSourceLookup()

Return the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in persistence.xml against Spring-managed DataSource instances.

Annotations

@Nullable

getDefaultDataSource back to summary

getDefaultDataSource	back to summary
public DataSource getDefaultDataSource() Return the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`. Annotations @Nullable

public DataSource getDefaultDataSource()

Return the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in persistence.xml.

Annotations

@Nullable

getDefaultJtaDataSource back to summary

getDefaultJtaDataSource	back to summary
public DataSource getDefaultJtaDataSource() Return the JTA-aware DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`. Annotations @Nullable

public DataSource getDefaultJtaDataSource()

Return the JTA-aware DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in persistence.xml.

Annotations

@Nullable

getLoadTimeWeaver	back to summary
public LoadTimeWeaver getLoadTimeWeaver() Return the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract. Annotations @Nullable

getLoadTimeWeaver

back to summary

public LoadTimeWeaver getLoadTimeWeaver()

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

Annotations

@Nullable

getOrmXmlForDefaultPersistenceUnit	back to summary
private Resource getOrmXmlForDefaultPersistenceUnit() Determine JPA's default "META-INF/orm.xml" resource for use with Spring's default persistence unit, if any. Checks whether a "META-INF/orm.xml" file exists in the classpath and uses it if it is not co-located with a "META-INF/persistence.xml" file. Annotations @Nullable

getOrmXmlForDefaultPersistenceUnit

back to summary

private Resource getOrmXmlForDefaultPersistenceUnit()

Determine JPA's default "META-INF/orm.xml" resource for use with Spring's default persistence unit, if any.

Checks whether a "META-INF/orm.xml" file exists in the classpath and uses it if it is not co-located with a "META-INF/persistence.xml" file.

Annotations

@Nullable

getPersistenceUnitInfo back to summary

getPersistenceUnitInfo	back to summary
protected final MutablePersistenceUnitInfo getPersistenceUnitInfo(String persistenceUnitName) Return the specified PersistenceUnitInfo from this manager's cache of processed persistence units, keeping it in the cache (i.e. not 'obtaining' it for use but rather just accessing it for post-processing). This can be used in `postProcessPersistenceUnitInfo` implementations, detecting existing persistence units of the same name and potentially merging them. Parameters persistenceUnitName:String the name of the desired persistence unit Returns:MutablePersistenceUnitInfo the PersistenceUnitInfo in mutable form, or `null` if not available Annotations @Nullable

protected final MutablePersistenceUnitInfo getPersistenceUnitInfo(String persistenceUnitName)

Return the specified PersistenceUnitInfo from this manager's cache of processed persistence units, keeping it in the cache (i.e. not 'obtaining' it for use but rather just accessing it for post-processing).

This can be used in postProcessPersistenceUnitInfo implementations, detecting existing persistence units of the same name and potentially merging them.

Parameters

persistenceUnitName:String: the name of the desired persistence unit

Returns:MutablePersistenceUnitInfo

the PersistenceUnitInfo in mutable form, or null if not available

Annotations

@Nullable

getPersistenceUnitPostProcessors	back to summary
public PersistenceUnitPostProcessor[] getPersistenceUnitPostProcessors() Return the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager. Annotations @Nullable

getPersistenceUnitPostProcessors

back to summary

public PersistenceUnitPostProcessor[] getPersistenceUnitPostProcessors()

Return the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.

Annotations

@Nullable

isPersistenceUnitOverrideAllowed back to summary

isPersistenceUnitOverrideAllowed	back to summary
protected boolean isPersistenceUnitOverrideAllowed() Return whether an override of a same-named persistence unit is allowed. Default is `false`. May be overridden to return `true`, for example if `postProcessPersistenceUnitInfo` is able to handle that case.

protected boolean isPersistenceUnitOverrideAllowed()

Return whether an override of a same-named persistence unit is allowed.

Default is false. May be overridden to return true, for example if postProcessPersistenceUnitInfo is able to handle that case.

obtainDefaultPersistenceUnitInfo back to summary

obtainDefaultPersistenceUnitInfo	back to summary
public PersistenceUnitInfo obtainDefaultPersistenceUnitInfo() Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainDefaultPersistenceUnitInfo. Doc from org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainDefaultPersistenceUnitInfo. Obtain the default PersistenceUnitInfo from this manager. Returns:PersistenceUnitInfo the PersistenceUnitInfo (never `null`) Annotations @Override

public PersistenceUnitInfo obtainDefaultPersistenceUnitInfo()

Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainDefaultPersistenceUnitInfo.

Doc from org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainDefaultPersistenceUnitInfo.

Obtain the default PersistenceUnitInfo from this manager.

Returns:PersistenceUnitInfo

the PersistenceUnitInfo (never null)

Annotations

@Override

obtainPersistenceUnitInfo back to summary

obtainPersistenceUnitInfo	back to summary
public PersistenceUnitInfo obtainPersistenceUnitInfo(String persistenceUnitName) Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainPersistenceUnitInfo. Doc from org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainPersistenceUnitInfo. Obtain the specified PersistenceUnitInfo from this manager. Parameters persistenceUnitName:String the name of the desired persistence unit Returns:PersistenceUnitInfo the PersistenceUnitInfo (never `null`) Annotations @Override

public PersistenceUnitInfo obtainPersistenceUnitInfo(String persistenceUnitName)

Implements org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainPersistenceUnitInfo.

Doc from org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager.obtainPersistenceUnitInfo.

Obtain the specified PersistenceUnitInfo from this manager.

Parameters

persistenceUnitName:String: the name of the desired persistence unit

Returns:PersistenceUnitInfo

the PersistenceUnitInfo (never null)

Annotations

@Override

postProcessPersistenceUnitInfo back to summary

postProcessPersistenceUnitInfo	back to summary
protected void postProcessPersistenceUnitInfo(MutablePersistenceUnitInfo pui) Hook method allowing subclasses to customize each PersistenceUnitInfo. The default implementation delegates to all registered PersistenceUnitPostProcessors. It is usually preferable to register further entity classes, jar files etc there rather than in a subclass of this manager, to be able to reuse the post-processors. Parameters pui:MutablePersistenceUnitInfo the chosen PersistenceUnitInfo, as read from `persistence.xml`. Passed in as MutablePersistenceUnitInfo. See Also `setPersistenceUnitPostProcessors`

protected void postProcessPersistenceUnitInfo(MutablePersistenceUnitInfo pui)

Hook method allowing subclasses to customize each PersistenceUnitInfo.

The default implementation delegates to all registered PersistenceUnitPostProcessors. It is usually preferable to register further entity classes, jar files etc there rather than in a subclass of this manager, to be able to reuse the post-processors.

Parameters

pui:MutablePersistenceUnitInfo: the chosen PersistenceUnitInfo, as read from persistence.xml. Passed in as MutablePersistenceUnitInfo.

See Also

setPersistenceUnitPostProcessors

preparePersistenceUnitInfos back to summary

preparePersistenceUnitInfos	back to summary
public void preparePersistenceUnitInfos() Prepare the PersistenceUnitInfos according to the configuration of this manager: scanning for `persistence.xml` files, parsing all matching files, configuring and post-processing them. PersistenceUnitInfos cannot be obtained before this preparation method has been invoked. See Also `obtainDefaultPersistenceUnitInfo()`, `obtainPersistenceUnitInfo(String)`

public void preparePersistenceUnitInfos()

Prepare the PersistenceUnitInfos according to the configuration of this manager: scanning for persistence.xml files, parsing all matching files, configuring and post-processing them.

PersistenceUnitInfos cannot be obtained before this preparation method has been invoked.

See Also: obtainDefaultPersistenceUnitInfo(), obtainPersistenceUnitInfo(String)

readPersistenceUnitInfos	back to summary
private List<SpringPersistenceUnitInfo> readPersistenceUnitInfos() Read all persistence unit infos from `persistence.xml`, as defined in the JPA specification.

setDataSourceLookup back to summary

setDataSourceLookup	back to summary
public void setDataSourceLookup(DataSourceLookup dataSourceLookup) Specify the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in `persistence.xml` against Spring-managed DataSource instances. Default is JndiDataSourceLookup, which resolves DataSource names as JNDI names (as defined by standard JPA). Specify a BeanFactoryDataSourceLookup instance if you want DataSource names to be resolved against Spring bean names. Alternatively, consider passing in a map from names to DataSource instances via the "dataSources" property. If the `persistence.xml` file does not define DataSource names at all, specify a default DataSource via the "defaultDataSource" property. See Also `org.springframework.jdbc.datasource.lookup.JndiDataSourceLookup`, `org.springframework.jdbc.datasource.lookup.BeanFactoryDataSourceLookup`, `setDataSources`, `setDefaultDataSource`

public void setDataSourceLookup(DataSourceLookup dataSourceLookup)

Specify the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names in persistence.xml against Spring-managed DataSource instances.

Default is JndiDataSourceLookup, which resolves DataSource names as JNDI names (as defined by standard JPA). Specify a BeanFactoryDataSourceLookup instance if you want DataSource names to be resolved against Spring bean names.

Alternatively, consider passing in a map from names to DataSource instances via the "dataSources" property. If the persistence.xml file does not define DataSource names at all, specify a default DataSource via the "defaultDataSource" property.

See Also: org.springframework.jdbc.datasource.lookup.JndiDataSourceLookup, org.springframework.jdbc.datasource.lookup.BeanFactoryDataSourceLookup, setDataSources, setDefaultDataSource

setDataSources back to summary

setDataSources	back to summary
public void setDataSources(Map<String, DataSource> dataSources) Specify the JDBC DataSources that the JPA persistence provider is supposed to use for accessing the database, resolving data source names in `persistence.xml` against Spring-managed DataSources. The specified Map needs to define data source names for specific DataSource objects, matching the data source names used in `persistence.xml`. If not specified, data source names will be resolved as JNDI names instead (as defined by standard JPA). See Also `org.springframework.jdbc.datasource.lookup.MapDataSourceLookup`

public void setDataSources(Map<String, DataSource> dataSources)

Specify the JDBC DataSources that the JPA persistence provider is supposed to use for accessing the database, resolving data source names in persistence.xml against Spring-managed DataSources.

The specified Map needs to define data source names for specific DataSource objects, matching the data source names used in persistence.xml. If not specified, data source names will be resolved as JNDI names instead (as defined by standard JPA).

See Also: org.springframework.jdbc.datasource.lookup.MapDataSourceLookup

setDefaultDataSource back to summary

setDefaultDataSource	back to summary
public void setDefaultDataSource(DataSource defaultDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`. This variant indicates no special transaction setup, i.e. typical resource-local. In JPA speak, a DataSource passed in here will be uses as "nonJtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, provided that none has been registered before. See Also `jakarta.persistence.spi.PersistenceUnitInfo#getNonJtaDataSource()`

public void setDefaultDataSource(DataSource defaultDataSource)

Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in persistence.xml. This variant indicates no special transaction setup, i.e. typical resource-local.

In JPA speak, a DataSource passed in here will be uses as "nonJtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, provided that none has been registered before.

See Also: jakarta.persistence.spi.PersistenceUnitInfo#getNonJtaDataSource()

setDefaultJtaDataSource back to summary

setDefaultJtaDataSource	back to summary
public void setDefaultJtaDataSource(DataSource defaultJtaDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in `persistence.xml`. This variant indicates that JTA is supposed to be used as transaction type. In JPA speak, a DataSource passed in here will be uses as "jtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, provided that none has been registered before. See Also `jakarta.persistence.spi.PersistenceUnitInfo#getJtaDataSource()`

public void setDefaultJtaDataSource(DataSource defaultJtaDataSource)

Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified in persistence.xml. This variant indicates that JTA is supposed to be used as transaction type.

In JPA speak, a DataSource passed in here will be uses as "jtaDataSource" on the PersistenceUnitInfo passed to the PersistenceProvider, provided that none has been registered before.

See Also: jakarta.persistence.spi.PersistenceUnitInfo#getJtaDataSource()

setDefaultPersistenceUnitName back to summary

setDefaultPersistenceUnitName	back to summary
public void setDefaultPersistenceUnitName(String defaultPersistenceUnitName) Specify the name of the default persistence unit, if any. Default is "default". Primarily applied to a scanned persistence unit without `persistence.xml`. Also applicable to selecting a default unit from several persistence units available. See Also `setPackagesToScan`, `obtainDefaultPersistenceUnitInfo`

public void setDefaultPersistenceUnitName(String defaultPersistenceUnitName)

Specify the name of the default persistence unit, if any. Default is "default".

Primarily applied to a scanned persistence unit without persistence.xml. Also applicable to selecting a default unit from several persistence units available.

See Also: setPackagesToScan, obtainDefaultPersistenceUnitInfo

setDefaultPersistenceUnitRootLocation	back to summary
public void setDefaultPersistenceUnitRootLocation(String defaultPersistenceUnitRootLocation) Set the default persistence unit root location, to be applied if no unit-specific persistence unit root could be determined. 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.

setDefaultPersistenceUnitRootLocation

back to summary

public void setDefaultPersistenceUnitRootLocation(String defaultPersistenceUnitRootLocation)

Set the default persistence unit root location, to be applied if no unit-specific persistence unit root could be determined.

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.

setLoadTimeWeaver back to summary

public void setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver)

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 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 own VM agent specified on JVM startup. Furthermore, DefaultPersistenceUnitManager falls back to an InstrumentationLoadTimeWeaver if Spring's agent-based instrumentation is available at runtime.

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 (for example, interacting with Spring's TomcatInstrumentableClassLoader). Consider using the context:load-time-weaver XML tag for creating such a shared LoadTimeWeaver (autodetecting the environment by default).

Parameters

loadTimeWeaver:LoadTimeWeaver

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

the LoadTimeWeaver instance (never null)

Annotations

@Override

setManagedClassNameFilter back to summary

public void setManagedClassNameFilter(ManagedClassNameFilter managedClassNameFilter)

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

setManagedTypes back to summary

public void setManagedTypes(PersistenceManagedTypes managedTypes)

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

setMappingResources back to summary

public void setMappingResources(String... mappingResources)

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, this manager 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: setDefaultPersistenceUnitName, setPackagesToScan

setPackagesToScan back to summary

public void setPackagesToScan(String... packagesToScan)

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.

Such package scanning defines a "default persistence unit" in Spring, which may live next to regularly defined units originating from persistence.xml. Its name is determined by setDefaultPersistenceUnitName: by default, it's simply "default".

Note: There may be limitations in comparison to regular JPA scanning. In particular, JPA providers may pick up annotated packages for provider-specific annotations only when driven by persistence.xml. As of 4.1, Spring's scan can detect annotated packages as well if supported by the given org.springframework.orm.jpa.JpaVendorAdapter (e.g. for Hibernate).

If no explicit mapping resources have been specified in addition to these packages, this manager 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).

See Also: setManagedClassNameFilter(ManagedClassNameFilter), setManagedTypes(PersistenceManagedTypes), setDefaultPersistenceUnitName, setMappingResources

setPersistenceUnitPostProcessors back to summary

public void setPersistenceUnitPostProcessors(PersistenceUnitPostProcessor... postProcessors)

Set the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.

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

setPersistenceXmlLocation back to summary

public void setPersistenceXmlLocation(String persistenceXmlLocation)

Specify the location of the persistence.xml files to load. These can be specified as Spring resource locations and/or location patterns.

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

setPersistenceXmlLocations back to summary

public void setPersistenceXmlLocations(String... persistenceXmlLocations)

Specify multiple locations of persistence.xml files to load. These can be specified as Spring resource locations and/or location patterns.

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

Parameters

persistenceXmlLocations:String[]: an array of Spring resource Strings identifying the location of the persistence.xml files to read

setResourceLoader back to summary

public void setResourceLoader(ResourceLoader resourceLoader)

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

setSharedCacheMode back to summary

public void setSharedCacheMode(SharedCacheMode sharedCacheMode)

Specify the JPA 2.0 shared cache mode for all of this manager's persistence units, overriding any value in persistence.xml if set.

Since: 4.0
See Also: jakarta.persistence.spi.PersistenceUnitInfo#getSharedCacheMode()

setValidationMode back to summary

public void setValidationMode(ValidationMode validationMode)

Specify the JPA 2.0 validation mode for all of this manager's persistence units, overriding any value in persistence.xml if set.

Since: 4.0
See Also: jakarta.persistence.spi.PersistenceUnitInfo#getValidationMode()

public Class DefaultPersistenceUnitManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail