Top Description Methods
javax.persistence.spi

public Interface PersistenceProvider

Imports
javax.persistence.EntityManagerFactory, .PersistenceException, java.util.Map

Interface implemented by the persistence provider.

It is invoked by the container in Java EE environments and by the javax.persistence.Persistence class in Java SE environments to create an javax.persistence.EntityManagerFactory and/or to cause schema generation to occur.

Since
Java Persistence 1.0

Method Summary

Modifier and TypeMethod and Description
public EntityManagerFactory

Returns:

EntityManagerFactory for the persistence unit specified by the metadata
createContainerEntityManagerFactory
(PersistenceUnitInfo
metadata for use by the persistence provider
info
,
Map<K, V>
a Map of integration-level properties for use by the persistence provider (may be null if no properties are specified). These properties may include properties to control schema generation. If a Bean Validation provider is present in the classpath, the container must pass the ValidatorFactory instance in the map with the key "javax.persistence.validation.factory". If the containing archive is a bean archive, the container must pass the BeanManager instance in the map with the key "javax.persistence.bean.manager".
map
)

Called by the container when an EntityManagerFactory is to be created.

public EntityManagerFactory

Returns:

EntityManagerFactory for the persistence unit, or null if the provider is not the right provider
createEntityManagerFactory
(String
the name of the persistence unit
emName
,
Map<K, V>
a Map of properties for use by the persistence provider. These properties may be used to override the values of the corresponding elements in the persistence.xml file or specify values for properties not specified in the persistence.xml (and may be null if no properties are specified).
map
)

Called by Persistence class when an EntityManagerFactory is to be created.

public void
generateSchema(PersistenceUnitInfo
metadata for use by the persistence provider
info
,
Map<K, V>
properties for schema generation; these may also include provider-specific properties
map
)

Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties.

public boolean

Returns:

true if schema was generated, otherwise false
generateSchema
(String
the name of the persistence unit
persistenceUnitName
,
Map<K, V>
properties for schema generation; these may also contain provider-specific properties. The value of these properties override any values that may have been configured elsewhere.
map
)

Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties.

public ProviderUtil

Returns:

ProviderUtil interface
getProviderUtil
()

Return the utility interface implemented by the persistence provider.

Method Detail

createContainerEntityManagerFactoryback to summary
public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info, Map<K, V> map)

Called by the container when an EntityManagerFactory is to be created.

Parameters
info:PersistenceUnitInfo

metadata for use by the persistence provider

map:Map<K, V>

a Map of integration-level properties for use by the persistence provider (may be null if no properties are specified). These properties may include properties to control schema generation. If a Bean Validation provider is present in the classpath, the container must pass the ValidatorFactory instance in the map with the key "javax.persistence.validation.factory". If the containing archive is a bean archive, the container must pass the BeanManager instance in the map with the key "javax.persistence.bean.manager".

Returns:EntityManagerFactory

EntityManagerFactory for the persistence unit specified by the metadata

createEntityManagerFactoryback to summary
public EntityManagerFactory createEntityManagerFactory(String emName, Map<K, V> map)

Called by Persistence class when an EntityManagerFactory is to be created.

Parameters
emName:String

the name of the persistence unit

map:Map<K, V>

a Map of properties for use by the persistence provider. These properties may be used to override the values of the corresponding elements in the persistence.xml file or specify values for properties not specified in the persistence.xml (and may be null if no properties are specified).

Returns:EntityManagerFactory

EntityManagerFactory for the persistence unit, or null if the provider is not the right provider

generateSchemaback to summary
public void generateSchema(PersistenceUnitInfo info, Map<K, V> map)

Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties.

Called by the container when schema generation is to occur as a separate phase from creation of the entity manager factory.

Parameters
info:PersistenceUnitInfo

metadata for use by the persistence provider

map:Map<K, V>

properties for schema generation; these may also include provider-specific properties

Exceptions
PersistenceException:
if insufficient or inconsistent configuration information is provided of if schema generation otherwise fails
Since
Java Persistence 2.1
generateSchemaback to summary
public boolean generateSchema(String persistenceUnitName, Map<K, V> map)

Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties.

Called by the Persistence class when schema generation is to occur as a separate phase from creation of the entity manager factory.

Parameters
persistenceUnitName:String

the name of the persistence unit

map:Map<K, V>

properties for schema generation; these may also contain provider-specific properties. The value of these properties override any values that may have been configured elsewhere.

Returns:boolean

true if schema was generated, otherwise false

Exceptions
PersistenceException:
if insufficient or inconsistent configuration information is provided or if schema generation otherwise fails
Since
Java Persistence 2.1
getProviderUtilback to summary
public ProviderUtil getProviderUtil()

Return the utility interface implemented by the persistence provider.

Returns:ProviderUtil

ProviderUtil interface

Since
Java Persistence 2.0