| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>PersistenceProvider</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PersistenceProvider"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/persistence/spi/LoadState.html" title="enum in jakarta.persistence.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/persistence/spi/PersistenceProviderResolver.html" title="interface in jakarta.persistence.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/persistence/spi/PersistenceProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.persistence.spi</div> |
| <h2 title="Interface PersistenceProvider" class="title">Interface PersistenceProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PersistenceProvider</span></pre> |
| <div class="block">Interface implemented by the persistence provider. |
| |
| <p> It is invoked by the container in Jakarta EE environments and |
| by the <a href="../../../jakarta/persistence/Persistence.html" title="class in jakarta.persistence"><code>Persistence</code></a> class in Java SE environments to |
| create an <a href="../../../jakarta/persistence/EntityManagerFactory.html" title="interface in jakarta.persistence"><code>EntityManagerFactory</code></a> and/or to cause |
| schema generation to occur.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/persistence/EntityManagerFactory.html" title="interface in jakarta.persistence">EntityManagerFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/spi/PersistenceProvider.html#createContainerEntityManagerFactory-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-">createContainerEntityManagerFactory</a></span>(<a href="../../../jakarta/persistence/spi/PersistenceUnitInfo.html" title="interface in jakarta.persistence.spi">PersistenceUnitInfo</a> info, |
| java.util.Map map)</code> |
| <div class="block">Called by the container when an <code>EntityManagerFactory</code> |
| is to be created.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/persistence/EntityManagerFactory.html" title="interface in jakarta.persistence">EntityManagerFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/spi/PersistenceProvider.html#createEntityManagerFactory-java.lang.String-java.util.Map-">createEntityManagerFactory</a></span>(java.lang.String emName, |
| java.util.Map map)</code> |
| <div class="block">Called by <code>Persistence</code> class when an |
| <code>EntityManagerFactory</code> is to be created.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/spi/PersistenceProvider.html#generateSchema-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-">generateSchema</a></span>(<a href="../../../jakarta/persistence/spi/PersistenceUnitInfo.html" title="interface in jakarta.persistence.spi">PersistenceUnitInfo</a> info, |
| java.util.Map map)</code> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/spi/PersistenceProvider.html#generateSchema-java.lang.String-java.util.Map-">generateSchema</a></span>(java.lang.String persistenceUnitName, |
| java.util.Map map)</code> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/persistence/spi/ProviderUtil.html" title="interface in jakarta.persistence.spi">ProviderUtil</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/spi/PersistenceProvider.html#getProviderUtil--">getProviderUtil</a></span>()</code> |
| <div class="block">Return the utility interface implemented by the persistence |
| provider.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createEntityManagerFactory-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityManagerFactory</h4> |
| <pre><a href="../../../jakarta/persistence/EntityManagerFactory.html" title="interface in jakarta.persistence">EntityManagerFactory</a> createEntityManagerFactory(java.lang.String emName, |
| java.util.Map map)</pre> |
| <div class="block">Called by <code>Persistence</code> class when an |
| <code>EntityManagerFactory</code> is to be created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>emName</code> - the name of the persistence unit</dd> |
| <dd><code>map</code> - 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 <code>persistence.xml</code> file or specify values for |
| properties not specified in the <code>persistence.xml</code> |
| (and may be null if no properties are specified).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EntityManagerFactory for the persistence unit, |
| or null if the provider is not the right provider</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createContainerEntityManagerFactory-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createContainerEntityManagerFactory</h4> |
| <pre><a href="../../../jakarta/persistence/EntityManagerFactory.html" title="interface in jakarta.persistence">EntityManagerFactory</a> createContainerEntityManagerFactory(<a href="../../../jakarta/persistence/spi/PersistenceUnitInfo.html" title="interface in jakarta.persistence.spi">PersistenceUnitInfo</a> info, |
| java.util.Map map)</pre> |
| <div class="block">Called by the container when an <code>EntityManagerFactory</code> |
| is to be created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - metadata for use by the persistence provider</dd> |
| <dd><code>map</code> - 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 <code>ValidatorFactory</code> instance in |
| the map with the key <code>"jakarta.persistence.validation.factory"</code>. |
| If the containing archive is a bean archive, the container |
| must pass the BeanManager instance in the map with the key |
| <code>"jakarta.persistence.bean.manager"</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EntityManagerFactory for the persistence unit |
| specified by the metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateSchema-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateSchema</h4> |
| <pre>void generateSchema(<a href="../../../jakarta/persistence/spi/PersistenceUnitInfo.html" title="interface in jakarta.persistence.spi">PersistenceUnitInfo</a> info, |
| java.util.Map map)</pre> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties. |
| <p> |
| Called by the container when schema generation is to |
| occur as a separate phase from creation of the entity |
| manager factory. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - metadata for use by the persistence provider</dd> |
| <dd><code>map</code> - properties for schema generation; these may |
| also include provider-specific properties</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/persistence/PersistenceException.html" title="class in jakarta.persistence">PersistenceException</a></code> - if insufficient or inconsistent |
| configuration information is provided of if schema |
| generation otherwise fails</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateSchema-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateSchema</h4> |
| <pre>boolean generateSchema(java.lang.String persistenceUnitName, |
| java.util.Map map)</pre> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties. |
| <p> |
| Called by the Persistence class when schema generation is to |
| occur as a separate phase from creation of the entity |
| manager factory. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceUnitName</code> - the name of the persistence unit</dd> |
| <dd><code>map</code> - 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.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if schema was generated, otherwise false</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/persistence/PersistenceException.html" title="class in jakarta.persistence">PersistenceException</a></code> - if insufficient or inconsistent |
| configuration information is provided or if schema |
| generation otherwise fails</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProviderUtil--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProviderUtil</h4> |
| <pre><a href="../../../jakarta/persistence/spi/ProviderUtil.html" title="interface in jakarta.persistence.spi">ProviderUtil</a> getProviderUtil()</pre> |
| <div class="block">Return the utility interface implemented by the persistence |
| provider.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ProviderUtil interface</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/persistence/spi/LoadState.html" title="enum in jakarta.persistence.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/persistence/spi/PersistenceProviderResolver.html" title="interface in jakarta.persistence.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/persistence/spi/PersistenceProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
