SEPersistenceUnitInfo (toplink-essentials 2.0.46 API)

java.lang.Object
- oracle.toplink.essentials.ejb.cmp3.persistence.SEPersistenceUnitInfo

All Implemented Interfaces:

PersistenceUnitInfo
```
public class SEPersistenceUnitInfo
extends Object
implements PersistenceUnitInfo
```
Internal implementation of the PersistenceUnitInfo detailed in the EJB 3.0 specification Used by our Java SE implementation so common method calls can be used in setting of Container and non-Container EntityManagerFactories.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`excludeUnlistedClasses`
`protected List<URL>`	`jarFileUrls`
`protected DataSource`	`jtaDataSource`
`protected List<String>`	`managedClassNames`
`protected List<String>`	`mappingFiles`
`protected DataSource`	`nonJtaDataSource`
`protected String`	`persistenceProviderClassName`
`protected String`	`persistenceUnitName`
`protected URL`	`persistenceUnitRootUrl`
`protected PersistenceUnitTransactionType`	`persistenceUnitTransactionType`
`protected Properties`	`properties`
`protected ClassLoader`	`realClassLoader`
`protected ClassLoader`	`tempClassLoader`

Constructor Summary

Constructors
Constructor and Description

SEPersistenceUnitInfo()

Constructors
Constructor and Description
`SEPersistenceUnitInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTransformer(ClassTransformer transformer)` Add a transformer supplied by the provider that will be called for every new class definition or class redefinition that gets loaded by the loader returned by the PersistenceUnitInfo.getClassLoader method.
`boolean`	`excludeUnlistedClasses()` Returns whether classes in the root of the persistence unit that have not been explicitly listed are to be included in the set of managed classes.
`ClassLoader`	`getClassLoader()` Returns ClassLoader that the provider may use to load any classes, resources, or open URLs.
`Collection<String>`	`getJarFiles()`
`List<URL>`	`getJarFileUrls()` Returns a list of URLs for the jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit.
`DataSource`	`getJtaDataSource()` Returns the JTA-enabled data source to be used by the persistence provider.
`List<String>`	`getManagedClassNames()` Returns the list of the names of the classes that the persistence provider must add it to its set of managed classes.
`List<String>`	`getMappingFileNames()` Returns the list of mapping file names that the persistence provider must load to determine the mappings for the entity classes.
`ClassLoader`	`getNewTempClassLoader()` Return a ClassLoader that the provider may use to temporarily load any classes, resources, or open URLs.
`DataSource`	`getNonJtaDataSource()` Returns the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction.
`String`	`getPersistenceProviderClassName()` Returns the fully qualified name of the persistence provider implementation class.
`String`	`getPersistenceUnitName()` Returns the name of the persistence unit.
`URL`	`getPersistenceUnitRootUrl()` Returns the URL for the jar file or directory that is the root of the persistence unit.
`Properties`	`getProperties()` Returns properties object.
`PersistenceUnitTransactionType`	`getTransactionType()` Returns the transaction type of the entity managers created by the EntityManagerFactory.
`void`	`setClassLoader(ClassLoader loader)`
`void`	`setExcludeUnlistedClasses(boolean excludeUnlistedClasses)`
`void`	`setJarFileUrls(List<URL> jarFileUrls)`
`void`	`setJtaDataSource(DataSource jtaDataSource)`
`void`	`setManagedClassNames(List<String> managedClassNames)`
`void`	`setMappingFileNames(List<String> mappingFiles)`
`void`	`setNewTempClassLoader(ClassLoader loader)`
`void`	`setNonJtaDataSource(DataSource nonJtaDataSource)`
`void`	`setPersistenceProviderClassName(String persistenceProviderClassName)`
`void`	`setPersistenceUnitName(String persistenceUnitName)`
`void`	`setPersistenceUnitRootUrl(URL persistenceUnitRootUrl)`
`void`	`setProperties(Properties properties)`
`void`	`setTransactionType(PersistenceUnitTransactionType persistenceUnitTransactionType)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - persistenceUnitName
```
protected String persistenceUnitName
```
  - persistenceProviderClassName
```
protected String persistenceProviderClassName
```
  - jtaDataSource
```
protected DataSource jtaDataSource
```
  - nonJtaDataSource
```
protected DataSource nonJtaDataSource
```
  - persistenceUnitTransactionType
```
protected PersistenceUnitTransactionType persistenceUnitTransactionType
```
  - mappingFiles
```
protected List<String> mappingFiles
```
  - jarFileUrls
```
protected List<URL> jarFileUrls
```
  - managedClassNames
```
protected List<String> managedClassNames
```
  - persistenceUnitRootUrl
```
protected URL persistenceUnitRootUrl
```
  - excludeUnlistedClasses
```
protected boolean excludeUnlistedClasses
```
  - properties
```
protected Properties properties
```
  - tempClassLoader
```
protected ClassLoader tempClassLoader
```
  - realClassLoader
```
protected ClassLoader realClassLoader
```
- Constructor Detail
  - SEPersistenceUnitInfo
```
public SEPersistenceUnitInfo()
```
- Method Detail
  - getPersistenceUnitName
```
public String getPersistenceUnitName()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the name of the persistence unit. Corresponds to the name attribute in the persistence.xml file.
    
    Specified by:
    
    getPersistenceUnitName in interface PersistenceUnitInfo
    
    Returns:
    
    The name of the persistence unit. Corresponds to the element in the persistence.xml file.
  - setPersistenceUnitName
```
public void setPersistenceUnitName(String persistenceUnitName)
```
  - getPersistenceProviderClassName
```
public String getPersistenceProviderClassName()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the fully qualified name of the persistence provider implementation class. Corresponds to the <provider> element in the persistence.xml file.
    
    Specified by:
    
    getPersistenceProviderClassName in interface PersistenceUnitInfo
    
    Returns:
    
    The fully qualified name of the persistence provider implementation class. Corresponds to the element in the persistence.xml file.
  - setPersistenceProviderClassName
```
public void setPersistenceProviderClassName(String persistenceProviderClassName)
```
  - getTransactionType
```
public PersistenceUnitTransactionType getTransactionType()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the transaction type of the entity managers created by the EntityManagerFactory. The transaction type corresponds to the transaction-type attribute in the persistence.xml file.
    
    Specified by:
    
    getTransactionType in interface PersistenceUnitInfo
    
    Returns:
    
    The transaction type of the entity managers created by the EntityManagerFactory. The transaction type corresponds to the transaction-type attribute in the persistence.xml file.
  - setTransactionType
```
public void setTransactionType(PersistenceUnitTransactionType persistenceUnitTransactionType)
```
  - getJtaDataSource
```
public DataSource getJtaDataSource()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the JTA-enabled data source to be used by the persistence provider. The data source corresponds to the <jta-data-source> element in the persistence.xml file or is provided at deployment or by the container.
    
    Specified by:
    
    getJtaDataSource in interface PersistenceUnitInfo
    
    Returns:
    
    the JTA-enabled data source to be used by the persistence provider. The data source corresponds to the element in the persistence.xml file or is provided at deployment or by the container.
  - setJtaDataSource
```
public void setJtaDataSource(DataSource jtaDataSource)
```
  - getNonJtaDataSource
```
public DataSource getNonJtaDataSource()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction. The data source corresponds to the named <non-jta-data-source> element in the persistence.xml file or provided at deployment or by the container.
    
    Specified by:
    
    getNonJtaDataSource in interface PersistenceUnitInfo
    
    Returns:
    
    The non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction. The data source corresponds to the named element in the persistence.xml file or provided at deployment or by the container.
  - setNonJtaDataSource
```
public void setNonJtaDataSource(DataSource nonJtaDataSource)
```
  - getMappingFileNames
```
public List<String> getMappingFileNames()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the list of mapping file names that the persistence provider must load to determine the mappings for the entity classes. The mapping files must be in the standard XML mapping format, be uniquely named and be resource-loadable from the application classpath. This list will not include the orm.xml file if one was specified. Each mapping file name corresponds to a <mapping-file> element in the persistence.xml file.
    
    Specified by:
    
    getMappingFileNames in interface PersistenceUnitInfo
    
    Returns:
    
    The list of mapping file names that the persistence provider must load to determine the mappings for the entity classes. The mapping files must be in the standard XML mapping format, be uniquely named and be resource-loadable from the application classpath. This list will not include the orm.xml file if one was specified. Each mapping file name corresponds to a element in the persistence.xml file.
  - setMappingFileNames
```
public void setMappingFileNames(List<String> mappingFiles)
```
  - getJarFileUrls
```
public List<URL> getJarFileUrls()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns a list of URLs for the jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit. Each URL corresponds to a named element in the persistence.xml file. A URL will either be a file: URL referring to a jar file or referring to a directory that contains an exploded jar file, or some other URL from which an InputStream in jar format can be obtained.
    
    Specified by:
    
    getJarFileUrls in interface PersistenceUnitInfo
    
    Returns:
    
    The list of JAR file URLs that the persistence provider must examine for managed classes of the persistence unit. Each jar file URL corresponds to a named element in the persistence.xml file.
  - setJarFileUrls
```
public void setJarFileUrls(List<URL> jarFileUrls)
```
  - getPersistenceUnitRootUrl
```
public URL getPersistenceUnitRootUrl()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the URL for the jar file or directory that is the root of the persistence unit. (If the persistence unit is rooted in the WEB-INF/classes directory, this will be the URL of that directory.) The URL will either be a file: URL referring to a jar file or referring to a directory that contains an exploded jar file, or some other URL from which an InputStream in jar format can be obtained.
    
    Specified by:
    
    getPersistenceUnitRootUrl in interface PersistenceUnitInfo
    
    Returns:
    
    The URL for the jar file that is the root of the persistence unit. If the persistence unit is rooted in the WEB-INF/classes directory, this will be the URL of that directory.
  - setPersistenceUnitRootUrl
```
public void setPersistenceUnitRootUrl(URL persistenceUnitRootUrl)
```
  - getManagedClassNames
```
public List<String> getManagedClassNames()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns the list of the names of the classes that the persistence provider must add it to its set of managed classes. Each name corresponds to a named <class> element in the persistence.xml file.
    
    Specified by:
    
    getManagedClassNames in interface PersistenceUnitInfo
    
    Returns:
    
    The list of the names of the classes that the persistence provider must add it to its set of managed classes. Each name corresponds to a named element in the persistence.xml file.
  - setManagedClassNames
```
public void setManagedClassNames(List<String> managedClassNames)
```
  - excludeUnlistedClasses
```
public boolean excludeUnlistedClasses()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns whether classes in the root of the persistence unit that have not been explicitly listed are to be included in the set of managed classes. This value corresponds to the <exclude-unlisted-classes> element in the persistence.xml file.
    
    Specified by:
    
    excludeUnlistedClasses in interface PersistenceUnitInfo
    
    Returns:
    
    Whether classes in the root of the persistence unit that have not been explicitly listed are to be included in the set of managed classes. This value corresponds to the element in the persistence.xml file.
  - setExcludeUnlistedClasses
```
public void setExcludeUnlistedClasses(boolean excludeUnlistedClasses)
```
  - getProperties
```
public Properties getProperties()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns properties object. Each property corresponds to a <property> element in the persistence.xml file
    
    Specified by:
    
    getProperties in interface PersistenceUnitInfo
    
    Returns:
    
    Properties object. Each property corresponds to a element in the persistence.xml file
  - setProperties
```
public void setProperties(Properties properties)
```
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: PersistenceUnitInfo
    
    Returns ClassLoader that the provider may use to load any classes, resources, or open URLs.
    
    Specified by:
    
    getClassLoader in interface PersistenceUnitInfo
    
    Returns:
    
    ClassLoader that the provider may use to load any classes, resources, or open URLs.
  - addTransformer
```
public void addTransformer(ClassTransformer transformer)
```
    Add a transformer supplied by the provider that will be called for every new class definition or class redefinition that gets loaded by the loader returned by the PersistenceUnitInfo.getClassLoader method. The transformer has no effect on the result returned by the PersistenceUnitInfo.getNewTempClassLoader method. Classes are only transformed once within the same classloading scope, regardless of how many persistence units they may be a part of.
    
    Specified by:
    
    addTransformer in interface PersistenceUnitInfo
    
    Parameters:
    
    transformer - A provider-supplied transformer that the Container invokes at class-(re)definition time
  - getNewTempClassLoader
```
public ClassLoader getNewTempClassLoader()
```
    Return a ClassLoader that the provider may use to temporarily load any classes, resources, or open URLs. The scope and classpath of this loader is exactly the same as that of the loader returned by PersistenceUnitInfo.getClassLoader. None of the classes loaded by this class loader will be visible to application components.
    
    Specified by:
    
    getNewTempClassLoader in interface PersistenceUnitInfo
    
    Returns:
    
    Temporary ClassLoader with same visibility as current loader
  - setNewTempClassLoader
```
public void setNewTempClassLoader(ClassLoader loader)
```
  - setClassLoader
```
public void setClassLoader(ClassLoader loader)
```
  - getJarFiles
```
public Collection<String> getJarFiles()
```

Class SEPersistenceUnitInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

persistenceUnitName

persistenceProviderClassName

jtaDataSource

nonJtaDataSource

persistenceUnitTransactionType

mappingFiles

jarFileUrls

managedClassNames

persistenceUnitRootUrl

excludeUnlistedClasses

properties

tempClassLoader

realClassLoader

Constructor Detail

SEPersistenceUnitInfo

Method Detail

getPersistenceUnitName

setPersistenceUnitName

getPersistenceProviderClassName

setPersistenceProviderClassName

getTransactionType

setTransactionType

getJtaDataSource

setJtaDataSource

getNonJtaDataSource

setNonJtaDataSource

getMappingFileNames

setMappingFileNames

getJarFileUrls

setJarFileUrls

getPersistenceUnitRootUrl

setPersistenceUnitRootUrl

getManagedClassNames

setManagedClassNames

excludeUnlistedClasses

setExcludeUnlistedClasses

getProperties

setProperties

getClassLoader

addTransformer

getNewTempClassLoader

setNewTempClassLoader

setClassLoader

getJarFiles