Package io.helidon.integrations.cdi.jpa

Class PersistenceUnitInfoBean

java.lang.Object

io.helidon.integrations.cdi.jpa.PersistenceUnitInfoBean

All Implemented Interfaces:

PersistenceUnitInfo

public class PersistenceUnitInfoBean
extends Object
implements PersistenceUnitInfo

A PersistenceUnitInfo implementation that can be constructed by hand.

See Also:

PersistenceUnitInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PersistenceUnitInfoBean.DataSourceProvider A functional interface indicating that its implementations can supply DataSources.

Constructor Summary

Constructors

Constructor and Description
PersistenceUnitInfoBean(String persistenceUnitName, URL persistenceUnitRootUrl, Collection<? extends String> managedClassNames, PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider, Properties properties) Creates a new PersistenceUnitInfoBean using as many defaults as reasonably possible.
PersistenceUnitInfoBean(String persistenceUnitName, URL persistenceUnitRootUrl, String persistenceXMLSchemaVersion, String persistenceProviderClassName, ClassLoader classLoader, Supplier<? extends ClassLoader> tempClassLoaderSupplier, Consumer<? super ClassTransformer> classTransformerConsumer, boolean excludeUnlistedClasses, Collection<? extends URL> jarFileUrls, Collection<? extends String> managedClassNames, Collection<? extends String> mappingFileNames, String jtaDataSourceName, String nonJtaDataSourceName, PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider, Properties properties, SharedCacheMode sharedCacheMode, PersistenceUnitTransactionType transactionType, ValidationMode validationMode) Creates a new PersistenceUnitInfoBean.

Method Summary

Modifier and Type	Method and Description
void	addTransformer(ClassTransformer classTransformer)
boolean	excludeUnlistedClasses()
static Collection<? extends PersistenceUnitInfoBean>	fromPersistence(Persistence persistence, ClassLoader classLoader, Supplier<? extends ClassLoader> tempClassLoaderSupplier, URL rootUrl, Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses, PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider) Given a Persistence (a Java object representation of a META-INF/persistence.xml resource), a URL representing the root of all persistence units, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can provide DataSource instances, returns a Collection of PersistenceUnitInfoBean instances representing all the persistence units in play.
static PersistenceUnitInfoBean	fromPersistenceUnit(Persistence.PersistenceUnit persistenceUnit, ClassLoader classLoader, Supplier<? extends ClassLoader> tempClassLoaderSupplier, URL rootUrl, Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses, PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider) Given a Persistence.PersistenceUnit (a Java object representation of a <persistence-unit> element in a META-INF/persistence.xml resource), a ClassLoader for loading JPA classes and resources, a Supplier of ClassLoader instances for helping to implement the PersistenceUnitInfo.getNewTempClassLoader() method, a URL representing the persistence unit's root, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can provide DataSource instances, returns a PersistenceUnitInfoBean representing the persistence unit in question.
static PersistenceUnitInfoBean	fromPersistenceUnit(Persistence.PersistenceUnit persistenceUnit, URL rootUrl, Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses, PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider) Given a Persistence.PersistenceUnit (a Java object representation of a <persistence-unit> element in a META-INF/persistence.xml resource), a URL representing the persistence unit's root, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can supply DataSource instances, returns a PersistenceUnitInfoBean representing the persistence unit in question.
ClassLoader	getClassLoader()
List<URL>	getJarFileUrls()
DataSource	getJtaDataSource()
List<String>	getManagedClassNames()
List<String>	getMappingFileNames()
ClassLoader	getNewTempClassLoader()
DataSource	getNonJtaDataSource()
String	getPersistenceProviderClassName()
String	getPersistenceUnitName()
URL	getPersistenceUnitRootUrl()
String	getPersistenceXMLSchemaVersion()
Properties	getProperties()
SharedCacheMode	getSharedCacheMode()
PersistenceUnitTransactionType	getTransactionType()
ValidationMode	getValidationMode()

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceUnitInfoBean

public PersistenceUnitInfoBean(String persistenceUnitName,
                               URL persistenceUnitRootUrl,
                               Collection<? extends String> managedClassNames,
                               PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider,
                               Properties properties)

Creates a new PersistenceUnitInfoBean using as many defaults as reasonably possible.

Parameters:

persistenceUnitName - the name of the persistence unit this PersistenceUnitInfoBean represents; must not be null

persistenceUnitRootUrl - the URL identifying the root of the persistence unit this PersistenceUnitInfoBean represents; must not be null

managedClassNames - a Collection of fully-qualified class names identifying JPA-managed classes (such as entity classes, mapped superclasses and the like); may be null. The Collection is copied and no reference to it is retained.

dataSourceProvider - a PersistenceUnitInfoBean.DataSourceProvider capable of supplying DataSource instances; must not be null

properties - a Properties object representing the properties of the persistence unit represented by this PersistenceUnitInfoBean; may be null. A reference is retained to this object.

Throws:

NullPointerException - if persistenceUnitName, persistenceUnitRootUrl or dataSourceProvider is null

See Also:

PersistenceUnitInfoBean(String, URL, String, String, ClassLoader, Supplier, Consumer, boolean, Collection, Collection, Collection, String, String, DataSourceProvider, Properties, SharedCacheMode, PersistenceUnitTransactionType, ValidationMode)

PersistenceUnitInfoBean

public PersistenceUnitInfoBean(String persistenceUnitName,
                               URL persistenceUnitRootUrl,
                               String persistenceXMLSchemaVersion,
                               String persistenceProviderClassName,
                               ClassLoader classLoader,
                               Supplier<? extends ClassLoader> tempClassLoaderSupplier,
                               Consumer<? super ClassTransformer> classTransformerConsumer,
                               boolean excludeUnlistedClasses,
                               Collection<? extends URL> jarFileUrls,
                               Collection<? extends String> managedClassNames,
                               Collection<? extends String> mappingFileNames,
                               String jtaDataSourceName,
                               String nonJtaDataSourceName,
                               PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider,
                               Properties properties,
                               SharedCacheMode sharedCacheMode,
                               PersistenceUnitTransactionType transactionType,
                               ValidationMode validationMode)

Creates a new PersistenceUnitInfoBean.

Parameters:

persistenceUnitName - the name of the persistence unit this PersistenceUnitInfoBean represents; must not be null

persistenceUnitRootUrl - the URL identifying the root of the persistence unit this PersistenceUnitInfoBean represents; must not be null

persistenceXMLSchemaVersion - a String representation of the version of JPA being supported; may be null in which case "2.2" will be used instead

persistenceProviderClassName - the fully-qualified class name of a PersistenceProvider implementation; may be null in which case a default will be used

classLoader - a ClassLoader to be returned by the getClassLoader() method; may be null

tempClassLoaderSupplier - a Supplier of ClassLoader instances to be used by the getNewTempClassLoader() method; may be null

classTransformerConsumer - a Consumer of any ClassTransformers that may be added via a JPA provider's invocation of the addTransformer(ClassTransformer) method; may be null in which case no action will be taken

excludeUnlistedClasses - if true, then any automatically discovered managed classes not explicitly contained in managedClassNames will be excluded from consideration

jarFileUrls - a Collection of URLs identifying .jar files containing managed classes; may be null. The Collection is copied and no reference to it is retained.

managedClassNames - a Collection of fully-qualified class names identifying JPA-managed classes (such as entity classes, mapped superclasses and the like); may be null. The Collection is copied and no reference to it is retained.

mappingFileNames - a Collection of classpath resource names identifying JPA mapping files; may be null. The Collection is copied and no reference to it is retained.

jtaDataSourceName - the name of a data source that may be enrolled in JTA-compliant transactions; may be null

nonJtaDataSourceName - the name of a data source that should not be enrolled in JTA-compliant transactions; may be null

dataSourceProvider - a PersistenceUnitInfoBean.DataSourceProvider capable of supplying DataSource instances; must not be null

properties - a Properties object representing the properties of the persistence unit represented by this PersistenceUnitInfoBean; may be null. A reference is retained to this object.

sharedCacheMode - the SharedCacheMode this PersistenceUnitInfoBean will use; may be null in which case SharedCacheMode.UNSPECIFIED will be used instead

transactionType - the PersistenceUnitTransactionType this PersistenceUnitInfoBean will use; may be null in which case PersistenceUnitTransactionType.JTA will be used instead

validationMode - the ValidationMode this PersistenceUnitInfoBean will use; may be null in which case ValidationMode.AUTO will be used instead

Throws:

NullPointerException - if persistenceUnitName, persistenceUnitRootUrl or dataSourceProvider is null

See Also:

getPersistenceUnitName(), getPersistenceUnitRootUrl(), getPersistenceXMLSchemaVersion(), getPersistenceProviderClassName(), getClassLoader(), getNewTempClassLoader(), excludeUnlistedClasses(), getJarFileUrls(), getManagedClassNames(), getMappingFileNames(), getJtaDataSource(), getNonJtaDataSource(), getProperties(), getSharedCacheMode(), getTransactionType(), getValidationMode()

Method Detail

getJarFileUrls

public List<URL> getJarFileUrls()

Specified by:

getJarFileUrls in interface PersistenceUnitInfo

getPersistenceUnitRootUrl

public URL getPersistenceUnitRootUrl()

Specified by:

getPersistenceUnitRootUrl in interface PersistenceUnitInfo

getManagedClassNames

public List<String> getManagedClassNames()

Specified by:

getManagedClassNames in interface PersistenceUnitInfo

excludeUnlistedClasses

public boolean excludeUnlistedClasses()

Specified by:

excludeUnlistedClasses in interface PersistenceUnitInfo

getSharedCacheMode

public SharedCacheMode getSharedCacheMode()

Specified by:

getSharedCacheMode in interface PersistenceUnitInfo

getValidationMode

public ValidationMode getValidationMode()

Specified by:

getValidationMode in interface PersistenceUnitInfo

getProperties

public Properties getProperties()

Specified by:

getProperties in interface PersistenceUnitInfo

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface PersistenceUnitInfo

getPersistenceXMLSchemaVersion

public String getPersistenceXMLSchemaVersion()

Specified by:

getPersistenceXMLSchemaVersion in interface PersistenceUnitInfo

getNewTempClassLoader

public ClassLoader getNewTempClassLoader()

Specified by:

getNewTempClassLoader in interface PersistenceUnitInfo

addTransformer

public void addTransformer(ClassTransformer classTransformer)

Specified by:

addTransformer in interface PersistenceUnitInfo

getPersistenceUnitName

public String getPersistenceUnitName()

Specified by:

getPersistenceUnitName in interface PersistenceUnitInfo

getPersistenceProviderClassName

public String getPersistenceProviderClassName()

Specified by:

getPersistenceProviderClassName in interface PersistenceUnitInfo

getTransactionType

public PersistenceUnitTransactionType getTransactionType()

Specified by:

getTransactionType in interface PersistenceUnitInfo

getJtaDataSource

public final DataSource getJtaDataSource()

Specified by:

getJtaDataSource in interface PersistenceUnitInfo

getNonJtaDataSource

public final DataSource getNonJtaDataSource()

Specified by:

getNonJtaDataSource in interface PersistenceUnitInfo

getMappingFileNames

public List<String> getMappingFileNames()

Specified by:

getMappingFileNames in interface PersistenceUnitInfo

fromPersistence

public static final Collection<? extends PersistenceUnitInfoBean> fromPersistence(Persistence persistence,
                                                                                  ClassLoader classLoader,
                                                                                  Supplier<? extends ClassLoader> tempClassLoaderSupplier,
                                                                                  URL rootUrl,
                                                                                  Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses,
                                                                                  PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider)
                                                                           throws MalformedURLException

Given a Persistence (a Java object representation of a META-INF/persistence.xml resource), a URL representing the root of all persistence units, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can provide DataSource instances, returns a Collection of PersistenceUnitInfoBean instances representing all the persistence units in play.

This method never returns null.

Parameters:

persistence - a Persistence containing bootstrap information from which persistence units and their configuration may be deduced; may be null in which case an empty Collection will be returned

classLoader - a ClassLoader that the resulting PersistenceUnitInfoBean instances will use; may be null

tempClassLoaderSupplier - a Supplier of a ClassLoader that will be used to implement the PersistenceUnitInfo.getNewTempClassLoader() method; may be null

rootUrl - the URL representing the root of all persistence units; must not be null

unlistedClasses - a Map of managed classes indexed by persistence unit name whose values might not be explicitly listed in a Persistence.PersistenceUnit; may be null

dataSourceProvider - a PersistenceUnitInfoBean.DataSourceProvider; must not be null

Returns:

a non-null Collection of PersistenceUnitInfoBean instances

Throws:

MalformedURLException - if a URL could not be constructed

NullPointerException - if rootUrl or dataSourceProvider is null

See Also:

fromPersistenceUnit(Persistence.PersistenceUnit, ClassLoader, Supplier, URL, Map, DataSourceProvider), PersistenceUnitInfo

fromPersistenceUnit

public static final PersistenceUnitInfoBean fromPersistenceUnit(Persistence.PersistenceUnit persistenceUnit,
                                                                URL rootUrl,
                                                                Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses,
                                                                PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider)
                                                         throws MalformedURLException

Given a Persistence.PersistenceUnit (a Java object representation of a <persistence-unit> element in a META-INF/persistence.xml resource), a URL representing the persistence unit's root, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can supply DataSource instances, returns a PersistenceUnitInfoBean representing the persistence unit in question.

This method never returns null.

This method calls the fromPersistenceUnit(Persistence.PersistenceUnit, ClassLoader, Supplier, URL, Map, DataSourceProvider) method using the return value of the Thread.getContextClassLoader() method as the ClassLoader.

Parameters:

persistenceUnit - a Persistence.PersistenceUnit; must not be null

rootUrl - the URL representing the root of the persistence unit; must not be null

unlistedClasses - a Map of managed classes indexed by persistence unit name whose values might not be explicitly listed in the supplied Persistence.PersistenceUnit; may be null

dataSourceProvider - a PersistenceUnitInfoBean.DataSourceProvider; must not be null

Returns:

a non-null PersistenceUnitInfoBean

Throws:

MalformedURLException - if a URL could not be constructed

NullPointerException - if persistenceUnit, rootUrl or dataSourceProvider is null

See Also:

fromPersistenceUnit(Persistence.PersistenceUnit, ClassLoader, Supplier, URL, Map, DataSourceProvider), Persistence.PersistenceUnit, PersistenceUnitInfo

fromPersistenceUnit

public static final PersistenceUnitInfoBean fromPersistenceUnit(Persistence.PersistenceUnit persistenceUnit,
                                                                ClassLoader classLoader,
                                                                Supplier<? extends ClassLoader> tempClassLoaderSupplier,
                                                                URL rootUrl,
                                                                Map<? extends String,? extends Set<? extends Class<?>>> unlistedClasses,
                                                                PersistenceUnitInfoBean.DataSourceProvider dataSourceProvider)
                                                         throws MalformedURLException

Given a Persistence.PersistenceUnit (a Java object representation of a <persistence-unit> element in a META-INF/persistence.xml resource), a ClassLoader for loading JPA classes and resources, a Supplier of ClassLoader instances for helping to implement the PersistenceUnitInfo.getNewTempClassLoader() method, a URL representing the persistence unit's root, a Map of unlisted managed classes (entity classes, mapped superclasses and so on) indexed by persistence unit name, and a PersistenceUnitInfoBean.DataSourceProvider that can provide DataSource instances, returns a PersistenceUnitInfoBean representing the persistence unit in question.

This method never returns null.

Parameters:

persistenceUnit - a Persistence.PersistenceUnit; must not be null

classLoader - a ClassLoader that the resulting PersistenceUnitInfoBean will use; may be null

tempClassLoaderSupplier - a Supplier of a ClassLoader that will be used to implement the PersistenceUnitInfo.getNewTempClassLoader() method; may be null

rootUrl - the URL representing the root of the persistence unit; must not be null

unlistedClasses - a Map of managed classes indexed by persistence unit name whose values might not be explicitly listed in the supplied Persistence.PersistenceUnit; may be null

dataSourceProvider - a PersistenceUnitInfoBean.DataSourceProvider; must not be null

Returns:

a non-null PersistenceUnitInfoBean

Throws:

MalformedURLException - if a URL could not be constructed

NullPointerException - if persistenceUnit or rootUrl is null

See Also:

Persistence.PersistenceUnit, PersistenceUnitInfo