org.hibernate.jpa.boot.internal

Class ParsedPersistenceXmlDescriptor

java.lang.Object

org.hibernate.jpa.boot.internal.ParsedPersistenceXmlDescriptor

All Implemented Interfaces:

PersistenceUnitDescriptor

public class ParsedPersistenceXmlDescriptor
extends Object
implements PersistenceUnitDescriptor

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 PersistenceUnitInfo. Easier to consolidate both views into a single contract and extract information through that shared contract.

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
ParsedPersistenceXmlDescriptor(URL persistenceUnitRootUrl)

Method Summary

Modifier and Type	Method and Description
void	addClasses(List<String> classes)
void	addClasses(String... classes)
void	addJarFileUrl(URL jarFileUrl)
void	addMappingFiles(List<String> mappingFiles)
void	addMappingFiles(String... mappingFiles)
ClassLoader	getClassLoader()
List<URL>	getJarFileUrls()
Object	getJtaDataSource()
List<String>	getManagedClassNames()
List<String>	getMappingFileNames()
String	getName() Get the persistence unit name,
Object	getNonJtaDataSource()
URL	getPersistenceUnitRootUrl() Get the root url for the persistence unit.
Properties	getProperties()
String	getProviderClassName() Get the explicitly specified provider class name, or null if not specified.
javax.persistence.SharedCacheMode	getSharedCacheMode()
ClassLoader	getTempClassLoader()
javax.persistence.spi.PersistenceUnitTransactionType	getTransactionType()
javax.persistence.ValidationMode	getValidationMode()
boolean	isExcludeUnlistedClasses() Essentially should scanning for classes be performed?
boolean	isUseQuotedIdentifiers() Is the use of quoted identifiers in effect for this whole persistence unit?
void	pushClassTransformer(EnhancementContext enhancementContext)
void	setExcludeUnlistedClasses(boolean excludeUnlistedClasses)
void	setJtaDataSource(Object jtaDataSource)
void	setName(String name)
void	setNonJtaDataSource(Object nonJtaDataSource)
void	setProviderClassName(String providerClassName)
void	setSharedCacheMode(String sharedCacheMode)
void	setTransactionType(javax.persistence.spi.PersistenceUnitTransactionType transactionType)
void	setUseQuotedIdentifiers(boolean useQuotedIdentifiers)
void	setValidationMode(String validationMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParsedPersistenceXmlDescriptor

public ParsedPersistenceXmlDescriptor(URL persistenceUnitRootUrl)

Method Detail

getPersistenceUnitRootUrl

public URL getPersistenceUnitRootUrl()

Description copied from interface: PersistenceUnitDescriptor

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

Specified by:

getPersistenceUnitRootUrl in interface PersistenceUnitDescriptor

Returns:

The root url

getName

public String getName()

Description copied from interface: PersistenceUnitDescriptor

Get the persistence unit name,

Specified by:

getName in interface PersistenceUnitDescriptor

Returns:

The persistence unit name,

setName

public void setName(String name)

getNonJtaDataSource

public Object getNonJtaDataSource()

Specified by:

getNonJtaDataSource in interface PersistenceUnitDescriptor

setNonJtaDataSource

public void setNonJtaDataSource(Object nonJtaDataSource)

getJtaDataSource

public Object getJtaDataSource()

Specified by:

getJtaDataSource in interface PersistenceUnitDescriptor

setJtaDataSource

public void setJtaDataSource(Object jtaDataSource)

getProviderClassName

public String getProviderClassName()

Description copied from interface: PersistenceUnitDescriptor

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

Specified by:

getProviderClassName in interface PersistenceUnitDescriptor

Returns:

The specified provider class name

setProviderClassName

public void setProviderClassName(String providerClassName)

getTransactionType

public javax.persistence.spi.PersistenceUnitTransactionType getTransactionType()

Specified by:

getTransactionType in interface PersistenceUnitDescriptor

setTransactionType

public void setTransactionType(javax.persistence.spi.PersistenceUnitTransactionType transactionType)

isUseQuotedIdentifiers

public boolean isUseQuotedIdentifiers()

Description copied from interface: PersistenceUnitDescriptor

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

Specified by:

isUseQuotedIdentifiers in interface PersistenceUnitDescriptor

Returns:

true is quoted identifiers should be used throughout the unit.

setUseQuotedIdentifiers

public void setUseQuotedIdentifiers(boolean useQuotedIdentifiers)

getProperties

public Properties getProperties()

Specified by:

getProperties in interface PersistenceUnitDescriptor

isExcludeUnlistedClasses

public boolean isExcludeUnlistedClasses()

Description copied from interface: PersistenceUnitDescriptor

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

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

Specified by:

isExcludeUnlistedClasses in interface PersistenceUnitDescriptor

Returns:

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

setExcludeUnlistedClasses

public void setExcludeUnlistedClasses(boolean excludeUnlistedClasses)

getValidationMode

public javax.persistence.ValidationMode getValidationMode()

Specified by:

getValidationMode in interface PersistenceUnitDescriptor

setValidationMode

public void setValidationMode(String validationMode)

getSharedCacheMode

public javax.persistence.SharedCacheMode getSharedCacheMode()

Specified by:

getSharedCacheMode in interface PersistenceUnitDescriptor

setSharedCacheMode

public void setSharedCacheMode(String sharedCacheMode)

getManagedClassNames

public List<String> getManagedClassNames()

Specified by:

getManagedClassNames in interface PersistenceUnitDescriptor

addClasses

public void addClasses(String... classes)

addClasses

public void addClasses(List<String> classes)

getMappingFileNames

public List<String> getMappingFileNames()

Specified by:

getMappingFileNames in interface PersistenceUnitDescriptor

addMappingFiles

public void addMappingFiles(String... mappingFiles)

addMappingFiles

public void addMappingFiles(List<String> mappingFiles)

getJarFileUrls

public List<URL> getJarFileUrls()

Specified by:

getJarFileUrls in interface PersistenceUnitDescriptor

addJarFileUrl

public void addJarFileUrl(URL jarFileUrl)

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface PersistenceUnitDescriptor

getTempClassLoader

public ClassLoader getTempClassLoader()

Specified by:

getTempClassLoader in interface PersistenceUnitDescriptor

pushClassTransformer

public void pushClassTransformer(EnhancementContext enhancementContext)

Specified by:

pushClassTransformer in interface PersistenceUnitDescriptor