javax.persistence.spi.PersistenceProvider Maven / Gradle / Ivy
Show all versions of javax.persistence Show documentation
/*
* Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution. The Eclipse Public License is available
* at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
* is available at http://www.eclipse.org/org/documents/edl-v10.php.
*/
package javax.persistence.spi;
import javax.persistence.EntityManagerFactory;
import java.util.Map;
/**
* Interface implemented by the persistence provider.
*
* It is invoked by the container in Java EE environments and by the {@link javax.persistence.Persistence}
* class in Java SE environments to create an {@link javax.persistence.EntityManagerFactory}.
*/
public interface PersistenceProvider
{
/**
* Called by Persistence class when an EntityManagerFactory is to be created.
* @param emName the name of the persistence unit
* @param map 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).
* @return EntityManagerFactory for the persistence unit, or null if the provider is not the right provider
*/
public EntityManagerFactory createEntityManagerFactory(String emName, Map map);
/**
* Called by the container when an EntityManagerFactory is to be created.
* @param info metadata for use by the persistence provider
* @param map a Map of integration-level properties for use by the persistence provider (may be null if no
* properties are specified). 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".
* @return EntityManagerFactory for the persistence unit specified by the metadata
*/
public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info, Map 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.
* @param info metadata for use by the persistence provider
* @param map properties for schema generation; these may also include provider-specific properties
* @throws javax.persistence.PersistenceException if insufficient or inconsistent configuration information
* is provided or if schema generation otherwise fails.
*/
public void generateSchema(PersistenceUnitInfo info, Map 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.
* @param persistenceUnitName the name of the persistence unit
* @param map 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.
* @return true if schema was generated, otherwise false
* @throws javax.persistence.PersistenceException if insufficient or inconsistent configuration information
* is provided or if schema generation otherwise fails.
*/
public boolean generateSchema(String persistenceUnitName, Map map);
/**
* Return the utility interface implemented by the persistence provider.
* @return ProviderUtil interface
*/
public ProviderUtil getProviderUtil();
}