01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence.spi;
37:
38: import java.util.Map;
39: import javax.persistence.EntityManagerFactory;
40:
41: /**
42: * Interface implemented by a persistence provider.
43: * The implementation of this interface that is to
44: * be used for a given {@link javax.persistence.EntityManager} is specified in
45: * persistence.xml file in the persistence archive.
46: * This interface is invoked by the Container when it
47: * needs to create an {@link javax.persistence.EntityManagerFactory}, or by the
48: * Persistence class when running outside the Container.
49: *
50: * @since Java Persistence 1.0
51: */
52: public interface PersistenceProvider {
53:
54: /**
55: * Called by Persistence class when an {@link javax.persistence.EntityManagerFactory}
56: * is to be created.
57: *
58: * @param emName The name of the persistence unit
59: * @param map A Map of properties for use by the
60: * persistence provider. These properties may be used to
61: * override the values of the corresponding elements in
62: * the persistence.xml file or specify values for
63: * properties not specified in the persistence.xml.
64: * @return EntityManagerFactory for the persistence unit,
65: * or null if the provider is not the right provider
66: */
67: public EntityManagerFactory createEntityManagerFactory(
68: String emName, Map map);
69:
70: /**
71: * Called by the container when an {@link javax.persistence.EntityManagerFactory}
72: * is to be created.
73: *
74: * @param info Metadata for use by the persistence provider
75: * @param map A Map of integration-level properties for use
76: * by the persistence provider. Can be null if there is no
77: * integration-level property.
78: * @return EntityManagerFactory for the persistence unit
79: * specified by the metadata
80: */
81: public EntityManagerFactory createContainerEntityManagerFactory(
82: PersistenceUnitInfo info, Map map);
83: }
|