com.scottescue.dropwizard.entitymanager

Interface PersistenceUnitConfig

public interface PersistenceUnitConfig

Provides a means to configure the persistence unit before it is created.

Method Summary

Modifier and Type	Method and Description
PersistenceUnitConfig	addJarFileUrls(URL url, URL... urls) Specifies URLs for any jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit.
PersistenceUnitConfig	addMappingFileNames(String fileName, String... fileNames) Specifies any mapping files that must be loaded to determine the mappings for the entity classes.
PersistenceUnitConfig	setExcludeUnlistedClasses(boolean excludeUnlistedClasses) Specifies 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.
PersistenceUnitConfig	setProperty(String property, String value) Specifies a property value to be used by the persistence provider for the persistence unit.
PersistenceUnitConfig	setSharedCacheMode(javax.persistence.SharedCacheMode sharedCacheMode) Specifies how the provider must use a second-level cache for the persistence unit.
PersistenceUnitConfig	setValidationMode(javax.persistence.ValidationMode validationMode) Specifies the validation mode to be used by the persistence provider for the persistence unit.

Method Detail

setExcludeUnlistedClasses

PersistenceUnitConfig setExcludeUnlistedClasses(boolean excludeUnlistedClasses)

Specifies 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. Classes that have not been explicitly listed are excluded by default.

Parameters:

excludeUnlistedClasses - 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

Returns:

a reference to this object

setSharedCacheMode

PersistenceUnitConfig setSharedCacheMode(javax.persistence.SharedCacheMode sharedCacheMode)

Specifies how the provider must use a second-level cache for the persistence unit. SharedCacheMode.UNSPECIFIED is used by default.

Parameters:

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

Returns:

a reference to this object

setValidationMode

PersistenceUnitConfig setValidationMode(javax.persistence.ValidationMode validationMode)

Specifies the validation mode to be used by the persistence provider for the persistence unit. ValidationMode.AUTO is used by default.

Parameters:

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

Returns:

a reference to this object

addMappingFileNames

PersistenceUnitConfig addMappingFileNames(String fileName,
                                          String... fileNames)

Specifies any mapping files that must be loaded 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. There are no mapping files used by default.

Parameters:

fileName - mapping file name that the persistence provider must load to determine the mappings for the entity classes

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

Returns:

a reference to this object

addJarFileUrls

PersistenceUnitConfig addJarFileUrls(URL url,
                                     URL... urls)

Specifies URLs for any jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit. 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.

Parameters:

url - URL object referring to a jar file or directory

urls - list of any additional URL objects referring to jar files or directories

Returns:

a reference to this object

setProperty

PersistenceUnitConfig setProperty(String property,
                                  String value)

Specifies a property value to be used by the persistence provider for the persistence unit.

Parameters:

property - property name

value - the value to be used by the persistence provider for the persistence unit

Returns:

a reference to this object