openjpa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r696510 - in /openjpa/branches/1.2.x/openjpa-project/src/doc/manual: ref_guide_conf.xml ref_guide_pc.xml
Date Wed, 17 Sep 2008 23:19:17 GMT
Author: mikedd
Date: Wed Sep 17 16:19:16 2008
New Revision: 696510

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_conf.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml Wed Sep 17 16:19:16
@@ -2753,6 +2753,50 @@
 serious problems.
+        <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">

Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_pc.xml
--- 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
@@ -436,13 +436,23 @@
 runtime enhancement process for some reason.
-<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.
+                <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

View raw message