You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mp...@apache.org on 2006/08/22 23:28:55 UTC
svn commit: r433761 [10/18] - in /incubator/openjpa/trunk/openjpa-project:
./ src/doc/manual/
Added: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml?rev=433761&view=auto
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml (added)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml Tue Aug 22 14:28:53 2006
@@ -0,0 +1,2954 @@
+
+ <chapter id="ref_guide_conf">
+ <title>Configuration</title>
+ <indexterm>
+ <primary>configuration</primary>
+ </indexterm>
+ <section id="ref_guide_conf_intro">
+ <title>Introduction</title>
+ <para>
+ This chapter describes the OpenJPA configuration framework.
+ It concludes with descriptions of all the configuration properties
+ recognized by OpenJPA. You may want to browse these properties now,
+ but it is not necessary. Most of them will be referenced later in
+ the documentation as we explain the various features they apply to.
+ </para>
+ </section>
+ <section id="ref_guide_conf_specify">
+ <title>Runtime Configuration</title>
+ <indexterm zone="ref_guide_conf_specify">
+ <primary>configuration</primary>
+ <secondary>runtime</secondary>
+ </indexterm>
+ <para>
+ The OpenJPA runtime includes a comprehensive system of configuration
+ defaults and overrides:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para><indexterm><primary>openjpa.xml</primary></indexterm>
+ OpenJPA first looks for an optional <filename>openjpa.xml</filename>
+ resource. OpenJPA searches for this resource in each top-level
+ directory of your <literal>CLASSPATH</literal>. OpenJPA will also
+ find the resource if you place it within a <filename>META-INF
+ </filename> directory in any top-level directory of the
+ <literal>CLASSPATH</literal>. The <filename>openjpa.xml</filename>
+ resource contains property settings in
+ <link linkend="jpa_overview_persistence_xml">JPA's XML
+ format</link>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You can customize the name or location of the above resource
+ by specifying the correct resource path
+ in the <literal>openjpa.properties</literal> System property.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You can override any value defined in the above resource
+ by setting the System property of the same name to the desired
+ value.
+ </para>
+ </listitem>
+ <listitem>
+ <para><indexterm><primary>Persistence</primary><secondary>createEntityManagerFactory</secondary></indexterm>
+ In JPA, the values in the standard <filename>
+ META-INF/persistence.xml</filename> bootstrapping file
+ used by the <link linkend="jpa_overview_persistence"><classname>Persistence</classname></link> class at runtime
+ override the values in the above resource, as well as any
+ System property settings. The <classname>Map</classname>
+ passed to <methodname>Persistence.createEntityManagerFactory
+ </methodname> at runtime also overrides previous settings,
+ including properties defined in <filename>
+ persistence.xml</filename>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When using JCA deployment the <literal>config-property</literal>
+ values in your <filename>ra.xml</filename> file override other
+ settings.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ All OpenJPA command-line tools accept flags that allow you to
+ specify the configuration resource to use, and to override any
+ property. <xref linkend="ref_guide_conf_devtools"/>
+ describes these flags.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ Internally, the OpenJPA <phrase>JPA</phrase> runtime environment and
+ development tools manipulate property settings through
+ a general
+ <ulink url="../apidocs/ResultObjectProvider/lib/conf/Configuration.html"><classname>Configuration</classname></ulink> interface, and in
+ particular its
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html"><classname>OpenJPAConfiguration</classname></ulink> and
+ <ulink url="../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html"><classname>JDBCConfiguration</classname></ulink> subclasses.
+ For advanced customization, OpenJPA's extended runtime interfaces and
+ its development tools allow you to access these interfaces directly.
+ See the <ulink url="../javadoc">Javadoc</ulink> for details.
+ </para>
+ </note>
+ </section>
+ <section id="ref_guide_conf_devtools">
+ <title>Command Line Configuration</title>
+ <indexterm zone="ref_guide_conf_devtools">
+ <primary>configuration</primary>
+ <secondary>command line</secondary>
+ </indexterm>
+ <para>
+ OpenJPA development tools share the same set of configuration
+ defaults and overrides as the runtime system. They also allow you to
+ specify property values on the command line:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>-properties/-p <configuration file or resource>
+ </literal>: Use the <literal>-properties</literal> flag, or
+ its shorter <literal>-p</literal> form, to specify a
+ configuration file to use. Note that OpenJPA always searches the
+ default file locations described above, so this flag is only
+ needed when you do not have a default resource in place, or when
+ you wish to override the defaults. The given value can be
+ the path to a file, or the resource name of a file somewhere in
+ the <literal>CLASSPATH</literal>. OpenJPA will search the given
+ location as well as the location prefixed by <filename>
+ META-INF/</filename>. Thus, to point a OpenJPA tool at
+ <phrase><filename>META-INF/persistence.xml</filename>,
+ </phrase>
+
+ you can use:
+ </para>
+ <programlisting format="linespecific">
+<tool> -p persistence.xml
+</programlisting>
+ </listitem>
+ <listitem>
+ <para><literal>-<property name> <property value>
+ </literal>: Any configuration property that you can specify
+ in a configuration file can be overridden with a command line
+ flag. The flag name is always the last token of the
+ corresponding property name, with the first letter in either
+ upper or lower case. For example, to override the
+ <literal>openjpa.ConnectionUserName</literal> property,
+ you could pass the
+ <literal>-connectionUserName <value></literal> flag to
+ any tool. Values set this way override both the values in the
+ configuration file and values set via System properties.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <section id="ref_guide_conf_devtools_format">
+ <title>Code Formatting</title>
+ <indexterm zone="ref_guide_conf_devtools_format">
+ <primary>code formatting</primary>
+ </indexterm>
+ <para>
+ Some OpenJPA development tools generate Java code.
+ These tools share a common set of command-line flags for formatting
+ their output to match your coding style. All code formatting flags
+ can begin with either the <literal>codeFormat</literal> or
+ <literal>cf</literal> prefix.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>-codeFormat./-cf.tabSpaces <spaces>
+ </literal>: The number of spaces that make up a tab, or 0
+ to use tab characters. Defaults to using tab characters.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.spaceBeforeParen
+ <true/t | false/f></literal>: Whether or not to place
+ a space before opening parentheses on method calls, if
+ statements, loops, etc. Defaults to
+ <literal>false</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.spaceInParen
+ <true/t | false/f></literal>: Whether or not to place
+ a space within parentheses; i.e.
+ <literal>method( arg )</literal>. Defaults to
+ <literal>false</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.braceOnSameLine
+ <true/t | false/f></literal>: Whether or not to place
+ opening braces on the same line as the declaration that
+ begins the code block, or on the next line. Defaults to
+ <literal>true</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.braceAtSameTabLevel
+ <true/t | false/f></literal>: When the
+ <literal>braceOnSameLine</literal> option is disabled,
+ you can choose whether to place the brace at the same
+ tab level of the contained code. Defaults to
+ <literal>false</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.scoreBeforeFieldName
+ <true/t | false/f></literal>: Whether to prefix
+ an underscore to names of private member variables.
+ Defaults to <literal>false</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>-codeFormat./-cf.linesBetweenSections <lines>
+ </literal>: The number of lines to skip between sections of
+ code. Defaults to 2.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <example id="ref_guide_conf_devtools_format_ex">
+ <title>Code Formatting with the Reverse Mapping Tool</title>
+ <programlisting format="linespecific">
+reversemappingtool -cf.spaceBeforeParen true -cf.tabSpaces 4
+</programlisting>
+ </example>
+ </section>
+ </section>
+ <section id="ref_guide_conf_plugins">
+ <title>Plugin Configuration</title>
+ <indexterm zone="ref_guide_conf_plugins">
+ <primary>configuration</primary>
+ <secondary>plugins</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>plugins</primary>
+ <see>configuration</see>
+ </indexterm>
+ <para>
+ Because OpenJPA is a highly customizable environment, many
+ configuration properties relate to the creation and configuration of
+ system plugins. Plugin properties have a syntax very similar to that
+ of Java 5 annotations. They allow you to specify both what class to
+ use for the plugin and how to configure the public fields or bean
+ properties of the instantiated plugin instance. The easiest way to
+ describe the plugin syntax is by example:
+ </para>
+ <para>
+ OpenJPA has a pluggable L2 caching mechanism that is controlled by the
+ <literal>openjpa.DataCache</literal> configuration property.
+ Suppose that you have created a new class,
+ <classname>com.xyz.MyDataCache</classname>, that you want OpenJPA to
+ use for caching. You've made instances of
+ <literal>MyDataCache</literal> configurable via two methods,
+ <methodname>setCacheSize(int size)</methodname> and
+ <methodname>setRemoteHost(String host)</methodname>. The sample
+ below shows how you would tell OpenJPA to use an
+ instance of your custom plugin with a max size of 1000 and a remote
+ host of <literal>cacheserver</literal>.
+ </para>
+ <programlisting format="linespecific">
+<property name="openjpa.DataCache"
+ value="com.xyz.MyDataCache(CacheSize=1000, RemoteHost=cacheserver)"/>
+</programlisting>
+ <para>
+ As you can see, plugin properties take a class name, followed by
+ a comma-separated list of values for the plugin's public fields or
+ bean properties in parentheses. OpenJPA will match each named property
+ to a field or setter method in the instantiated plugin instance, and
+ set the field or invoke the method with the given value (after
+ converting the value to the right type,
+ of course). The first letter of the property names can be in either
+ upper or lower case. The following would also have been valid:
+ </para>
+ <programlisting format="linespecific">
+com.xyz.MyDataCache(cacheSize=1000, remoteHost=cacheserver)
+</programlisting>
+ <para>
+ If you do not need to pass any property settings to a plugin, you can
+ just name the class to use:
+ </para>
+ <programlisting format="linespecific">
+com.xyz.MyDataCache
+</programlisting>
+ <para>
+ Similarly, if the plugin has a default class that you do not want to
+ change, you can simply specify a list of property settings, without a
+ class name. For example, OpenJPA's query cache companion to the data cache
+ has a default implementation suitable to most users, but you still might
+ want to change the query cache's size. It has a <literal>CacheSize
+ </literal> property for this purpose:
+ </para>
+ <programlisting format="linespecific">
+CacheSize=1000
+</programlisting>
+ <para>
+ Finally, many of OpenJPA's built-in options for plugins have short alias
+ names that you can use in place of the full class name. The
+ data cache property, for example, has an available alias of
+ <literal>true</literal> for the standard cache implementation. The
+ property value simply becomes:
+ </para>
+ <programlisting format="linespecific">
+true
+</programlisting>
+ <para>
+ The standard cache implementation class also has a <literal>CacheSize
+ </literal> property, so to use the standard implementation and
+ configure the size, specify:
+ </para>
+ <programlisting format="linespecific">
+true(CacheSize=1000)
+</programlisting>
+ <para>
+ The remainder of this chapter reviews the set of configuration
+ properties OpenJPA recognizes.
+ </para>
+ </section>
+ <section id="ref_guide_conf_openjpa">
+ <title>OpenJPA Properties</title>
+ <indexterm zone="ref_guide_conf_openjpa">
+ <primary>configuration</primary>
+ <secondary>of OpenJPA properties</secondary>
+ </indexterm>
+ <para>
+ 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.
+ </para>
+ <section id="openjpa.AggregateListeners">
+ <title>openjpa.AggregateListeners</title>
+ <indexterm zone="openjpa.AggregateListeners">
+ <primary>AggregateListeners</primary>
+ </indexterm>
+ <indexterm zone="openjpa.AggregateListeners">
+ <primary>Query</primary>
+ <secondary>AggregateListeners</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.AggregateListeners</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAggregateListeners">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAggregateListeners</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>AggregateListeners</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis>-
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ A comma-separated list of plugin strings
+ (see <xref linkend="ref_guide_conf_plugins"/>) describing custom
+ <ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html"><classname>
+ org.apache.openjpa.jdbc.kernel.exps.JDBCAggregateListener</classname></ulink>s
+ to make available to all queries, in addition to the standard set of
+ listeners. See <xref linkend="ref_guide_enterprise_queryext"/> for
+ details on aggregate listeners.
+ </para>
+ </section>
+ <section id="openjpa.AutoClear">
+ <title>openjpa.AutoClear</title>
+ <indexterm zone="openjpa.AutoClear">
+ <primary>AutoClear</primary>
+ </indexterm>
+ <indexterm zone="openjpa.AutoClear">
+ <primary>transactions</primary>
+ <secondary>AutoClear</secondary>
+ <tertiary>AutoClear</tertiary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.AutoClear</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoClear">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAutoClear</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>AutoClear</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>datastore</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>datastore</literal>, <literal>all</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> When to automatically
+ clear instance state: on entering a datastore transaction, or on
+ entering any transaction.
+ </para>
+ </section>
+ <section id="openjpa.AutoDetach">
+ <title>openjpa.AutoDetach</title>
+ <indexterm zone="openjpa.AutoDetach">
+ <primary>AutoDetach</primary>
+ </indexterm>
+ <indexterm zone="openjpa.AutoDetach">
+ <primary>detach</primary>
+ <secondary>AutoDetach</secondary>
+ <tertiary>AutoDetach</tertiary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.AutoDetach</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoDetach">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAutoDetach</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>AutoDetach</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>close</literal>, <literal>commit</literal>,
+ <literal>nontx-read</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A comma-separated
+ list of events when managed instances will be automatically
+ detached.
+ </para>
+ </section>
+ <section id="openjpa.BrokerFactory">
+ <title>openjpa.BrokerFactory</title>
+ <indexterm zone="openjpa.BrokerFactory">
+ <primary>BrokerFactory</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.BrokerFactory</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerFactory">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerFactory</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>BrokerFactory</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>jdbc</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>jdbc</literal>, <literal>abstractstore</literal>,
+ <literal>remote</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the <ulink url="../apidocs/org/apache/openjpa/kernel/BrokerFactory.html"><classname>org.apache.openjpa.kernel.BrokerFactory</classname></ulink> type
+ to use.
+ </para>
+ </section>
+ <section id="openjpa.BrokerImpl">
+ <title>openjpa.BrokerImpl</title>
+ <indexterm zone="openjpa.BrokerImpl">
+ <primary>BrokerImpl</primary>
+ </indexterm>
+ <indexterm zone="openjpa.BrokerImpl">
+ <primary>Broker</primary>
+ <secondary>BrokerImpl</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.BrokerImpl</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerImpl">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerImpl</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>BrokerImpl</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>default</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>) describing the
+ <ulink url="../apidocs/org/apache/openjpa/kernel/Broker.html"><classname>
+ org.apache.openjpa.kernel.Broker</classname></ulink> type to use at runtime.
+ See <xref linkend="ref_guide_runtime_pmextension"/> on for details.
+ </para>
+ </section>
+ <section id="openjpa.ClassResolver">
+ <title>openjpa.ClassResolver</title>
+ <indexterm zone="openjpa.ClassResolver">
+ <primary>ClassResolver</primary>
+ </indexterm>
+ <indexterm>
+ <primary>class loading</primary>
+ <see>ClassResolver</see>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ClassResolver</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getClassResolver">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getClassResolver</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ClassResolver</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>default</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the <ulink url="../apidocs/org/apache/openjpa/util/ClassResolver.html"><classname>org.apache.openjpa.util.ClassResolver</classname></ulink>
+ implementation to use for class name resolution. You may wish to
+ plug in your own resolver if you have special classloading needs.
+ </para>
+ </section>
+ <section id="openjpa.Compatibility">
+ <title>openjpa.Compatibility</title>
+ <indexterm zone="openjpa.Compatibility">
+ <primary>Compatibility</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Compatibility">
+ <primary>backwards compatibility</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Compatibility</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCompatibility">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getCompatibility</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Compatibility</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Encapsulates options
+ to mimic the behavior of previous OpenJPA releases.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionDriverName">
+ <title>openjpa.ConnectionDriverName</title>
+ <indexterm zone="openjpa.ConnectionDriverName">
+ <primary>ConnectionDriverName</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionDriverName">
+ <primary>connections</primary>
+ <secondary>ConnectionDriverName</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionDriverName</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionDriverName">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionDriverName</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionDriverName</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The full class name
+ of either the JDBC <classname>java.sql.Driver</classname>, or
+ a <classname>javax.sql.DataSource</classname> implementation to
+ use to connect to the database. See
+ <xref linkend="ref_guide_dbsetup"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Connection2DriverName">
+ <title>openjpa.Connection2DriverName</title>
+ <indexterm zone="openjpa.Connection2DriverName">
+ <primary>Connection2DriverName</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Connection2DriverName">
+ <primary>connections</primary>
+ <secondary>Connection2DriverName</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Connection2DriverName</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2DriverName">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2DriverName</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Connection2DriverName</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the
+ <literal>openjpa.ConnectionDriverName</literal> property described in
+ <xref linkend="openjpa.ConnectionDriverName"/>, but applies to the
+ alternate connection factory used for unmanaged connections.
+ See <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for
+ details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactory">
+ <title>openjpa.ConnectionFactory</title>
+ <indexterm zone="openjpa.ConnectionFactory">
+ <primary>ConnectionFactory</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactory">
+ <primary>connections</primary>
+ <secondary>ConnectionFactory</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactory</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactory</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A
+ <classname>javax.sql.DataSource</classname> to use to
+ connect to the database. See <xref linkend="ref_guide_dbsetup"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactory2">
+ <title>openjpa.ConnectionFactory2</title>
+ <indexterm zone="openjpa.ConnectionFactory2">
+ <primary>ConnectionFactory2</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactory2">
+ <primary>connections</primary>
+ <secondary>ConnectionFactory2</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactory2</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactory2</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> An unmanaged
+ <classname>javax.sql.DataSource</classname> to use to
+ connect to the database. See <xref linkend="ref_guide_dbsetup"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactoryName">
+ <title>openjpa.ConnectionFactoryName</title>
+ <indexterm zone="openjpa.ConnectionFactoryName">
+ <primary>ConnectionFactoryName</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactoryName">
+ <primary>connections</primary>
+ <secondary>ConnectionFactoryName</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactoryName</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryName">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryName</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactoryName</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The JNDI location
+ of a <classname>javax.sql.DataSource</classname> to use to
+ connect to the database. See <xref linkend="ref_guide_dbsetup"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactory2Name">
+ <title>openjpa.ConnectionFactory2Name</title>
+ <indexterm zone="openjpa.ConnectionFactory2Name">
+ <primary>ConnectionFactory2Name</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactory2Name">
+ <primary>connections</primary>
+ <secondary>ConnectionFactory2Name</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactory2Name</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Name">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Name</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactory2Name</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ The JNDI location of an unmanaged <classname>javax.sql.DataSource
+ </classname> to use to connect to the database.
+ See <xref linkend="ref_guide_enterprise_xa"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactoryMode">
+ <title>openjpa.ConnectionFactoryMode</title>
+ <indexterm zone="openjpa.ConnectionFactoryMode">
+ <primary>ConnectionFactoryMode</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactoryMode">
+ <primary>connections</primary>
+ <secondary>ConnectionFactoryMode</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactoryMode</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryMode">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryMode</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactoryMode</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>local</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>local</literal>, <literal>managed</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> The connection
+ factory mode to use when integrating with the application server's
+ managed transactions. See
+ <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactoryProperties">
+ <title>openjpa.ConnectionFactoryProperties</title>
+ <indexterm zone="openjpa.ConnectionFactoryProperties">
+ <primary>ConnectionFactoryProperties</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactoryProperties">
+ <primary>connections</primary>
+ <secondary>ConnectionFactoryProperties</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactoryProperties</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryProperties">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryProperties</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactoryProperties</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>) listing
+ properties for configuration of the <classname>javax.sql.DataSource
+ </classname> in use. See the <xref linkend="ref_guide_dbsetup"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionFactory2Properties">
+ <title>openjpa.ConnectionFactory2Properties</title>
+ <indexterm zone="openjpa.ConnectionFactory2Properties">
+ <primary>ConnectionFactory2Properties</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionFactory2Properties">
+ <primary>connections</primary>
+ <secondary>ConnectionFactory2Properties</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionFactory2Properties</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Properties">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Properties</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionFactory2Properties</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the
+ <literal>openjpa.ConnectionFactoryProperties</literal> property
+ described in <xref linkend="openjpa.ConnectionFactoryProperties"/>,
+ but applies to the alternate connection factory used for
+ unmanaged connections. See
+ <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionPassword">
+ <title>openjpa.ConnectionPassword</title>
+ <indexterm zone="openjpa.ConnectionPassword">
+ <primary>ConnectionPassword</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionPassword">
+ <primary>connections</primary>
+ <secondary>ConnectionPassword</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionPassword</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionPassword">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionPassword</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionPassword</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The password for
+ the user specified in the <literal>ConnectionUserName</literal>
+ property. See <xref linkend="ref_guide_dbsetup"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Connection2Password">
+ <title>openjpa.Connection2Password</title>
+ <indexterm zone="openjpa.Connection2Password">
+ <primary>Connection2Password</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Connection2Password">
+ <primary>connections</primary>
+ <secondary>Connection2Password</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Connection2Password</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Password">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Password</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Connection2Password</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the <literal>openjpa.ConnectionPassword
+ </literal> property described in
+ <xref linkend="openjpa.ConnectionPassword"/>, but applies to the
+ alternate connection factory used for unmanaged connections.
+ See <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for
+ details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionProperties">
+ <title>openjpa.ConnectionProperties</title>
+ <indexterm zone="openjpa.ConnectionProperties">
+ <primary>ConnectionProperties</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionProperties">
+ <primary>connections</primary>
+ <secondary>ConnectionProperties</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionProperties</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionProperties">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionProperties</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionProperties</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string (see
+ <xref linkend="ref_guide_conf_plugins"/>) listing properties to
+ configure the driver listed in the <literal>ConnectionDriverName
+ </literal> property described below. See
+ <xref linkend="ref_guide_dbsetup"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Connection2Properties">
+ <title>openjpa.Connection2Properties</title>
+ <indexterm zone="openjpa.Connection2Properties">
+ <primary>Connection2Properties</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Connection2Properties">
+ <primary>connections</primary>
+ <secondary>Connection2Properties</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Connection2Properties</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Properties">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Properties</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Connection2Properties</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the
+ <literal>openjpa.ConnectionProperties</literal> property
+ described in <xref linkend="openjpa.ConnectionProperties"/>,
+ but applies to the alternate connection factory used for
+ unmanaged connections. See
+ <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionURL">
+ <title>openjpa.ConnectionURL</title>
+ <indexterm zone="openjpa.ConnectionURL">
+ <primary>ConnectionURL</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionURL">
+ <primary>connections</primary>
+ <secondary>ConnectionURL</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionURL</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionURL">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionURL</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionURL</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The JDBC URL
+ for the database. See <xref linkend="ref_guide_dbsetup"/> for
+ details.
+ </para>
+ </section>
+ <section id="openjpa.Connection2URL">
+ <title>openjpa.Connection2URL</title>
+ <indexterm zone="openjpa.Connection2URL">
+ <primary>Connection2URL</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Connection2URL">
+ <primary>connections</primary>
+ <secondary>Connection2URL</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Connection2URL</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2URL">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2URL</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Connection2URL</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the
+ <literal>openjpa.ConnectionURL</literal> property
+ described in <xref linkend="openjpa.ConnectionURL"/>,
+ but applies to the alternate connection factory used for
+ unmanaged connections. See
+ <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionUserName">
+ <title>openjpa.ConnectionUserName</title>
+ <indexterm zone="openjpa.ConnectionUserName">
+ <primary>ConnectionUserName</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionUserName">
+ <primary>connections</primary>
+ <secondary>ConnectionUserName</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionUserName</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionUserName">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionUserName</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionUserName</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The user name to
+ use when connecting to the database. See the
+ <xref linkend="ref_guide_dbsetup"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Connection2UserName">
+ <title>openjpa.Connection2UserName</title>
+ <indexterm zone="openjpa.Connection2UserName">
+ <primary>Connection2UserName</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Connection2UserName">
+ <primary>connections</primary>
+ <secondary>Connection2UserName</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Connection2UserName</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2UserName">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2UserName</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Connection2UserName</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ This property is equivalent to the
+ <literal>openjpa.ConnectionUserName</literal> property
+ described in <xref linkend="openjpa.ConnectionUserName"/>,
+ but applies to the alternate connection factory used for
+ unmanaged connections. See
+ <xref linkend="ref_guide_dbsetup_thirdparty_enlist"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.ConnectionRetainMode">
+ <title>openjpa.ConnectionRetainMode</title>
+ <indexterm zone="openjpa.ConnectionRetainMode">
+ <primary>ConnectionRetainMode</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ConnectionRetainMode">
+ <primary>connections</primary>
+ <secondary>ConnectionRetainMode</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ConnectionRetainMode</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionRetainMode">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionRetainMode</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ConnectionRetainMode</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>on-demand</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Controls how OpenJPA
+ uses datastore connections. This property can also be specified
+ for individual sessions. See
+ <xref linkend="ref_guide_dbsetup_retain"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.DataCache">
+ <title>openjpa.DataCache</title>
+ <indexterm zone="openjpa.DataCache">
+ <primary>DataCache</primary>
+ </indexterm>
+ <indexterm zone="openjpa.DataCache">
+ <primary>caching</primary>
+ <secondary>DataCache</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.DataCache</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCache">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCache</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>DataCache</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin list string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the <ulink url="../apidocs/org/apache/openjpa/datacache/DataCache.html"><classname>org.apache.openjpa.datacache.DataCache</classname></ulink>s to
+ use for data caching. See <xref linkend="ref_guide_cache_conf"/>
+ for details.
+ </para>
+ </section>
+ <section id="openjpa.DataCacheManager">
+ <title>openjpa.DataCacheManager</title>
+ <indexterm zone="openjpa.DataCacheManager">
+ <primary>DataCacheManager</primary>
+ </indexterm>
+ <indexterm zone="openjpa.DataCacheManager">
+ <primary>caching</primary>
+ <secondary>DataCacheManager</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.DataCacheManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheManager">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheManager
+ </methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>DataCacheManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>default</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the
+ <ulink url="../apidocs/org/apache/openjpa/datacache/DataCacheManager.html"><classname>openjpa.datacache.DataCacheManager</classname></ulink> that
+ manages the system data caches. See
+ <xref linkend="ref_guide_cache"/> for details on data caching.
+ </para>
+ </section>
+ <section id="openjpa.DataCacheTimeout">
+ <title>openjpa.DataCacheTimeout</title>
+ <indexterm zone="openjpa.DataCacheTimeout">
+ <primary>DataCacheTimeout</primary>
+ </indexterm>
+ <indexterm zone="openjpa.DataCacheTimeout">
+ <primary>caching</primary>
+ <secondary>DataCacheTimeout</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.DataCacheTimeout</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>DataCacheTimeout</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>-1</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> 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 <xref linkend="ref_guide_cache_conf"/> for
+ details.
+ </para>
+ </section>
+ <section id="openjpa.DetachState">
+ <title>openjpa.DetachState</title>
+ <indexterm zone="openjpa.AutoDetach">
+ <primary>DetachState</primary>
+ </indexterm>
+ <indexterm zone="openjpa.AutoDetach">
+ <primary>detach</primary>
+ <secondary>DetachState</secondary>
+ <tertiary>DetachState</tertiary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.DetachState</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDetachState">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDetachState</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>DetachState</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>loaded</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>loaded</literal>, <literal>fgs</literal>,
+ <literal>all</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> Determines which
+ fields are part of the detached graph and related options. For
+ more details, see <xref linkend="ref_guide_detach_graph"/>.
+ </para>
+ </section>
+ <section id="openjpa.DynamicDataStructs">
+ <title>openjpa.DynamicDataStructs</title>
+ <indexterm zone="openjpa.DynamicDataStructs">
+ <primary>DynamicDataStructs</primary>
+ </indexterm>
+ <indexterm zone="openjpa.DynamicDataStructs">
+ <primary>caching</primary>
+ <secondary>DynamicDataStructs</secondary>
+ </indexterm>
+ <indexterm zone="openjpa.DynamicDataStructs">
+ <primary>remote</primary>
+ <secondary>DynamicDataStructs</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.DynamicDataStructs</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicDataStructs">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicDataStructs</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>DynamicDataStructs</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> 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
+ <literal>true</literal> if you have a long-running application where
+ the initial cost of class generation is offset by memory
+ and speed optimization over time.
+ </para>
+ </section>
+ <section id="openjpa.FetchBatchSize">
+ <title>openjpa.FetchBatchSize</title>
+ <indexterm zone="openjpa.FetchBatchSize">
+ <primary>FetchBatchSize</primary>
+ </indexterm>
+ <indexterm zone="openjpa.FetchBatchSize">
+ <primary>large result sets</primary>
+ <secondary>FetchBatchSize</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.FetchBatchSize</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchBatchSize">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFetchBatchSize</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>FetchBatchSize</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>-1</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The number of
+ rows to fetch at once when scrolling through a result set. The
+ fetch size can also be set at runtime.
+ See <xref linkend="ref_guide_dbsetup_lrs"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.FetchGroups">
+ <title>openjpa.FetchGroups</title>
+ <indexterm zone="openjpa.FetchGroups">
+ <primary>fetch groups</primary>
+ <secondary>FetchGroups</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.FetchGroups</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchGroups">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFetchGroups</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>FetchGroups</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> 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 <xref linkend="ref_guide_fetch"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.FilterListeners">
+ <title>openjpa.FilterListeners</title>
+ <indexterm zone="openjpa.FilterListeners">
+ <primary>FilterListeners</primary>
+ </indexterm>
+ <indexterm zone="openjpa.FilterListeners">
+ <primary>Query</primary>
+ <secondary>FilterListeners</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.FilterListeners</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFilterListeners">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFilterListeners</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>FilterListeners</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A comma-separated
+ list of full plugin strings (see
+ <xref linkend="ref_guide_conf_plugins"/>) for custom
+ <ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html"><classname>
+ org.apache.openjpa.jdbc.kernel.exps.JDBCFilterListener</classname></ulink>s
+ to make available to all queries, in addition
+ to the standard set of listeners. You can also add filter
+ listeners to individual queries. See
+ <xref linkend="ref_guide_enterprise_queryext"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.FlushBeforeQueries">
+ <title>openjpa.FlushBeforeQueries</title>
+ <indexterm zone="openjpa.FlushBeforeQueries">
+ <primary>FlushBeforeQueries</primary>
+ </indexterm>
+ <indexterm zone="openjpa.FlushBeforeQueries">
+ <primary>Query</primary>
+ <secondary>FlushBeforeQueries</secondary>
+ </indexterm>
+ <indexterm zone="openjpa.FlushBeforeQueries">
+ <primary>flush</primary>
+ <secondary>FlushBeforeQueries</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.FlushBeforeQueries</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.FlushBeforeQueries</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFlushBeforeQueries">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFlushBeforeQueries</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>FlushBeforeQueries</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>true</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Whether or not to
+ flush any changes made in the current transaction to the datastore
+ before executing a query. See
+ <xref linkend="ref_guide_dbsetup_retain"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.IgnoreChanges">
+ <title>openjpa.IgnoreChanges</title>
+ <indexterm zone="openjpa.IgnoreChanges">
+ <primary>IgnoreChanges</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.IgnoreChanges</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getIgnoreChanges">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getIgnoreChanges</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>IgnoreChanges</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Whether to consider
+ modifications to persistent objects made in the current transaction
+ when evaluating queries. Setting this to <literal>true</literal>
+ allows OpenJPA to ignore changes and execute the query
+ directly against the datastore. A value of <literal>false</literal>
+ 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.
+ </para>
+ </section>
+ <section id="openjpa.InverseManager">
+ <title>openjpa.InverseManager</title>
+ <indexterm zone="openjpa.InverseManager">
+ <primary>InverseManager</primary>
+ </indexterm>
+ <indexterm zone="openjpa.InverseManager">
+ <primary>bidirectional relation</primary>
+ <secondary>InverseManager</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.InverseManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInverseManager">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getInverseManager</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>InverseManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>false</literal>, <literal>true</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing a <ulink url="../apidocs/org/apache/openjpa/kernel/InverseManager.html"><classname>org.apache.openjpa.kernel.InverseManager</classname></ulink>
+ to use for managing bidirectional relations upon a flush.
+ See <xref linkend="ref_guide_inverses"/> for usage documentation.
+ </para>
+ </section>
+ <section id="openjpa.LockManager">
+ <title>openjpa.LockManager</title>
+ <indexterm zone="openjpa.LockManager">
+ <primary>LockManager</primary>
+ </indexterm>
+ <indexterm zone="openjpa.LockManager">
+ <primary>locking</primary>
+ <secondary>LockManager</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.LockManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockManager">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getLockManager</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>LockManager</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>pessimistic</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>none</literal>, <literal>sjvm</literal>,
+ <literal>pessimistic</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing a <ulink url="../apidocs/org/apache/openjpa/kernel/LockManager.html"><classname>org.apache.openjpa.kernel.LockManager</classname></ulink>
+ to use for acquiring locks on persistent instances
+ during transactions.
+ </para>
+ </section>
+ <section id="openjpa.LockTimeout">
+ <title>openjpa.LockTimeout</title>
+ <indexterm zone="openjpa.LockTimeout">
+ <primary>LockTimeout</primary>
+ </indexterm>
+ <indexterm zone="openjpa.LockTimeout">
+ <primary>locking</primary>
+ <secondary>LockTimeout</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.LockTimeout</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockTimeout">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getLockTimeout</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>LockTimeout</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>-1</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The number of
+ milliseconds to wait for an object lock before throwing an
+ exception, or -1 for no limit. See
+ <xref linkend="ref_guide_locking"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Log">
+ <title>openjpa.Log</title>
+ <indexterm zone="openjpa.Log">
+ <primary>Log</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Log">
+ <primary>logging</primary>
+ <secondary>Log</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Log</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLog">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getLog</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Log</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>true</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>openjpa</literal>, <literal>commons</literal>,
+ <literal>log4j</literal>, <literal>none</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin
+ string (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing a
+ <ulink url="../apidocs/org/apache/openjpa/lib/log/LogFactory.html"><classname>org.apache.openjpa.lib.log.LogFactory</classname></ulink>
+ to use for logging. For details on logging,
+ see <xref linkend="ref_guide_logging"/>.
+ </para>
+ </section>
+ <section id="openjpa.ManagedRuntime">
+ <title>openjpa.ManagedRuntime</title>
+ <indexterm zone="openjpa.ManagedRuntime">
+ <primary>ManagedRuntime</primary>
+ </indexterm>
+ <indexterm zone="openjpa.ManagedRuntime">
+ <primary>transactions</primary>
+ <secondary>managed</secondary>
+ <tertiary>ManagedRuntime</tertiary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.ManagedRuntime</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getManagedRuntime">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getManagedRuntime</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>ManagedRuntime</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>auto</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the
+ <ulink url="../apidocs/org/apache/openjpa/ee/ManagedRuntime.html"><classname>org.apache.openjpa.ee.ManagedRuntime</classname></ulink> implementation to use for obtaining a reference to the
+ <classname>TransactionManager</classname> in an enterprise
+ environment.
+ </para>
+ </section>
+ <section id="openjpa.Mapping">
+ <title>openjpa.Mapping</title>
+ <indexterm zone="openjpa.Mapping">
+ <primary>Mapping</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Mapping</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMapping">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMapping</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Mapping</literal>
+ </para>
+ <para><emphasis role="bold">Default:</emphasis> -
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The symbolic name
+ of the object-to-datastore mapping to use.
+ </para>
+ </section>
+ <section id="openjpa.MaxFetchDepth">
+ <title>openjpa.MaxFetchDepth</title>
+ <indexterm zone="openjpa.MaxFetchDepth">
+ <primary>MaxFetchDepth</primary>
+ </indexterm>
+ <indexterm zone="openjpa.MaxFetchDepth">
+ <primary>eager fetching</primary>
+ <secondary>MaxFetchDepth</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.MaxFetchDepth</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMaxFetchDepth">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMaxFetchDepth</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>MaxFetchDepth</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>1</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> The maximum
+ depth of relations to traverse when eager fetching. Use -1 for no limit.
+ Defaults to 1.
+ </para>
+ </section>
+ <section id="openjpa.MetaDataFactory">
+ <title>openjpa.MetaDataFactory</title>
+ <indexterm zone="openjpa.MetaDataFactory">
+ <primary>MetaDataFactory</primary>
+ </indexterm>
+ <indexterm zone="openjpa.MetaDataFactory">
+ <primary>metadata</primary>
+ <secondary>MetaDataFactory</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.MetaDataFactory</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataFactory">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataFactory</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>MetaDataFactory</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>jdo</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>jdo</literal>, <literal>jpa</literal>,
+ <literal>openjpa3</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing the <ulink url="../apidocs/org/apache/openjpa/meta/MetaDataFactory.html"><classname>openjpa.meta.MetaDataFactory</classname></ulink> to
+ use to store and retrieve metadata for your persistent classes. See
+ <xref linkend="ref_guide_meta_factory"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.Multithreaded">
+ <title>openjpa.Multithreaded</title>
+ <indexterm zone="openjpa.Multithreaded">
+ <primary>Multithreaded</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Multithreaded">
+ <primary>threading</primary>
+ <secondary>Multithreaded</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Multithreaded</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMultithreaded">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMultithreaded</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Multithreaded</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis>
+ Whether persistent instances and OpenJPA components will be accessed
+ by multiple threads at once.
+ </para>
+ </section>
+ <section id="openjpa.Optimistic">
+ <title>openjpa.Optimistic</title>
+ <indexterm zone="openjpa.Optimistic">
+ <primary>Optimistic</primary>
+ </indexterm>
+ <indexterm zone="openjpa.Optimistic">
+ <primary>transactions</primary>
+ <secondary>optimistic</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.Optimistic</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimistic">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getOptimistic</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>Optimistic</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>true</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Selects between
+ optimistic and pessimistic (datastore) transactional modes.
+ </para>
+ </section>
+ <section id="openjpa.OrphanedKeyAction">
+ <title>openjpa.OrphanedKeyAction</title>
+ <indexterm zone="openjpa.OrphanedKeyAction">
+ <primary>OrphanedKeyAction</primary>
+ </indexterm>
+ <indexterm zone="openjpa.OrphanedKeyAction">
+ <primary>foreign keys</primary>
+ <secondary>OrphanedKeyAction</secondary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.OrphanedKeyAction</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOrphanedKeyAction">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getOrphanedKeyAction</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>OrphanedKeyAction</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>log</literal>
+ </para>
+ <para><emphasis role="bold">Possible values:</emphasis><literal>log</literal>, <literal>exception</literal>,
+ <literal>none</literal></para>
+ <para><emphasis role="bold">Description:</emphasis> A plugin string
+ (see <xref linkend="ref_guide_conf_plugins"/>)
+ describing a <ulink url="../apidocs/org/apache/openjpa/event/OrphanedKeyAction.html"><classname>org.apache.openjpa.event.OrphanedKeyAction</classname></ulink>
+ to invoke when OpenJPA discovers an orphaned datastore key.
+ See <xref linkend="ref_guide_orphan"/> for details.
+ </para>
+ </section>
+ <section id="openjpa.NontransactionalRead">
+ <title>openjpa.NontransactionalRead</title>
+ <indexterm zone="openjpa.NontransactionalRead">
+ <primary>NontransactionalRead</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.NontransactionalRead</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalRead">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalRead</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>NontransactionalRead</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>true</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Whether the OpenJPA
+ runtime will allow you to read data outside of a transaction.
+ </para>
+ </section>
+ <section id="openjpa.NontransactionalWrite">
+ <title>openjpa.NontransactionalWrite</title>
+ <indexterm zone="openjpa.NontransactionalWrite">
+ <primary>NontransactionalWrite</primary>
+ </indexterm>
+ <para>
+ <emphasis role="bold">Property name:</emphasis>
+ <literal>openjpa.NontransactionalWrite</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API:</emphasis>
+ <ulink url="../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalWrite">
+ <methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalWrite</methodname>
+ </ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config-property:</emphasis>
+ <literal>NontransactionalWrite</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>
+ <literal>false</literal>
+ </para>
+ <para><emphasis role="bold">Description:</emphasis> Whether you can
+ modify persistent objects and perform persistence operations outside
+ of a transaction. Changes will take effect on the next transaction.
+ </para>
+ </section>
+ <section id="openjpa.ProxyManager">
+ <title>openjpa.ProxyManager</title>
+ <indexterm zone="openjpa.ProxyManager">
[... 1038 lines stripped ...]