FileDocCategorySizeDatePackage
PersistenceUnitInfo.javaAPI DocGlassfish v2 API10584Fri May 04 22:34:08 BST 2007javax.persistence.spi

PersistenceUnitInfo

public interface PersistenceUnitInfo
Interface implemented by the container and used by the persistence provider when creating an {@link javax.persistence.EntityManagerFactory}.
since
Java Persistence 1.0

Fields Summary
Constructors Summary
Methods Summary
public voidaddTransformer(javax.persistence.spi.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 {@link PersistenceUnitInfo#getClassLoader} method. The transformer has no effect on the result returned by the {@link 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.

param
transformer A provider-supplied transformer that the Container invokes at class-(re)definition time

public booleanexcludeUnlistedClasses()
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.

return
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.

public java.lang.ClassLoadergetClassLoader()
Returns ClassLoader that the provider may use to load any classes, resources, or open URLs.

return
ClassLoader that the provider may use to load any classes, resources, or open URLs.

public java.util.ListgetJarFileUrls()
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.

return
a list of URL objects referring to jar files or directories.

public javax.sql.DataSourcegetJtaDataSource()
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.

return
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.

public java.util.ListgetManagedClassNames()
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.

return
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.

public java.util.ListgetMappingFileNames()
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.

return
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.

public java.lang.ClassLoadergetNewTempClassLoader()
Return a new instance of 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 {@link PersistenceUnitInfo#getClassLoader}. None of the classes loaded by this class loader will be visible to application components. The provider may only use this ClassLoader within the scope of the {@link PersistenceProvider#createContainerEntityManagerFactory} call.

return
Temporary ClassLoader with same visibility as current loader

public javax.sql.DataSourcegetNonJtaDataSource()
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.

return
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.

public java.lang.StringgetPersistenceProviderClassName()
Returns the fully qualified name of the persistence provider implementation class. Corresponds to the <provider> element in the persistence.xml file.

return
The fully qualified name of the persistence provider implementation class. Corresponds to the <provider> element in the persistence.xml file.

public java.lang.StringgetPersistenceUnitName()
Returns the name of the persistence unit. Corresponds to the name attribute in the persistence.xml file.

return
The name of the persistence unit. Corresponds to the name attribute in the persistence.xml file.

public java.net.URLgetPersistenceUnitRootUrl()
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.

return
a URL referring to a jar file or directory.

public java.util.PropertiesgetProperties()
Returns properties object. Each property corresponds to a <property> element in the persistence.xml file

return
Properties object. Each property corresponds to a <property> element in the persistence.xml file

public javax.persistence.spi.PersistenceUnitTransactionTypegetTransactionType()
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.

return
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.