Interface PersistenceUnitDescriptor

All Known Implementing Classes:

PersistenceConfigurationDescriptor

public interface PersistenceUnitDescriptor

Abstraction for dealing with <persistence-unit/> information specified in the persistence.xml file. This information can come from either:

• from the Jakarta EE container as an instance of PersistenceUnitInfo
• in an SE environment, parsed by Hibernate itself
• HibernatePersistenceConfiguration

See Also:

• PersistenceUnitInfo
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl

Method Summary

Modifier and Type	Method	Description
List<String>	getAllClassNames()	Names of all classes in the persistence-unit - explicitly listed, listed in mapping XML and discovered.
ClassLoader	getClassLoader()
FetchType	getDefaultToOneFetchType()	Default fetching to be applied to to-one mappings when none is specified.
List<URL>	getJarFileUrls()	Names of JAR files explicitly listed in the persistence-unit.
Object	getJtaDataSource()
List<String>	getManagedClassNames()	Names of classes explicitly listed in the persistence-unit.
List<String>	getMappingFileNames()	Names of mapping-files explicitly listed in the persistence-unit.
String	getName()	The persistence unit name.
Object	getNonJtaDataSource()
URL	getPersistenceUnitRootUrl()	The root url for the persistence unit.
PersistenceUnitTransactionType	getPersistenceUnitTransactionType()
Properties	getProperties()
String	getProviderClassName()	The explicitly specified provider class name, or null if not specified.
SharedCacheMode	getSharedCacheMode()
ClassLoader	getTempClassLoader()
ValidationMode	getValidationMode()
boolean	isClassTransformerRegistrationDisabled()
boolean	isExcludeUnlistedClasses()	Whether scanning for classes should be performed.
boolean	isUseQuotedIdentifiers()	Whether the use of identifier quoting is in effect for this whole persistence unit.
ClassTransformer	pushClassTransformer(EnhancementContext enhancementContext)

Method Details

getName

String getName()

The persistence unit name.

See Also:

• PersistenceUnitInfo.getPersistenceUnitName()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getName()

getPersistenceUnitRootUrl

URL getPersistenceUnitRootUrl()

The root url for the persistence unit.

Implementation Note:

When Hibernate performs scanning, this URL is used as the base for scanning.

getProviderClassName

String getProviderClassName()

The explicitly specified provider class name, or null if not specified.

See Also:

• PersistenceUnitInfo.getPersistenceProviderClassName()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getProvider()

isExcludeUnlistedClasses

boolean isExcludeUnlistedClasses()

Whether scanning for classes should be performed. If not, the list of classes available is limited to:

• classes listed in getManagedClassNames()
• classes named in all getMappingFileNames()
• classes discovered in getJarFileUrls()

See Also:

• PersistenceUnitInfo.excludeUnlistedClasses()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.isExcludeUnlistedClasses()

getDefaultToOneFetchType

FetchType getDefaultToOneFetchType()

Default fetching to be applied to to-one mappings when none is specified.

Since:

8.0

See Also:

• PersistenceUnitInfo.getDefaultToOneFetchType()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getDefaultToOneFetchType()
• OneToOne.fetch()
• ManyToOne.fetch()

isUseQuotedIdentifiers

boolean isUseQuotedIdentifiers()

Whether the use of identifier quoting is in effect for this whole persistence unit.

getManagedClassNames

List<String> getManagedClassNames()

Names of classes explicitly listed in the persistence-unit.

See Also:

• PersistenceUnitInfo.getManagedClassNames()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getClasses()

getAllClassNames

List<String> getAllClassNames()

Names of all classes in the persistence-unit - explicitly listed, listed in mapping XML and discovered.

See Also:

• PersistenceUnitInfo.getAllClassNames()

API Note:

This is not supported for all implementors / scenarios. In such cases, it simply returns getManagedClassNames().

getMappingFileNames

List<String> getMappingFileNames()

Names of mapping-files explicitly listed in the persistence-unit.

See Also:

• PersistenceUnitInfo.getMappingFileNames()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getMappingFiles()

getJarFileUrls

List<URL> getJarFileUrls()

Names of JAR files explicitly listed in the persistence-unit.

See Also:

• PersistenceUnitInfo.getJarFileUrls()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getJarFiles()

getPersistenceUnitTransactionType

PersistenceUnitTransactionType getPersistenceUnitTransactionType()

See Also:

• PersistenceUnitInfo.getTransactionType()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getTransactionType()

getNonJtaDataSource

Object getNonJtaDataSource()

See Also:

• PersistenceUnitInfo.getNonJtaDataSource()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getNonJtaDataSource()

getJtaDataSource

Object getJtaDataSource()

See Also:

• PersistenceUnitInfo.getJtaDataSource()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getJtaDataSource()

getValidationMode

ValidationMode getValidationMode()

See Also:

• PersistenceUnitInfo.getValidationMode()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getValidationMode()

getSharedCacheMode

SharedCacheMode getSharedCacheMode()

See Also:

• PersistenceUnitInfo.getSharedCacheMode()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getSharedCacheMode()

getProperties

Properties getProperties()

See Also:

• PersistenceUnitInfo.getProperties()
• JaxbPersistenceImpl.JaxbPersistenceUnitImpl.getPropertyContainer()

getClassLoader

ClassLoader getClassLoader()

See Also:

• PersistenceUnitInfo.getClassLoader()

getTempClassLoader

ClassLoader getTempClassLoader()

See Also:

• PersistenceUnitInfo.getNewTempClassLoader()

isClassTransformerRegistrationDisabled

boolean isClassTransformerRegistrationDisabled()

pushClassTransformer

ClassTransformer pushClassTransformer(EnhancementContext enhancementContext)