From 284b6e5ceda27eb678399930bc49e028e2e2a39b Mon Sep 17 00:00:00 2001
From: Albert Lee <allee8285@apache.org>
Date: Wed, 28 Mar 2012 23:01:42 +0000
Subject: [PATCH] OPENJPA-2163 Add SingletonLifecycleEventManager property to
 interface and documentation.

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@1306636 13f79535-47bb-0310-9956-ffa450edef68
---
 .../openjpa/conf/OpenJPAConfiguration.java    | 10 +++
 .../src/doc/manual/ref_guide_conf.xml         | 86 ++++++++++++-------
 2 files changed, 66 insertions(+), 30 deletions(-)

diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/conf/OpenJPAConfiguration.java b/openjpa-kernel/src/main/java/org/apache/openjpa/conf/OpenJPAConfiguration.java
index 99f82478b..30768cce9 100644
--- a/openjpa-kernel/src/main/java/org/apache/openjpa/conf/OpenJPAConfiguration.java
+++ b/openjpa-kernel/src/main/java/org/apache/openjpa/conf/OpenJPAConfiguration.java
@@ -1737,6 +1737,16 @@ public interface OpenJPAConfiguration
      */
     public void setLifecycleEventManager(String eventMgr);
 
+    /**
+     * Returns if lifecycle event manager is a singlton configuration.
+     */
+    public boolean isSingletonLifecycleEventManager();
+
+    /**
+     * Sets the lifecycle event manager singleton state.
+     */
+    public void setSingletonLifecycleEventManager(boolean singleton);
+
     /**
      * Gets the validation groups for pre-persist
      * 
diff --git a/openjpa-project/src/doc/manual/ref_guide_conf.xml b/openjpa-project/src/doc/manual/ref_guide_conf.xml
index 82b4ac0ba..2db51d865 100644
--- a/openjpa-project/src/doc/manual/ref_guide_conf.xml
+++ b/openjpa-project/src/doc/manual/ref_guide_conf.xml
@@ -1811,6 +1811,36 @@ long-running application where the initial cost of class generation is offset by
 memory and speed optimization over time.
             </para>
         </section>
+        <section id="openjpa.DynamicEnhancementAgent">
+            <title>openjpa.DynamicEnhancementAgent</title>
+            <para> 
+                <emphasis role="bold">Property name: </emphasis>
+                <literal>openjpa.DynamicEnhancementAgent</literal>
+            </para>
+            <para>
+                 <emphasis role="bold">Configuration API: </emphasis>
+                 <ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicEnhancementAgent()">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent</ulink>
+            </para>
+            <para>
+                <emphasis role="bold">Resource adaptor config property:</emphasis>
+                DynamicEnhancementAgent
+            </para>
+            <para>
+                <emphasis role="bold">Default: </emphasis>
+                <literal>true</literal>
+                
+            </para>
+            <para>
+                <emphasis role="bold">Description:</emphasis>
+                The DynamicEnhancementAgent property controls whether or not
+                OpenJPA will attempt to dynamically load the PCEnhancer 
+                javaagent.
+            </para>
+            <para>
+                See the reference guide for more information 
+                <xref linkend="ref_guide_pc_enhance_dynamic"/>
+            </para>            
+        </section>
         <section id="openjpa.FetchBatchSize">
             <title>
                 openjpa.FetchBatchSize
@@ -3181,36 +3211,6 @@ serious problems.
                 <xref linkend="ref_guide_pc_enhance_unenhanced_types"/>
             </para>
         </section>
-        <section id="openjpa.DynamicEnhancementAgent">
-            <title>openjpa.DynamicEnhancementAgent</title>
-            <para> 
-                <emphasis role="bold">Property name: </emphasis>
-                <literal>openjpa.DynamicEnhancementAgent</literal>
-            </para>
-            <para>
-                 <emphasis role="bold">Configuration API: </emphasis>
-                 <ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicEnhancementAgent()">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent</ulink>
-            </para>
-            <para>
-                <emphasis role="bold">Resource adaptor config property:</emphasis>
-                DynamicEnhancementAgent
-            </para>
-            <para>
-                <emphasis role="bold">Default: </emphasis>
-                <literal>true</literal>
-                
-            </para>
-            <para>
-                <emphasis role="bold">Description:</emphasis>
-                The DynamicEnhancementAgent property controls whether or not
-                OpenJPA will attempt to dynamically load the PCEnhancer 
-                javaagent.
-            </para>
-            <para>
-                See the reference guide for more information 
-                <xref linkend="ref_guide_pc_enhance_dynamic"/>
-            </para>            
-        </section>
         <section id="openjpa.SavepointManager">
             <title>
                 openjpa.SavepointManager
@@ -3279,6 +3279,32 @@ system sequence. See <xref linkend="ref_guide_sequence"/> for more
 information.
             </para>
         </section>
+        <section id="openjpa.SingletonLifecycleEventManager">
+            <title>openjpa.SingletonLifecycleEventManager</title>
+            <para>
+                <emphasis role="bold">Property name: </emphasis>
+                <literal>openjpa.SingletonLifecycleEventManager</literal>
+            </para>
+            <para>
+                 <emphasis role="bold">Configuration API: </emphasis>
+                 <ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#isSingletonLifecycleEventManager()">org.apache.openjpa.conf.OpenJPAConfiguration.isSingletonLifecycleEventManager</ulink>
+            </para>
+            <para>
+                <emphasis role="bold">Resource adaptor config property:</emphasis>
+                SingletonLifecycleEventManager
+            </para>
+            <para>
+                <emphasis role="bold">Default: </emphasis>
+                <literal>false</literal>                
+            </para>
+            <para>
+                <emphasis role="bold">Description:</emphasis>
+                This property controls whether each EntityManager has its own life cycle event manager.
+                By default, each EntityManager only fires events to the registered listeners to the entities
+                it manages. If the life cycle event manager is a singleton, events will be fired to listeners
+                registered to all instances of EntityManager in the same persistence unit.
+            </para>
+        </section>
         <section id="openjpa.Specification">
             <title>
                 openjpa.Specification