java.lang.Object | |
↳ | org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager |
Default implementation of the PersistenceUnitManager
interface.
Used as internal default by
LocalContainerEntityManagerFactoryBean
.
Supports standard JPA scanning for persistence.xml
files,
with configurable file locations, JDBC DataSource lookup and load-time weaving.
The default XML file location is classpath*:META-INF/persistence.xml
,
scanning for all matching files in the class path (as defined in the JPA specification).
DataSource names are by default interpreted as JNDI names, and no load time weaving
is available (which requires weaving to be turned off in the persistence provider).
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | DEFAULT_PERSISTENCE_XML_LOCATION | Default location of the persistence.xml file:
"classpath*:META-INF/persistence.xml". |
|||||||||
String | ORIGINAL_DEFAULT_PERSISTENCE_UNIT_ROOT_LOCATION | Default location for the persistence unit root URL: "classpath:", indicating the root of the class path. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
| |||||||||||
Return the JDBC DataSourceLookup that provides DataSources for the
persistence provider, resolving data source names in
persistence.xml
against Spring-managed DataSource instances. | |||||||||||
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 . | |||||||||||
Return the Spring LoadTimeWeaver to use for class instrumentation according
to the JPA class transformer contract.
| |||||||||||
Return the PersistenceUnitPostProcessors to be applied to each
PersistenceUnitInfo that has been parsed by this manager.
| |||||||||||
Obtain the default PersistenceUnitInfo from this manager.
| |||||||||||
Obtain the specified PersistenceUnitInfo from this manager.
| |||||||||||
Prepare the PersistenceUnitInfos according to the configuration
of this manager: scanning for
persistence.xml files,
parsing all matching files, configurating and post-processing them. | |||||||||||
Specify the JDBC DataSourceLookup that provides DataSources for the
persistence provider, resolving data source names in
persistence.xml
against Spring-managed DataSource instances. | |||||||||||
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. | |||||||||||
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 . | |||||||||||
Set the default persistence unit root location, to be applied
if no unit-specific persistence unit root could be determined.
| |||||||||||
Specify the Spring LoadTimeWeaver to use for class instrumentation according
to the JPA class transformer contract.
| |||||||||||
Set the PersistenceUnitPostProcessors to be applied to each
PersistenceUnitInfo that has been parsed by this manager.
| |||||||||||
Specify the location of the
persistence.xml files to load. | |||||||||||
Specify multiple locations of
persistence.xml files to load. | |||||||||||
Set the ResourceLoader that this object runs in.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the specified PersistenceUnitInfo from this manager's cache
of processed persistence units, keeping it in the cache (i.e.
| |||||||||||
Hook method allowing subclasses to customize each PersistenceUnitInfo.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.beans.factory.InitializingBean
| |||||||||||
From interface
org.springframework.context.ResourceLoaderAware
| |||||||||||
From interface
org.springframework.context.weaving.LoadTimeWeaverAware
| |||||||||||
From interface
org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager
|
Default location of the persistence.xml
file:
"classpath*:META-INF/persistence.xml".
Default location for the persistence unit root URL: "classpath:", indicating the root of the class path.
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
Return the JDBC DataSourceLookup that provides DataSources for the
persistence provider, resolving data source names in persistence.xml
against Spring-managed DataSource instances.
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
.
Return the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.
Return the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.
Obtain the default PersistenceUnitInfo from this manager.
null
)Obtain the specified PersistenceUnitInfo from this manager.
persistenceUnitName | the name of the desired persistence unit |
---|
null
)Prepare the PersistenceUnitInfos according to the configuration
of this manager: scanning for persistence.xml
files,
parsing all matching files, configurating and post-processing them.
PersistenceUnitInfos cannot be obtained before this preparation method has been invoked.
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.
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).
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
.
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.
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 class path (nearest root directory). To be overridden if unit-specific resolution does not work and the class path root is not appropriate either.
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 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 (for example, interacting with Spring's TomcatInstrumentableClassLoader).
NOTE: As of Spring 2.5, the context's default LoadTimeWeaver (defined
as bean with name "loadTimeWeaver") will be picked up automatically, if available,
removing the need for LoadTimeWeaver configuration on each affected target bean.
Consider using the context:load-time-weaver
XML tag for creating
such a shared LoadTimeWeaver (autodetecting the environment by default).
loadTimeWeaver | the LoadTimeWeaver instance (never null ) |
---|
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 in from
persistence.xml
.
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".
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".
persistenceXmlLocations | an array of Spring resource Strings
identifying the location of the persistence.xml files to read
|
---|
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
.
resourceLoader | ResourceLoader object to be used by this object |
---|
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(MutablePersistenceUnitInfo)
implementations,
detecting existing persistence units of the same name and potentially merging them.
persistenceUnitName | the name of the desired persistence unit |
---|
null
if not available
Hook method allowing subclasses to customize each PersistenceUnitInfo.
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.
pui | the chosen PersistenceUnitInfo, as read from persistence.xml .
Passed in as MutablePersistenceUnitInfo. |
---|