org.codegeny.jakartron.jpa

Annotation Type PersistenceUnitDefinition

@Retention(value=RUNTIME)
public @interface PersistenceUnitDefinition

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	unitName Returns the name of the persistence unit.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.
String[]	jarFileUrls 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.
String	jtaDataSourceName Returns the JTA-enabled data source to be used by the persistence provider.
Class<?>[]	managedClasses Returns the list of the classes that the persistence provider must add to its set of managed classes.
String[]	managedClassNames Returns the list of the names of the classes that the persistence provider must add to its set of managed classes.
String[]	mappingFileNames Returns the list of the names of the mapping files that the persistence provider must load to determine the mappings for the entity classes.
String	nonJtaDataSourceName Returns the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction.
PersistenceUnitDefinition.Property[]	properties Returns a properties object.
String	providerClassName Returns the fully qualified name of the persistence provider implementation class.
javax.persistence.SharedCacheMode	sharedCacheMode Returns the specification of how the provider must use a second-level cache for the persistence unit.
javax.persistence.spi.PersistenceUnitTransactionType	transactionType Returns the transaction type of the entity managers created by the EntityManagerFactory.
String	unitRootUrl Returns the URL for the jar file or directory that is the root of the persistence unit.
javax.persistence.ValidationMode	validationMode Returns the validation mode to be used by the persistence provider for the persistence unit.
String	xmlSchemaVersion Returns the schema version of the persistence.xml file.

Element Detail

unitName

public abstract String unitName

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

Returns:

the name of the persistence unit

providerClassName

public abstract String providerClassName

Returns the fully qualified name of the persistence provider implementation class. Corresponds to the provider element in the persistence.xml file.

Returns:

the fully qualified name of the persistence provider implementation class

Default:

""

transactionType

public abstract javax.persistence.spi.PersistenceUnitTransactionType transactionType

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.

Returns:

transaction type of the entity managers created by the EntityManagerFactory

Default:

javax.persistence.spi.PersistenceUnitTransactionType.JTA

jtaDataSourceName

public abstract String jtaDataSourceName

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.

Returns:

the JTA-enabled data source to be used by the persistence provider

Default:

""

nonJtaDataSourceName

public abstract String nonJtaDataSourceName

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.

Returns:

the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction

Default:

""

mappingFileNames

public abstract String[] mappingFileNames

Returns the list of the names of the mapping files 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. Each mapping file name corresponds to a mapping-file element in the persistence.xml file.

Returns:

the list of mapping file names that the persistence provider must load to determine the mappings for the entity classes

Default:

{}

jarFileUrls

public abstract String[] jarFileUrls

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 jar-file 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.

Returns:

a list of URL objects referring to jar files or directories

Default:

{}

unitRootUrl

public abstract String unitRootUrl

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.

Returns:

a URL referring to a jar file or directory

Default:

""

managedClasses

public abstract Class<?>[] managedClasses

Returns the list of the classes that the persistence provider must add to its set of managed classes. Each name corresponds to a named class element in the persistence.xml file.

Returns:

the list of the classes that the persistence provider must add to its set of managed classes

Default:

{}

managedClassNames

public abstract String[] managedClassNames

Returns the list of the names of the classes that the persistence provider must add to its set of managed classes. Each name corresponds to a named class element in the persistence.xml file.

Returns:

the list of the names of the classes that the persistence provider must add to its set of managed classes

Default:

{}

excludeUnlistedClasses

public abstract 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. This value corresponds to the exclude-unlisted-classes element in the persistence.xml file.

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

Default:

false

sharedCacheMode

public abstract javax.persistence.SharedCacheMode sharedCacheMode

Returns the specification of how the provider must use a second-level cache for the persistence unit. The result of this method corresponds to the shared-cache-mode element in the persistence.xml file.

Returns:

the second-level cache mode that must be used by the provider for the persistence unit

Since:

Java Persistence 2.0

Default:

javax.persistence.SharedCacheMode.ALL

validationMode

public abstract javax.persistence.ValidationMode validationMode

Returns the validation mode to be used by the persistence provider for the persistence unit. The validation mode corresponds to the validation-mode element in the persistence.xml file.

Returns:

the validation mode to be used by the persistence provider for the persistence unit

Since:

Java Persistence 2.0

Default:

javax.persistence.ValidationMode.AUTO

properties

public abstract PersistenceUnitDefinition.Property[] properties

Returns a properties object. Each property corresponds to a property element in the persistence.xml file or to a property set by the container.

Returns:

Properties object

Default:

{}

xmlSchemaVersion

public abstract String xmlSchemaVersion

Returns the schema version of the persistence.xml file.

Returns:

persistence.xml schema version

Since:

Java Persistence 2.0

Default:

"2.0"