| <html><head> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <title>5. OpenJPA Properties</title><link rel="stylesheet" href="css/docbook.css" type="text/css"><base href="display"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"><link rel="start" href="manual.html" title="Apache OpenJPA 2.0 User's Guide"><link rel="up" href="ref_guide_conf.html" title="Chapter 2. Configuration"><link rel="prev" href="ref_guide_conf_plugins.html" title="4. Plugin Configuration"><link rel="next" href="ref_guide_conf_jdbc.html" title="6. OpenJPA JDBC Properties"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5. |
| OpenJPA Properties |
| </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref_guide_conf_plugins.html">Prev</a> </td><th width="60%" align="center">Chapter 2. |
| Configuration |
| </th><td width="20%" align="right"> <a accesskey="n" href="ref_guide_conf_jdbc.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ref_guide_conf_openjpa"></a>5. |
| OpenJPA Properties |
| </h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.AutoClear">5.1. |
| openjpa.AutoClear |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.AutoDetach">5.2. |
| openjpa.AutoDetach |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.BrokerFactory">5.3. |
| openjpa.BrokerFactory |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.BrokerImpl">5.4. |
| openjpa.BrokerImpl |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Callbacks">5.5. openjpa.Callbacks</a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ClassResolver">5.6. |
| openjpa.ClassResolver |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Compatibility">5.7. |
| openjpa.Compatibility |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionDriverName">5.8. |
| openjpa.ConnectionDriverName |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Connection2DriverName">5.9. |
| openjpa.Connection2DriverName |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactory">5.10. |
| openjpa.ConnectionFactory |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactory2">5.11. |
| openjpa.ConnectionFactory2 |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactoryName">5.12. |
| openjpa.ConnectionFactoryName |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactory2Name">5.13. |
| openjpa.ConnectionFactory2Name |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactoryMode">5.14. |
| openjpa.ConnectionFactoryMode |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactoryProperties">5.15. |
| openjpa.ConnectionFactoryProperties |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactory2Properties">5.16. |
| openjpa.ConnectionFactory2Properties |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionPassword">5.17. |
| openjpa.ConnectionPassword |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Connection2Password">5.18. |
| openjpa.Connection2Password |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionProperties">5.19. |
| openjpa.ConnectionProperties |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Connection2Properties">5.20. |
| openjpa.Connection2Properties |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionURL">5.21. |
| openjpa.ConnectionURL |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Connection2URL">5.22. |
| openjpa.Connection2URL |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionUserName">5.23. |
| openjpa.ConnectionUserName |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Connection2UserName">5.24. |
| openjpa.Connection2UserName |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ConnectionRetainMode">5.25. |
| openjpa.ConnectionRetainMode |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DataCache">5.26. |
| openjpa.DataCache |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DataCacheManager">5.27. |
| openjpa.DataCacheManager |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DataCacheMode">5.28. |
| openjpa.DataCacheMode |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DataCacheTimeout">5.29. |
| openjpa.DataCacheTimeout |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DetachState">5.30. |
| openjpa.DetachState |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DynamicDataStructs">5.31. |
| openjpa.DynamicDataStructs |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.FetchBatchSize">5.32. |
| openjpa.FetchBatchSize |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.EncryptionProvider">5.33. |
| openjpa.EncryptionProvider |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.FetchGroups">5.34. |
| openjpa.FetchGroups |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.FlushBeforeQueries">5.35. |
| openjpa.FlushBeforeQueries |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.IgnoreChanges">5.36. |
| openjpa.IgnoreChanges |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Id">5.37. openjpa.Id</a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.InitializeEagerly">5.38. |
| openjpa.InitializeEagerly |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.InverseManager">5.39. |
| openjpa.InverseManager |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.LockManager">5.40. |
| openjpa.LockManager |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.LockTimeout">5.41. |
| openjpa.LockTimeout |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Log">5.42. |
| openjpa.Log |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ManagedRuntime">5.43. |
| openjpa.ManagedRuntime |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Mapping">5.44. |
| openjpa.Mapping |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.MaxFetchDepth">5.45. |
| openjpa.MaxFetchDepth |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.MetaDataFactory">5.46. |
| openjpa.MetaDataFactory |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.MetaDataRepository">5.47. |
| openjpa.MetaDataRepository |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Multithreaded">5.48. |
| openjpa.Multithreaded |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Optimistic">5.49. |
| openjpa.Optimistic |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.OrphanedKeyAction">5.50. |
| openjpa.OrphanedKeyAction |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.NontransactionalRead">5.51. |
| openjpa.NontransactionalRead |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.NontransactionalWrite">5.52. |
| openjpa.NontransactionalWrite |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ProxyManager">5.53. |
| openjpa.ProxyManager |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.QueryCache">5.54. |
| openjpa.QueryCache |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.QueryCompilationCache">5.55. |
| openjpa.QueryCompilationCache |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.ReadLockLevel">5.56. |
| openjpa.ReadLockLevel |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.RemoteCommitProvider">5.57. |
| openjpa.RemoteCommitProvider |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.RestoreState">5.58. |
| openjpa.RestoreState |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.RetainState">5.59. |
| openjpa.RetainState |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.RetryClassRegistration">5.60. |
| openjpa.RetryClassRegistration |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.RuntimeUnenhancedClasses">5.61. openjpa.RuntimeUnenhancedClasses</a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.DynamicEnhancementAgent">5.62. openjpa.DynamicEnhancementAgent</a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.SavepointManager">5.63. |
| openjpa.SavepointManager |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Sequence">5.64. |
| openjpa.Sequence |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.Specification">5.65. |
| openjpa.Specification |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.TransactionMode">5.66. |
| openjpa.TransactionMode |
| </a></span></dt><dt><span class="section"><a href="ref_guide_conf_openjpa.html#openjpa.WriteLockLevel">5.67. |
| openjpa.WriteLockLevel |
| </a></span></dt></dl></div><a class="indexterm" name="d0e14392"></a><p> |
| OpenJPA defines many configuration properties. Most of these properties are |
| provided for advanced users who wish to customize OpenJPA's behavior; the |
| majority of developers can omit them. The following properties apply to any |
| OpenJPA back-end, though the given descriptions are tailored to OpenJPA's |
| default JDBC store. |
| </p><p> |
| Few of the properties recognized by OpenJPA have been standardized in JPA 2.0 |
| Specification using equivalent names. These properties can be specified either |
| by the JPA standard key or equivalent OpenJPA key. Specifying the same key once |
| as JPA standard key and again as equivalent OpenJPA key in the same configuration, |
| however, is not allowed. The following table lists these standard JPA properties |
| and their OpenJPA equivalent. |
| </p><div class="table"><a name="d0e14401"></a><p class="title"><b>Table 2.1. |
| Standard JPA Properties and OpenJPA equivalents |
| </b></p><div class="table-contents"><table summary="
 Standard JPA Properties and OpenJPA equivalents
 " border="1"><colgroup><col align="left"><col align="left"></colgroup><thead><tr><th align="left">Standard JPA 2.0</th><th align="left">OpenJPA Equivalent</th></tr></thead><tbody><tr><td align="left">javax.persistence.jdbc.driver</td><td align="left">openjpa.ConnectionDriverName</td></tr><tr><td align="left">javax.persistence.jdbc.url</td><td align="left">openjpa.ConnectionURL</td></tr><tr><td align="left">javax.persistence.jdbc.user</td><td align="left">openjpa.ConnectionUserName</td></tr><tr><td align="left">javax.persistence.jdbc.password</td><td align="left">openjpa.ConnectionPassword</td></tr></tbody></table></div></div><br class="table-break"><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.AutoClear"></a>5.1. |
| openjpa.AutoClear |
| </h3></div></div></div><a class="indexterm" name="d0e14438"></a><a class="indexterm" name="d0e14441"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.AutoClear |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoClear()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getAutoClear |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| AutoClear</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">datastore</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">datastore</code>, |
| <code class="literal">all</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> When to automatically clear |
| instance state: on entering a datastore transaction, or on entering any |
| transaction. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.AutoDetach"></a>5.2. |
| openjpa.AutoDetach |
| </h3></div></div></div><a class="indexterm" name="d0e14497"></a><a class="indexterm" name="d0e14500"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.AutoDetach |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoDetach()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getAutoDetach |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| AutoDetach</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">close</code>, |
| <code class="literal">commit</code>, <code class="literal">nontx-read</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A comma-separated list of events |
| when managed instances will be automatically detached. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.BrokerFactory"></a>5.3. |
| openjpa.BrokerFactory |
| </h3></div></div></div><a class="indexterm" name="d0e14557"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.BrokerFactory |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerFactory()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerFactory |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| BrokerFactory</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">jdbc</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">jdbc</code>, |
| <code class="literal">abstractstore</code>, <code class="literal">remote</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/BrokerFactory.html" target="_top"> |
| <code class="classname">org.apache.openjpa.kernel.BrokerFactory</code></a> type to |
| use. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.BrokerImpl"></a>5.4. |
| openjpa.BrokerImpl |
| </h3></div></div></div><a class="indexterm" name="d0e14619"></a><a class="indexterm" name="d0e14622"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.BrokerImpl |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerImpl()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerImpl |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| BrokerImpl</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">default</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/Broker.html" target="_top"><code class="classname"> |
| org.apache.openjpa.kernel.Broker</code></a> type to use at runtime. See |
| <a href="ref_guide_runtime.html#ref_guide_runtime_broker_extension" title="1.2. Broker Customization and Eviction">Section 1.2, “ |
| Broker Customization and Eviction |
| ”</a> on for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Callbacks"></a>5.5. openjpa.Callbacks</h3></div></div></div><a class="indexterm" name="d0e14674"></a><a class="indexterm" name="d0e14677"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Callbacks</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCallbackOptionsInstance()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getCallbackOptionsInstance</code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal">Callbacks</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">default</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) to fine tune some of the configurable |
| properties related to callbacks. The plug-in supports two boolean properties: |
| </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">PostPersistCallbackImmediate</code>: whether the |
| post-persist callback is invoked as soon as a new instance |
| is managed. The default is <code class="literal">false</code>, implies that |
| the post-persist callback is invoked after the instance been committed |
| or flushed to the datastore. |
| </p></li><li><p><code class="literal">AllowsMultipleMethodsForSameCallback</code>: whether |
| multiple methods of the same class can handle the same callback event. |
| Defaults to <code class="literal">false</code>. |
| </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ClassResolver"></a>5.6. |
| openjpa.ClassResolver |
| </h3></div></div></div><a class="indexterm" name="d0e14740"></a><a class="indexterm" name="d0e14743"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.ClassResolver |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getClassResolver()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getClassResolver |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ClassResolver</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">default</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/util/ClassResolver.html" target="_top"><code class="classname"> |
| org.apache.openjpa.util.ClassResolver</code></a> implementation to use |
| for class name resolution. You may wish to plug in your own resolver if you have |
| special classloading needs. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Compatibility"></a>5.7. |
| openjpa.Compatibility |
| </h3></div></div></div><a class="indexterm" name="d0e14793"></a><a class="indexterm" name="d0e14796"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Compatibility |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCompatibility()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getCompatibility |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Compatibility</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Encapsulates options to mimic the |
| behavior of previous OpenJPA releases. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionDriverName"></a>5.8. |
| openjpa.ConnectionDriverName |
| </h3></div></div></div><a class="indexterm" name="d0e14836"></a><a class="indexterm" name="d0e14839"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionDriverName</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionDriverName()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionDriverName |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionDriverName</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The full class name of either the |
| JDBC <code class="classname">java.sql.Driver</code>, or a <code class="classname"> |
| javax.sql.DataSource</code> implementation to use to connect to the |
| database. See <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Connection2DriverName"></a>5.9. |
| openjpa.Connection2DriverName |
| </h3></div></div></div><a class="indexterm" name="d0e14889"></a><a class="indexterm" name="d0e14892"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.Connection2DriverName</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2DriverName()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2DriverName |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Connection2DriverName</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionDriverName</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionDriverName" title="5.8. openjpa.ConnectionDriverName">Section 5.8, “ |
| openjpa.ConnectionDriverName |
| ”</a>, but applies to the |
| alternate connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactory"></a>5.10. |
| openjpa.ConnectionFactory |
| </h3></div></div></div><a class="indexterm" name="d0e14941"></a><a class="indexterm" name="d0e14944"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactory</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactory</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A <code class="classname">javax.sql.DataSource |
| </code> to use to connect to the database. See |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactory2"></a>5.11. |
| openjpa.ConnectionFactory2 |
| </h3></div></div></div><a class="indexterm" name="d0e14991"></a><a class="indexterm" name="d0e14994"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactory2</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2 |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactory2</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> An unmanaged <code class="classname"> |
| javax.sql.DataSource</code> to use to connect to the database. See |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactoryName"></a>5.12. |
| openjpa.ConnectionFactoryName |
| </h3></div></div></div><a class="indexterm" name="d0e15041"></a><a class="indexterm" name="d0e15044"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactoryName</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryName()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryName |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactoryName</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The JNDI location of a <code class="classname"> |
| javax.sql.DataSource</code> to use to connect to the database. See |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactory2Name"></a>5.13. |
| openjpa.ConnectionFactory2Name |
| </h3></div></div></div><a class="indexterm" name="d0e15091"></a><a class="indexterm" name="d0e15094"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactory2Name</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Name()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Name |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactory2Name</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The JNDI location of an unmanaged |
| <code class="classname">javax.sql.DataSource</code> to use to connect to the database. |
| See <a href="ref_guide_enterprise_xa.html" title="3. XA Transactions">Section 3, “ |
| XA Transactions |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactoryMode"></a>5.14. |
| openjpa.ConnectionFactoryMode |
| </h3></div></div></div><a class="indexterm" name="d0e15141"></a><a class="indexterm" name="d0e15144"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactoryMode</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryMode()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryMode |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactoryMode</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">local</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">local</code>, |
| <code class="literal">managed</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The connection factory mode to use |
| when integrating with the application server's managed transactions. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactoryProperties"></a>5.15. |
| openjpa.ConnectionFactoryProperties |
| </h3></div></div></div><a class="indexterm" name="d0e15200"></a><a class="indexterm" name="d0e15203"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactoryProperties</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryProperties()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryProperties |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactoryProperties</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) listing properties for |
| configuration of the datasource in use. See the |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionFactory2Properties"></a>5.16. |
| openjpa.ConnectionFactory2Properties |
| </h3></div></div></div><a class="indexterm" name="d0e15249"></a><a class="indexterm" name="d0e15252"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionFactory2Properties</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Properties()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Properties |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionFactory2Properties</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionFactoryProperties</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionFactoryProperties" title="5.15. openjpa.ConnectionFactoryProperties">Section 5.15, “ |
| openjpa.ConnectionFactoryProperties |
| ”</a>, but applies to the |
| alternate connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionPassword"></a>5.17. |
| openjpa.ConnectionPassword |
| </h3></div></div></div><a class="indexterm" name="d0e15301"></a><a class="indexterm" name="d0e15304"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionPassword</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionPassword()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionPassword |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionPassword</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The password for the user |
| specified in the <code class="literal">ConnectionUserName</code> property. See |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Connection2Password"></a>5.18. |
| openjpa.Connection2Password |
| </h3></div></div></div><a class="indexterm" name="d0e15351"></a><a class="indexterm" name="d0e15354"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.Connection2Password</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Password()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Password |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Connection2Password</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionPassword</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionPassword" title="5.17. openjpa.ConnectionPassword">Section 5.17, “ |
| openjpa.ConnectionPassword |
| ”</a>, but applies to the |
| alternate connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionProperties"></a>5.19. |
| openjpa.ConnectionProperties |
| </h3></div></div></div><a class="indexterm" name="d0e15403"></a><a class="indexterm" name="d0e15406"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionProperties</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionProperties()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionProperties |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionProperties</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) listing properties to configure |
| the driver listed in the <code class="literal">ConnectionDriverName</code> property |
| described below. See <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Connection2Properties"></a>5.20. |
| openjpa.Connection2Properties |
| </h3></div></div></div><a class="indexterm" name="d0e15455"></a><a class="indexterm" name="d0e15458"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.Connection2Properties</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Properties()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Properties |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Connection2Properties</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionProperties</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionProperties" title="5.19. openjpa.ConnectionProperties">Section 5.19, “ |
| openjpa.ConnectionProperties |
| ”</a>, but applies to the |
| alternate connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionURL"></a>5.21. |
| openjpa.ConnectionURL |
| </h3></div></div></div><a class="indexterm" name="d0e15507"></a><a class="indexterm" name="d0e15510"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.ConnectionURL |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionURL()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionURL |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionURL</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The JDBC URL for the database. See |
| <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Connection2URL"></a>5.22. |
| openjpa.Connection2URL |
| </h3></div></div></div><a class="indexterm" name="d0e15554"></a><a class="indexterm" name="d0e15557"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Connection2URL |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2URL()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2URL |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Connection2URL</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionURL</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionURL" title="5.21. openjpa.ConnectionURL">Section 5.21, “ |
| openjpa.ConnectionURL |
| ”</a>, but applies to the alternate |
| connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionUserName"></a>5.23. |
| openjpa.ConnectionUserName |
| </h3></div></div></div><a class="indexterm" name="d0e15606"></a><a class="indexterm" name="d0e15609"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionUserName</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionUserName()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionUserName |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionUserName</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The user name to use when |
| connecting to the database. See the <a href="ref_guide_dbsetup.html" title="Chapter 4. JDBC">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| JDBC |
| </i></a> |
| for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Connection2UserName"></a>5.24. |
| openjpa.Connection2UserName |
| </h3></div></div></div><a class="indexterm" name="d0e15653"></a><a class="indexterm" name="d0e15656"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.Connection2UserName</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2UserName()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2UserName |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Connection2UserName</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> This property is equivalent to the |
| <code class="literal">openjpa.ConnectionUserName</code> property described in |
| <a href="ref_guide_conf_openjpa.html#openjpa.ConnectionUserName" title="5.23. openjpa.ConnectionUserName">Section 5.23, “ |
| openjpa.ConnectionUserName |
| ”</a>, but applies to the |
| alternate connection factory used for unmanaged connections. See |
| <a href="ref_guide_dbsetup_thirdparty.html#ref_guide_dbsetup_thirdparty_enlist" title="2.1. Managed and XA DataSources">Section 2.1, “ |
| Managed and XA DataSources |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ConnectionRetainMode"></a>5.25. |
| openjpa.ConnectionRetainMode |
| </h3></div></div></div><a class="indexterm" name="d0e15705"></a><a class="indexterm" name="d0e15708"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.ConnectionRetainMode</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionRetainMode()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionRetainMode |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ConnectionRetainMode</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">on-demand</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Controls how OpenJPA uses |
| datastore connections. This property can also be specified for individual |
| sessions. See <a href="ref_guide_dbsetup_retain.html" title="8. Configuring the Use of JDBC Connections">Section 8, “ |
| Configuring the Use of JDBC Connections |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DataCache"></a>5.26. |
| openjpa.DataCache |
| </h3></div></div></div><a class="indexterm" name="d0e15754"></a><a class="indexterm" name="d0e15757"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.DataCache |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCache()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDataCache |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DataCache</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin list string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/datacache/DataCache.html" target="_top"><code class="classname"> |
| org.apache.openjpa.datacache.DataCache</code></a>s to use for data |
| caching. See <a href="ref_guide_caching.html#ref_guide_cache_conf" title="1.1. Data Cache Configuration">Section 1.1, “ |
| Data Cache Configuration |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DataCacheManager"></a>5.27. |
| openjpa.DataCacheManager |
| </h3></div></div></div><a class="indexterm" name="d0e15809"></a><a class="indexterm" name="d0e15812"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.DataCacheManager</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheManager()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheManager |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DataCacheManager</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">default</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/datacache/DataCacheManager.html" target="_top"> |
| <code class="classname">openjpa.datacache.DataCacheManager</code></a> that manages |
| the system data caches. See <a href="ref_guide_caching.html#ref_guide_cache" title="1. Data Cache">Section 1, “ |
| Data Cache |
| ”</a> for details |
| on data caching. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DataCacheMode"></a>5.28. |
| openjpa.DataCacheMode |
| </h3></div></div></div><a class="indexterm" name="d0e15865"></a><a class="indexterm" name="d0e15868"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.DataCacheMode</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheMode()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheMode |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DataCacheMode</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">DataCacheMode.UNSPECIFIED (see javadoc for details)</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span>Determines which entities will be included in the DataCache. May be any of the values defined in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/datacache/DataCacheMode.html" target="_top">../javadoc/org/apache/openjpa/datacache/DataCacheMode.html</a>. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DataCacheTimeout"></a>5.29. |
| openjpa.DataCacheTimeout |
| </h3></div></div></div><a class="indexterm" name="d0e15914"></a><a class="indexterm" name="d0e15917"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.DataCacheTimeout</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DataCacheTimeout</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">-1</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The number of milliseconds that |
| data in the data cache is valid. Set this to -1 to indicate that data should not |
| expire from the cache. This property can also be specified for individual |
| classes. See <a href="ref_guide_caching.html#ref_guide_cache_conf" title="1.1. Data Cache Configuration">Section 1.1, “ |
| Data Cache Configuration |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DetachState"></a>5.30. |
| openjpa.DetachState |
| </h3></div></div></div><a class="indexterm" name="d0e15963"></a><a class="indexterm" name="d0e15966"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.DetachState |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDetachState()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDetachState |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DetachState</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">loaded</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">loaded</code>, |
| <code class="literal">fetch-groups</code>, <code class="literal">all</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Determines which fields are part |
| of the detached graph and related options. For more details, see |
| <a href="ref_guide_remote.html#ref_guide_detach_graph" title="1.3. Defining the Detached Object Graph">Section 1.3, “ |
| Defining the Detached Object Graph |
| ”</a>. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DynamicDataStructs"></a>5.31. |
| openjpa.DynamicDataStructs |
| </h3></div></div></div><a class="indexterm" name="d0e16027"></a><a class="indexterm" name="d0e16030"></a><a class="indexterm" name="d0e16035"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.DynamicDataStructs</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicDataStructs()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicDataStructs |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| DynamicDataStructs</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether to dynamically generate |
| customized structs to hold persistent data. Both the OpenJPA data cache and the |
| remote framework rely on data structs to cache and transfer persistent state. |
| With dynamic structs, OpenJPA can customize data storage for each class, |
| eliminating the need to generate primitive wrapper objects. This saves memory |
| and speeds up certain runtime operations. The price is a longer warm-up time for |
| the application - generating and loading custom classes into the JVM takes time. |
| Therefore, only set this property to <code class="literal">true</code> if you have a |
| long-running application where the initial cost of class generation is offset by |
| memory and speed optimization over time. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.FetchBatchSize"></a>5.32. |
| openjpa.FetchBatchSize |
| </h3></div></div></div><a class="indexterm" name="d0e16082"></a><a class="indexterm" name="d0e16085"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.FetchBatchSize |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchBatchSize()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getFetchBatchSize |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| FetchBatchSize</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">-1</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The number of rows to fetch at |
| once when scrolling through a result set. The fetch size can also be set at |
| runtime. See <a href="ref_guide_dbsetup_lrs.html" title="10. Large Result Sets">Section 10, “ |
| Large Result Sets |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.EncryptionProvider"></a>5.33. |
| openjpa.EncryptionProvider |
| </h3></div></div></div><a class="indexterm" name="d0e16132"></a><a class="indexterm" name="d0e16135"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.EncryptionProvider</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getEncryptionProvider()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getEncryptionProvider</code> |
| </a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span> |
| <code class="literal">EncryptionProvider</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin list string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/lib/encryption/EncryptionProvider.html" target="_top"><code class="classname"> |
| org.apache.openjpa.lib.encryption.EncryptionProvider</code></a>s to use for connection password |
| encryption. See <a href="ref_guide_encryption.html" title="Chapter 11. Encryption Provider">Chapter 11, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| Encryption Provider |
| </i></a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.FetchGroups"></a>5.34. |
| openjpa.FetchGroups |
| </h3></div></div></div><a class="indexterm" name="d0e16188"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.FetchGroups |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchGroups()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getFetchGroups |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| FetchGroups</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A comma-separated list of fetch |
| group names that are to be loaded when retrieving objects from the datastore. |
| Fetch groups can also be set at runtime. See <a href="ref_guide_fetch.html" title="7. Fetch Groups">Section 7, “ |
| Fetch Groups |
| ”</a> |
| for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.FlushBeforeQueries"></a>5.35. |
| openjpa.FlushBeforeQueries |
| </h3></div></div></div><a class="indexterm" name="d0e16233"></a><a class="indexterm" name="d0e16236"></a><a class="indexterm" name="d0e16241"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.FlushBeforeQueries</code> |
| </p><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.FlushBeforeQueries</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFlushBeforeQueries()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getFlushBeforeQueries |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| FlushBeforeQueries</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether or not to flush any |
| changes made in the current transaction to the datastore before executing a |
| query. See <a href="ref_guide_dbsetup_retain.html" title="8. Configuring the Use of JDBC Connections">Section 8, “ |
| Configuring the Use of JDBC Connections |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.IgnoreChanges"></a>5.36. |
| openjpa.IgnoreChanges |
| </h3></div></div></div><a class="indexterm" name="d0e16294"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.IgnoreChanges |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getIgnoreChanges()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getIgnoreChanges |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| IgnoreChanges</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether to consider modifications |
| to persistent objects made in the current transaction when evaluating queries. |
| Setting this to <code class="literal">true</code> allows OpenJPA to ignore changes and |
| execute the query directly against the datastore. A value of <code class="literal">false |
| </code> forces OpenJPA to consider whether the changes in the current |
| transaction affect the query, and if so to either evaluate the query in-memory |
| or flush before running it against the datastore. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Id"></a>5.37. openjpa.Id</h3></div></div></div><a class="indexterm" name="d0e16342"></a><p> |
| <span class="bold"><strong>Property name:</strong></span> |
| <code class="literal">openjpa.Id</code> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property:</strong></span> |
| <code class="literal">Id</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> none |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> An |
| environment-specific identifier for this configuration. This |
| might correspond to a JPA persistence-unit name, or to some other |
| more-unique value available in the current environment. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.InitializeEagerly"></a>5.38. |
| openjpa.InitializeEagerly |
| </h3></div></div></div><a class="indexterm" name="d0e16374"></a><a class="indexterm" name="d0e16377"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.InitializeEagerly |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#isInitializeEagerly()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.isInitializeEagerly |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| InitializeEagerly</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">false</code>, |
| <code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Controls whether initialization |
| is eager or lazy. Eager initialization imply all persistent classes, their |
| mapping information, database connectivity and all other resources specified in |
| the configuration of a persistence unit will be initialized when a persistent |
| unit is constructed. The default behavior is |
| lazy i.e. persistent classes, database and other resources are initialized only |
| when the application refers to a resource for the first time. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.InverseManager"></a>5.39. |
| openjpa.InverseManager |
| </h3></div></div></div><a class="indexterm" name="d0e16431"></a><a class="indexterm" name="d0e16434"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.InverseManager |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInverseManager()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getInverseManager |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| InverseManager</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">false</code>, |
| <code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/InverseManager.html" target="_top"> |
| <code class="classname">org.apache.openjpa.kernel.InverseManager</code></a> to use |
| for managing bidirectional relations upon a flush. See |
| <a href="ref_guide_inverses.html" title="5. Managed Inverses">Section 5, “ |
| Managed Inverses |
| ”</a> for usage documentation. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.LockManager"></a>5.40. |
| openjpa.LockManager |
| </h3></div></div></div><a class="indexterm" name="d0e16497"></a><a class="indexterm" name="d0e16500"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.LockManager |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockManager()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getLockManager |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| LockManager</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">mixed</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">none</code>, |
| <code class="literal">sjvm</code>, <code class="literal">version</code>, |
| <code class="literal">pessimistic</code>, <code class="literal">mixed</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/LockManager.html" target="_top"><code class="classname"> |
| org.apache.openjpa.kernel.LockManager</code></a> to use for acquiring |
| locks on persistent instances during transactions. See |
| <a href="ref_guide_locking.html#ref_guide_locking_lockmgr" title="3.4. Lock Manager">Section 3.4, “ |
| Lock Manager |
| ”</a> for more information. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.LockTimeout"></a>5.41. |
| openjpa.LockTimeout |
| </h3></div></div></div><a class="indexterm" name="d0e16571"></a><a class="indexterm" name="d0e16574"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.LockTimeout |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockTimeout()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getLockTimeout |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| LockTimeout</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">-1</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The number of milliseconds to wait |
| for an object lock before throwing an exception, or -1 for no limit. See |
| <a href="ref_guide_locking.html" title="3. Object Locking">Section 3, “ |
| Object Locking |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Log"></a>5.42. |
| openjpa.Log |
| </h3></div></div></div><a class="indexterm" name="d0e16620"></a><a class="indexterm" name="d0e16623"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Log</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLog()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getLog</code> |
| </a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal">Log |
| </code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">openjpa</code>, |
| <code class="literal">commons</code>, <code class="literal">log4j</code>, <code class="literal">none</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/lib/log/LogFactory.html" target="_top"><code class="classname"> |
| org.apache.openjpa.lib.log.LogFactory</code></a> to use for logging. |
| For details on logging, see <a href="ref_guide_logging.html" title="Chapter 3. Logging">Chapter 3, <i xmlns:xlink="http://www.w3.org/1999/xlink"> |
| Logging |
| </i></a>. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ManagedRuntime"></a>5.43. |
| openjpa.ManagedRuntime |
| </h3></div></div></div><a class="indexterm" name="d0e16692"></a><a class="indexterm" name="d0e16695"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.ManagedRuntime |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getManagedRuntime()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getManagedRuntime |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ManagedRuntime</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">auto</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/ee/ManagedRuntime.html" target="_top"><code class="classname"> |
| org.apache.openjpa.ee.ManagedRuntime</code></a> implementation to use |
| for obtaining a reference to the <code class="classname">TransactionManager</code> in an |
| enterprise environment. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Mapping"></a>5.44. |
| openjpa.Mapping |
| </h3></div></div></div><a class="indexterm" name="d0e16750"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Mapping |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMapping()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getMapping</code> |
| </a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Mapping</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The symbolic name of the |
| object-to-datastore mapping to use. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.MaxFetchDepth"></a>5.45. |
| openjpa.MaxFetchDepth |
| </h3></div></div></div><a class="indexterm" name="d0e16791"></a><a class="indexterm" name="d0e16794"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.MaxFetchDepth |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMaxFetchDepth()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getMaxFetchDepth |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| MaxFetchDepth</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">-1</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The maximum depth of relations to |
| traverse when eager fetching. Use -1 for no limit. Defaults to no limit. See |
| <a href="ref_guide_perfpack_eager.html" title="8. Eager Fetching">Section 8, “ |
| Eager Fetching |
| ”</a> for details on eager fetching. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.MetaDataFactory"></a>5.46. |
| openjpa.MetaDataFactory |
| </h3></div></div></div><a class="indexterm" name="d0e16840"></a><a class="indexterm" name="d0e16843"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.MetaDataFactory |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataFactory()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataFactory |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| MetaDataFactory</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> <code class="literal">jpa</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/meta/MetaDataFactory.html" target="_top"> |
| <code class="classname">openjpa.meta.MetaDataFactory</code></a> to use to store and |
| retrieve metadata for your persistent classes. See |
| <a href="ref_guide_meta.html#ref_guide_meta_factory" title="1. Metadata Factory">Section 1, “ |
| Metadata Factory |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.MetaDataRepository"></a>5.47. |
| openjpa.MetaDataRepository |
| </h3></div></div></div><a class="indexterm" name="d0e16898"></a><a class="indexterm" name="d0e16901"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.MetaDataRepository |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataRepository()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataRepository |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| MetaDataRepository</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span>none<code class="literal"></code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/meta/MetaDataRepository.html" target="_top"> |
| <code class="classname">openjpa.meta.MetaDataRepository</code></a> to use to store and |
| retrieve metadata for your persistent classes. See |
| <a href="ref_guide_meta_repository.html" title="2. Metadata Repository">Section 2, “Metadata Repository”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Multithreaded"></a>5.48. |
| openjpa.Multithreaded |
| </h3></div></div></div><a class="indexterm" name="d0e16955"></a><a class="indexterm" name="d0e16958"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Multithreaded |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMultithreaded()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getMultithreaded |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Multithreaded</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether persistent instances and |
| OpenJPA components other than the <code class="classname">EntityManagerFactory</code> |
| will be accessed by multiple threads at once. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Optimistic"></a>5.49. |
| openjpa.Optimistic |
| </h3></div></div></div><a class="indexterm" name="d0e17005"></a><a class="indexterm" name="d0e17008"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Optimistic |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimistic()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getOptimistic |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Optimistic</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Selects between optimistic and |
| pessimistic (datastore) transactional modes. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.OrphanedKeyAction"></a>5.50. |
| openjpa.OrphanedKeyAction |
| </h3></div></div></div><a class="indexterm" name="d0e17052"></a><a class="indexterm" name="d0e17055"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.OrphanedKeyAction</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOrphanedKeyAction()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getOrphanedKeyAction |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| OrphanedKeyAction</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">log</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">log</code>, |
| <code class="literal">exception</code>, <code class="literal">none</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/event/OrphanedKeyAction.html" target="_top"> |
| <code class="classname">org.apache.openjpa.event.OrphanedKeyAction</code></a> to |
| invoke when OpenJPA discovers an orphaned datastore key. See |
| <a href="ref_guide_orphan.html" title="11. Orphaned Keys">Section 11, “ |
| Orphaned Keys |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.NontransactionalRead"></a>5.51. |
| openjpa.NontransactionalRead |
| </h3></div></div></div><a class="indexterm" name="d0e17121"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.NontransactionalRead</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalRead()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalRead |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| NontransactionalRead</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether the OpenJPA runtime will |
| allow you to read data outside of a transaction. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.NontransactionalWrite"></a>5.52. |
| openjpa.NontransactionalWrite |
| </h3></div></div></div><a class="indexterm" name="d0e17163"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.NontransactionalWrite</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalWrite()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalWrite |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| NontransactionalWrite</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> <code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether you can modify persistent |
| objects and perform persistence operations outside of a transaction. Changes |
| will take effect on the next transaction. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ProxyManager"></a>5.53. |
| openjpa.ProxyManager |
| </h3></div></div></div><a class="indexterm" name="d0e17206"></a><a class="indexterm" name="d0e17209"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.ProxyManager |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getProxyManager()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getProxyManager |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ProxyManager</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">default</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/util/ProxyManager.html" target="_top"><code class="classname"> |
| org.apache.openjpa.util.ProxyManager</code></a> to use for proxying |
| mutable second class objects. See |
| <a href="ref_guide_pc_scos.html#ref_guide_pc_scos_proxy_custom" title="6.4.3. Custom Proxies">Section 6.4.3, “ |
| Custom Proxies |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.QueryCache"></a>5.54. |
| openjpa.QueryCache |
| </h3></div></div></div><a class="indexterm" name="d0e17261"></a><a class="indexterm" name="d0e17264"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.QueryCache |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getQueryCache()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getQueryCache |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| QueryCache</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/datacache/QueryCache.html" target="_top"> |
| <code class="classname">org.apache.openjpa.datacache.QueryCache</code></a> |
| implementation to use for caching of queries loaded from the data store. See |
| <a href="ref_guide_caching.html#ref_guide_cache_query" title="1.4. Query Cache">Section 1.4, “ |
| Query Cache |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.QueryCompilationCache"></a>5.55. |
| openjpa.QueryCompilationCache |
| </h3></div></div></div><a class="indexterm" name="d0e17317"></a><a class="indexterm" name="d0e17320"></a><p> |
| <span class="bold"><strong>Property name:</strong></span> |
| <code class="literal">openjpa.QueryCompilationCache</code> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property:</strong></span> |
| <code class="literal">QueryCompilationCache</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> <code class="literal">true</code>. |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <code class="classname">java.util.Map</code> to use for caching of data used during |
| query compilation. See <a href="ref_guide_cache_querycomp.html" title="2. Query Compilation Cache">Section 2, “ |
| Query Compilation Cache |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.ReadLockLevel"></a>5.56. |
| openjpa.ReadLockLevel |
| </h3></div></div></div><a class="indexterm" name="d0e17364"></a><a class="indexterm" name="d0e17367"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.ReadLockLevel |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getReadLockLevel()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getReadLockLevel |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| ReadLockLevel</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">read</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">none</code>, |
| <code class="literal">read</code>, <code class="literal">write</code>, |
| <code class="literal">optimistic</code>, <code class="literal">optimistic-force-increment</code>, |
| <code class="literal">pessimistic-read</code>, <code class="literal">pessimistic-write</code>, |
| <code class="literal">pessimistic-force-increment</code>, numeric values for |
| lock-manager specific lock levels |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The default level at which to lock |
| objects retrieved during a non-optimistic transaction. Note that for the default |
| JDBC lock manager, <code class="literal"> read</code> and <code class="literal">write</code> lock |
| levels are equivalent. Lock levels <code class="literal">pessimistic-read</code>, |
| <code class="literal">pessimistic-write</code> and |
| <code class="literal">pessimistic-force-increment</code> are in effect only when the |
| <code class="literal">mixed</code> lock manager is used. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.RemoteCommitProvider"></a>5.57. |
| openjpa.RemoteCommitProvider |
| </h3></div></div></div><a class="indexterm" name="d0e17457"></a><a class="indexterm" name="d0e17460"></a><a class="indexterm" name="d0e17465"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.RemoteCommitProvider</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRemoteCommitProvider()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getRemoteCommitProvider |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| RemoteCommitProvider</code> |
| </p><p> |
| <span class="bold"><strong>Default:</strong></span> - |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/event/RemoteCommitProvider.html" target="_top"> |
| <code class="classname">org.apache.openjpa.event.RemoteCommitProvider</code></a> |
| implementation to use for distributed event notification. See |
| <a href="ref_guide_event.html#ref_guide_event_conf" title="2.1. Remote Commit Provider Configuration">Section 2.1, “ |
| Remote Commit Provider Configuration |
| ”</a> for more information. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.RestoreState"></a>5.58. |
| openjpa.RestoreState |
| </h3></div></div></div><a class="indexterm" name="d0e17516"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.RestoreState |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRestoreState()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getRestoreState |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| RestoreState</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">none</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">none</code>, |
| <code class="literal">immutable</code>, <code class="literal">all</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether to restore managed fields |
| to their pre-transaction values when a rollback occurs. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.RetainState"></a>5.59. |
| openjpa.RetainState |
| </h3></div></div></div><a class="indexterm" name="d0e17571"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.RetainState |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetainState()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getRetainState |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| RetainState</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">true</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Whether persistent fields retain |
| their values on transaction commit. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.RetryClassRegistration"></a>5.60. |
| openjpa.RetryClassRegistration |
| </h3></div></div></div><a class="indexterm" name="d0e17613"></a><a class="indexterm" name="d0e17616"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.RetryClassRegistration</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetryClassRegistration()" target="_top"> |
| <code class="methodname"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getRetryClassRegistration |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| RetryClassRegistration</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">false</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> Controls whether to log a warning |
| and defer registration instead of throwing an exception when a persistent class |
| cannot be fully processed. This property should <span class="emphasis"><em>only</em></span> be |
| used in complex classloader situations where security is preventing OpenJPA from |
| reading registered classes. Setting this to true unnecessarily may obscure more |
| serious problems. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.RuntimeUnenhancedClasses"></a>5.61. openjpa.RuntimeUnenhancedClasses</h3></div></div></div><p> |
| <span class="bold"><strong>Property name: </strong></span> |
| <code class="literal">openjpa.RuntimeUnenhancedClasses</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API: </strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRuntimeUnenhancedClasses()" target="_top">org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses</a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config property:</strong></span> |
| RuntimeUnenhancedClasses |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span> |
| <code class="literal">unsupported</code> |
| |
| </p><p> |
| <span class="bold"><strong>Possible values:</strong></span> |
| <code class="literal">supported</code>, |
| <code class="literal">unsupported</code>, |
| <code class="literal">warn</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> |
| The RuntimeUnenhancedClasses property controls how OpenJPA |
| handles classes that have not been enhanced by the PCEnhancer |
| tool or automatically by a javaagent. If RuntimeUnenhancedClasses is |
| set to <code class="literal">supported</code> OpenJPA will automatically |
| create subclasses for unenhanced entity classes. If set to |
| <code class="literal">unsupported</code> OpenJPA will not create subclasses |
| for unenhanced entity classes and will throw an exception when |
| they are detected. If set to <code class="literal">warn</code> OpenJPA |
| will not create subclasses for unenhanced entity classes |
| but will log a warning message. |
| </p><p> |
| This function is often useful for rapid prototyping but is not |
| <span class="italic">generally</span> |
| recommended for use in production. Please consult the reference guide |
| before changing the default value. |
| </p><p> |
| See the reference guide section on unenhanced types for more |
| information |
| <a href="ref_guide_pc_enhance.html#ref_guide_pc_enhance_unenhanced_types" title="2.5. Omitting the OpenJPA enhancer">Section 2.5, “ |
| Omitting the OpenJPA enhancer |
| ”</a> |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.DynamicEnhancementAgent"></a>5.62. openjpa.DynamicEnhancementAgent</h3></div></div></div><p> |
| <span class="bold"><strong>Property name: </strong></span> |
| <code class="literal">openjpa.DynamicEnhancementAgent</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API: </strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicEnhancementAgent()" target="_top">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent</a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config property:</strong></span> |
| DynamicEnhancementAgent |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span> |
| <code class="literal">true</code> |
| |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> |
| The DynamicEnhancementAgent property controls whether or not |
| OpenJPA will attempt to dynamically load the PCEnhancer |
| javaagent. |
| </p><p> |
| See the reference guide for more information |
| <a href="ref_guide_pc_enhance.html#ref_guide_pc_enhance_dynamic" title="2.4. Enhancing Dynamically at Runtime">Section 2.4, “ |
| Enhancing Dynamically at Runtime |
| ”</a> |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.SavepointManager"></a>5.63. |
| openjpa.SavepointManager |
| </h3></div></div></div><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal"> |
| openjpa.SavepointManager</code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSavepointManager()" target="_top"> |
| org.apache.openjpa.conf.OpenJPAConfiguration.getSavepointManager</a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property:</strong></span> |
| SavepointManager |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">in-mem</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">in-mem</code>, |
| <code class="literal">jdbc</code>, <code class="literal">oracle</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing a |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/SavepointManager.html" target="_top"> |
| <code class="classname">org.apache.openjpa.kernel.SavepointManager</code></a> to |
| use for managing transaction savepoints. See |
| <a href="ref_guide_savepoints.html" title="4. Savepoints">Section 4, “ |
| Savepoints |
| ”</a> for details. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Sequence"></a>5.64. |
| openjpa.Sequence |
| </h3></div></div></div><a class="indexterm" name="d0e17830"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Sequence |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSequence()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getSequence |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Sequence</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">table</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A plugin string (see |
| <a href="ref_guide_conf_plugins.html" title="4. Plugin Configuration">Section 4, “ |
| Plugin Configuration |
| ”</a>) describing the |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/kernel/Seq.html" target="_top"><code class="classname"> |
| org.apache.openjpa.kernel.Seq</code></a> implementation to use for the |
| system sequence. See <a href="ref_guide_sequence.html" title="6. Generators">Section 6, “ |
| Generators |
| ”</a> for more |
| information. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.Specification"></a>5.65. |
| openjpa.Specification |
| </h3></div></div></div><a class="indexterm" name="d0e17880"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.Specification |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSpecificationInstance()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getSpecificationInstance |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| Specification</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">table</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> A formatted string describing the Specification |
| to use for the default configuration options. The format of the Specifcation string is |
| <code class="literal">name [major.[minor]]</code> where <code class="literal">name</code> denotes the name of the |
| Specification such as <code class="literal">JPA</code> or <code class="literal">JDO</code>, <code class="literal">major</code> |
| denotes the major integral version number of the Specification and <code class="literal">minor</code> |
| denotes a minor version which can be an arbitrary string. |
| See <a href="ref_guide_conf_jdbc.html#ref_guide_spec_compatibility" title="6.20. Compatibility with Specification">Section 6.20, “Compatibility with Specification”</a> for more information. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.TransactionMode"></a>5.66. |
| openjpa.TransactionMode |
| </h3></div></div></div><a class="indexterm" name="d0e17942"></a><a class="indexterm" name="d0e17945"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.TransactionMode |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getTransactionMode()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getTransactionMode |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| TransactionMode</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">local</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">local</code>, |
| <code class="literal">managed</code> |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The default transaction mode to |
| use. You can override this setting per-session. |
| </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="openjpa.WriteLockLevel"></a>5.67. |
| openjpa.WriteLockLevel |
| </h3></div></div></div><a class="indexterm" name="d0e17999"></a><a class="indexterm" name="d0e18002"></a><p> |
| <span class="bold"><strong>Property name: </strong></span><code class="literal">openjpa.WriteLockLevel |
| </code> |
| </p><p> |
| <span class="bold"><strong>Configuration API:</strong></span> |
| <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getWriteLockLevel()" target="_top"> |
| <code class="methodname">org.apache.openjpa.conf.OpenJPAConfiguration.getWriteLockLevel |
| </code></a> |
| </p><p> |
| <span class="bold"><strong>Resource adaptor config-property: </strong></span><code class="literal"> |
| WriteLockLevel</code> |
| </p><p> |
| <span class="bold"><strong>Default: </strong></span><code class="literal">write</code> |
| </p><p> |
| <span class="bold"><strong>Possible values: </strong></span><code class="literal">none</code>, |
| <code class="literal">read</code>, <code class="literal">write</code>, |
| <code class="literal">optimistic</code>, <code class="literal">optimistic-force-increment</code>, |
| <code class="literal">pessimistic-read</code>, <code class="literal">pessimistic-write</code>, |
| <code class="literal">pessimistic-force-increment</code>, numeric values for |
| lock-manager specific lock levels. |
| </p><p> |
| <span class="bold"><strong>Description:</strong></span> The default level at which to lock |
| objects changed during a non-optimistic transaction. Note that for the default |
| JDBC lock manager, <code class="literal"> read</code> and <code class="literal">write</code> lock |
| levels are equivalent. Lock levels <code class="literal">pessimistic-read</code>, |
| <code class="literal">pessimistic-write</code> and |
| <code class="literal">pessimistic-force-increment</code> are in effect only when the |
| <code class="literal">mixed</code> lock manager is used. |
| </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ref_guide_conf_plugins.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref_guide_conf.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ref_guide_conf_jdbc.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4. |
| Plugin Configuration |
| </td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top"> 6. |
| OpenJPA JDBC Properties |
| </td></tr></table></div></body></html> |
