Top Description Fields Constructors Methods
org.hibernate.jpa.boot.internal

public Class ParsedPersistenceXmlDescriptor

extends Object
implements PersistenceUnitDescriptor
Class Inheritance
All Implemented Interfaces
org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor
Imports
java.net.URL, java.util.ArrayList, .Arrays, .Collection, .Collections, .List, .Properties, jakarta.persistence.SharedCacheMode, .ValidationMode, jakarta.persistence.spi.PersistenceUnitTransactionType, org.hibernate.bytecode.enhance.spi.EnhancementContext, org.hibernate.bytecode.spi.ClassTransformer
Describes the information gleaned from a <persistence-unit/> element in a persistence.xml file whether parsed directly by Hibernate or passed to us by an EE container as a jakarta.persistence.spi.PersistenceUnitInfo. Easier to consolidate both views into a single contract and extract information through that shared contract.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final List<String>
classes

private boolean
excludeUnlistedClasses

private final List<URL>
jarFileUrls

private Object
jtaDataSource

private final List<String>
mappingFiles

private String
name

private Object
nonJtaDataSource

private final URL
persistenceUnitRootUrl

private final Properties
properties

private String
providerClassName

private SharedCacheMode
sharedCacheMode

private PersistenceUnitTransactionType
transactionType

private boolean
useQuotedIdentifiers

private ValidationMode
validationMode

Constructor Summary

AccessConstructor and Description
public
ParsedPersistenceXmlDescriptor(URL persistenceUnitRootUrl)

Method Summary

Modifier and TypeMethod and Description
public void
addClasses(String... classes)

public void
addClasses(List<String> classes)

public void
addJarFileUrl(URL jarFileUrl)

public void
addMappingFiles(String... mappingFiles)

public void
addMappingFiles(List<String> mappingFiles)

public ClassLoader
getClassLoader()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getClassLoader.

public ClassTransformer
getClassTransformer()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getClassTransformer.

public List<URL>
getJarFileUrls()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getJarFileUrls.

public Object
getJtaDataSource()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getJtaDataSource.

public List<String>
getManagedClassNames()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getManagedClassNames.

public List<String>
getMappingFileNames()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getMappingFileNames.

public String
getName()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getName.

Get the persistence unit name,
public Object
getNonJtaDataSource()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getNonJtaDataSource.

public URL
getPersistenceUnitRootUrl()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getPersistenceUnitRootUrl.

Get the root url for the persistence unit.
public Properties
getProperties()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getProperties.

public String
getProviderClassName()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getProviderClassName.

Get the explicitly specified provider class name, or null if not specified.
public SharedCacheMode
getSharedCacheMode()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getSharedCacheMode.

public ClassLoader
getTempClassLoader()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getTempClassLoader.

public PersistenceUnitTransactionType
getTransactionType()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getTransactionType.

public ValidationMode
getValidationMode()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getValidationMode.

public boolean
isExcludeUnlistedClasses()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isExcludeUnlistedClasses.

Essentially should scanning for classes be performed?
public boolean
isUseQuotedIdentifiers()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isUseQuotedIdentifiers.

Is the use of quoted identifiers in effect for this whole persistence unit?
public void
pushClassTransformer(EnhancementContext enhancementContext)

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.pushClassTransformer.

public void
setExcludeUnlistedClasses(boolean excludeUnlistedClasses)

public void
setJtaDataSource(Object jtaDataSource)

public void
setName(String name)

public void
setNonJtaDataSource(Object nonJtaDataSource)

public void
setProviderClassName(String providerClassName)

public void
setSharedCacheMode(String sharedCacheMode)

public void
setTransactionType(PersistenceUnitTransactionType transactionType)

public void
setUseQuotedIdentifiers(boolean useQuotedIdentifiers)

public void
setValidationMode(String validationMode)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

classesback to summary
private final List<String> classes
excludeUnlistedClassesback to summary
private boolean excludeUnlistedClasses
jarFileUrlsback to summary
private final List<URL> jarFileUrls
jtaDataSourceback to summary
private Object jtaDataSource
mappingFilesback to summary
private final List<String> mappingFiles
nameback to summary
private String name
nonJtaDataSourceback to summary
private Object nonJtaDataSource
persistenceUnitRootUrlback to summary
private final URL persistenceUnitRootUrl
propertiesback to summary
private final Properties properties
providerClassNameback to summary
private String providerClassName
sharedCacheModeback to summary
private SharedCacheMode sharedCacheMode
transactionTypeback to summary
private PersistenceUnitTransactionType transactionType
useQuotedIdentifiersback to summary
private boolean useQuotedIdentifiers
validationModeback to summary
private ValidationMode validationMode

Constructor Detail

ParsedPersistenceXmlDescriptorback to summary
public ParsedPersistenceXmlDescriptor(URL persistenceUnitRootUrl)

Method Detail

addClassesback to summary
public void addClasses(String... classes)
addClassesback to summary
public void addClasses(List<String> classes)
addJarFileUrlback to summary
public void addJarFileUrl(URL jarFileUrl)
addMappingFilesback to summary
public void addMappingFiles(String... mappingFiles)
addMappingFilesback to summary
public void addMappingFiles(List<String> mappingFiles)
getClassLoaderback to summary
public ClassLoader getClassLoader()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getClassLoader.

Annotations
@Override
getClassTransformerback to summary
public ClassTransformer getClassTransformer()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getClassTransformer.

Annotations
@Override
getJarFileUrlsback to summary
public List<URL> getJarFileUrls()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getJarFileUrls.

Annotations
@Override
getJtaDataSourceback to summary
public Object getJtaDataSource()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getJtaDataSource.

Annotations
@Override
getManagedClassNamesback to summary
public List<String> getManagedClassNames()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getManagedClassNames.

Annotations
@Override
getMappingFileNamesback to summary
public List<String> getMappingFileNames()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getMappingFileNames.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getName.

Doc from org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getName.

Get the persistence unit name,

Returns:String

The persistence unit name,

Annotations
@Override
getNonJtaDataSourceback to summary
public Object getNonJtaDataSource()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getNonJtaDataSource.

Annotations
@Override
getPersistenceUnitRootUrlback to summary
public URL getPersistenceUnitRootUrl()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getPersistenceUnitRootUrl.

Doc from org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getPersistenceUnitRootUrl.

Get the root url for the persistence unit. Intended to describe the base for scanning.

Returns:URL

The root url

Annotations
@Override
getPropertiesback to summary
public Properties getProperties()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getProperties.

Annotations
@Override
getProviderClassNameback to summary
public String getProviderClassName()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getProviderClassName.

Doc from org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getProviderClassName.

Get the explicitly specified provider class name, or null if not specified.

Returns:String

The specified provider class name

Annotations
@Override
getSharedCacheModeback to summary
public SharedCacheMode getSharedCacheMode()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getSharedCacheMode.

Annotations
@Override
getTempClassLoaderback to summary
public ClassLoader getTempClassLoader()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getTempClassLoader.

Annotations
@Override
getTransactionTypeback to summary
public PersistenceUnitTransactionType getTransactionType()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getTransactionType.

Annotations
@Override
getValidationModeback to summary
public ValidationMode getValidationMode()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.getValidationMode.

Annotations
@Override
isExcludeUnlistedClassesback to summary
public boolean isExcludeUnlistedClasses()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isExcludeUnlistedClasses.

Doc from org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isExcludeUnlistedClasses.

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

Returns:boolean

true if the root url should not be scanned for classes.

Annotations
@Override
isUseQuotedIdentifiersback to summary
public boolean isUseQuotedIdentifiers()

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isUseQuotedIdentifiers.

Doc from org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.isUseQuotedIdentifiers.

Is the use of quoted identifiers in effect for this whole persistence unit?

Returns:boolean

true is quoted identifiers should be used throughout the unit.

Annotations
@Override
pushClassTransformerback to summary
public void pushClassTransformer(EnhancementContext enhancementContext)

Implements org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor.pushClassTransformer.

Annotations
@Override
setExcludeUnlistedClassesback to summary
public void setExcludeUnlistedClasses(boolean excludeUnlistedClasses)
setJtaDataSourceback to summary
public void setJtaDataSource(Object jtaDataSource)
setNameback to summary
public void setName(String name)
setNonJtaDataSourceback to summary
public void setNonJtaDataSource(Object nonJtaDataSource)
setProviderClassNameback to summary
public void setProviderClassName(String providerClassName)
setSharedCacheModeback to summary
public void setSharedCacheMode(String sharedCacheMode)
setTransactionTypeback to summary
public void setTransactionType(PersistenceUnitTransactionType transactionType)
setUseQuotedIdentifiersback to summary
public void setUseQuotedIdentifiers(boolean useQuotedIdentifiers)
setValidationModeback to summary
public void setValidationMode(String validationMode)