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;
37:
38: import java.util.Map;
39:
40: /**
41: * The <code>EntityManagerFactory</code> interface is used
42: * by the application to obtain an application-managed entity
43: * manager. When the application has finished using the entity
44: * manager factory, and/or at application shutdown, the
45: * application should close the entity manager factory.
46: * Once an <code>EntityManagerFactory</code> has been closed, all its entity
47: * managers are considered to be in the closed state.
48: *
49: * @since Java Persistence 1.0
50: */
51: public interface EntityManagerFactory {
52:
53: /**
54: * Create a new EntityManager.
55: * This method returns a new EntityManager instance each time
56: * it is invoked.
57: * The isOpen method will return true on the returned instance.
58: */
59: EntityManager createEntityManager();
60:
61: /**
62: * Create a new EntityManager with the specified Map of
63: * properties.
64: * This method returns a new EntityManager instance each time
65: * it is invoked.
66: * The isOpen method will return true on the returned instance.
67: */
68: EntityManager createEntityManager(Map map);
69:
70: /**
71: * Close the factory, releasing any resources that it holds.
72: * After a factory instance is closed, all methods invoked on
73: * it will throw an IllegalStateException, except for isOpen,
74: * which will return false. Once an EntityManagerFactory has
75: * been closed, all its entity managers are considered to be
76: * in the closed state.
77: */
78: void close();
79:
80: /**
81: * Indicates whether or not this factory is open. Returns true
82: * until a call to close has been made.
83: */
84: public boolean isOpen();
85: }
|