You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mi...@apache.org on 2008/09/18 01:19:17 UTC
svn commit: r696510 - in
/openjpa/branches/1.2.x/openjpa-project/src/doc/manual: ref_guide_conf.xml
ref_guide_pc.xml
Author: mikedd
Date: Wed Sep 17 16:19:16 2008
New Revision: 696510
URL: http://svn.apache.org/viewvc?rev=696510&view=rev
Log:
OPENJPA-650 adding documentation for openjpa.RuntimeUnenhancedClasses
Modified:
openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml
openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml
Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml?rev=696510&r1=696509&r2=696510&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml Wed Sep 17 16:19:16 2008
@@ -2753,6 +2753,50 @@
serious problems.
</para>
</section>
+ <section id="openjpa.RuntimeUnenhancedClasses">
+ <title>openjpa.RuntimeUnenhancedClasses</title>
+ <para>
+ <emphasis role="bold">Property name: </emphasis>
+ <literal>openjpa.RuntimeUnenhancedClasses</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Configuration API: </emphasis>
+ <ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRuntimeUnenhancedClasses()">org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses</ulink>
+ </para>
+ <para>
+ <emphasis role="bold">Resource adaptor config property:</emphasis>
+ RuntimeUnenhancedClasses
+ </para>
+ <para>
+ <emphasis role="bold">Default: </emphasis>
+ <literal>supported</literal>
+
+ </para>
+ <para>
+ <emphasis role="bold">Possible values:</emphasis>
+ <literal>supported</literal>,
+ <literal>unsupported</literal>,
+ <literal>warn</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Description:</emphasis>
+ The RuntimeUnenhancedClasses property controls how OpenJPA
+ handles classes that have not been enhanced byt the PCEnhancer
+ tool or automatically by a javaagent. If RuntimeUnenhanced is
+ set to <literal>supported</literal> OpenJPA will automatically
+ create subclasses for unenhanced entity classes. If set to
+ <literal>unsupported</literal>OpenJPA will not create subclasses
+ for unenhanced entity classes and will throw an exception when
+ they are detected. If set to <literal>warn</literal> OpenJPA
+ will not create subclasses for unenhanced entity classes
+ but will log a warning message.
+ </para>
+ <para>
+ See the reference guide section on unenhanced types for more
+ information
+ <xref linkend="ref_guide_pc_enhance_unenhanced_types"/>
+ </para>
+ </section>
<section id="openjpa.SavepointManager">
<title>
openjpa.SavepointManager
Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml?rev=696510&r1=696509&r2=696510&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml Wed Sep 17 16:19:16 2008
@@ -436,13 +436,23 @@
runtime enhancement process for some reason.
</para></listitem>
<listitem><para>
-<emphasis>state comparison and subclassing</emphasis>: if you are running
+<emphasis>Runtime Unenhanced Classes</emphasis>: AKA statte comparison and
+subclassing. If you are running
in a Java 5 environment without a javaagent, or in a Java 6 environment that
does not support class retransformation, OpenJPA will still create subclasses
as outlined above. However, in some cases, OpenJPA may not be able to receive
notifications when you read or write persistent data.
</para>
<para>
+ <note>
+Runtime Unenhanced Classes has some known limitations which are discussed below
+and documented in JIRA issues on the OpenJPA website. Support for this method
+of automatic enhancement may be enabled or disabled via the
+<xref linkend="openjpa.RuntimeUnenhancedClasses">
+openjpa.RuntimeUnenhancedClasses configuration </xref>option.
+ </note>
+ </para>
+ <para>
If you are using <emphasis>property access</emphasis> for your persistent data,
then OpenJPA will be able to track all accesses for instances that you load
from the database, but not for instances that you create. This is because