#3533 Support @transactional on module path

As HelpScopeTrans isn't in an exported package it's use fails with an error in module path. This adds AOPTransactionScope in the exported package io.ebean.plugin and moves the required methods from SpiEbeanServer to SpiServer to support this move.

This also requires an associate change in ebean-agent to support this feature which will be in ebean-agent 14.9.0.

Author: rbygrave

ebean-api/src/main/java/io/ebean/plugin/AOPTransactionScope.java

@@ -0,0 +1,43 @@
+package io.ebean.plugin;
+
+import io.ebean.DB;
+import io.ebean.TxScope;
+
+/**
+ * Helper object to make AOP generated code simpler.
+ */
+public final class AOPTransactionScope {
+  private static boolean enabled = true;
+
+  /**
+   * Entering an enhanced transactional method.
+   */
+  public static void enter(TxScope txScope) {
+    if (enabled) {
+      server().scopedTransactionEnter(txScope);
+    }
+  }
+
+  /**
+   * Exiting an enhanced transactional method.
+   */
+  public static void exit(Object returnOrThrowable, int opCode) {
+    if (enabled) {
+      server().scopedTransactionExit(returnOrThrowable, opCode);
+    }
+  }
+
+  private static SpiServer server() {
+    return (SpiServer) DB.getDefault();
+  }
+
+  /**
+   * Defines if the @Transactional does what is supposed to do or is disabled
+   * (useful only unit testing)
+   *
+   * @param enabled if set to false, @Transactional will not create a transaction
+   */
+  public static void setEnabled(boolean enabled) {
+    AOPTransactionScope.enabled = enabled;
+  }
+}

ebean-api/src/main/java/io/ebean/plugin/SpiServer.java

@@ -1,6 +1,7 @@
 package io.ebean.plugin;
 
 import io.ebean.Database;
+import io.ebean.TxScope;
 import io.ebean.bean.BeanLoader;
 import io.ebean.bean.EntityBeanIntercept;
 import io.ebean.DatabaseBuilder;
@@ -63,4 +64,15 @@ public interface SpiServer extends Database {
    * Typically due to serialisation or multiple stateless updates.
    */
   void loadBean(EntityBeanIntercept ebi);
+
+  /**
+   * Start an enhanced transactional method.
+   */
+  void scopedTransactionEnter(TxScope txScope);
+
+  /**
+   * Handle the end of an enhanced Transactional method.
+   */
+  void scopedTransactionExit(Object returnOrThrowable, int opCode);
+
 }

ebean-api/src/main/resources/META-INF/ebean-version.mf

@@ -1 +1 @@
-ebean-version: 148
+ebean-version: 149

ebean-core/src/main/java/io/ebeaninternal/api/HelpScopeTrans.java

@@ -1,34 +1,25 @@
 package io.ebeaninternal.api;
 
-import io.ebean.DB;
 import io.ebean.TxScope;
+import io.ebean.plugin.AOPTransactionScope;
 
 /**
  * Helper object to make AOP generated code simpler.
  */
 public final class HelpScopeTrans {
-  private static boolean enabled = true;
 
   /**
    * Entering an enhanced transactional method.
    */
   public static void enter(TxScope txScope) {
-    if (enabled) {
-      server().scopedTransactionEnter(txScope);
-    }
+    AOPTransactionScope.enter(txScope);
   }
 
   /**
    * Exiting an enhanced transactional method.
    */
   public static void exit(Object returnOrThrowable, int opCode) {
-    if (enabled) {
-      server().scopedTransactionExit(returnOrThrowable, opCode);
-    }
-  }
-
-  private static SpiEbeanServer server() {
-    return (SpiEbeanServer) DB.getDefault();
+    AOPTransactionScope.exit(returnOrThrowable, opCode);
   }
 
   /**
@@ -38,6 +29,6 @@ private static SpiEbeanServer server() {
    * @param enabled if set to false, @Transactional will not create a transaction
    */
   public static void setEnabled(boolean enabled) {
-    HelpScopeTrans.enabled = enabled;
+    AOPTransactionScope.setEnabled(enabled);
   }
 }

ebean-core/src/main/java/io/ebeaninternal/api/SpiEbeanServer.java

@@ -216,16 +216,6 @@ public interface SpiEbeanServer extends SpiServer, ExtendedServer, BeanCollectio
    */
   void slowQueryCheck(long executionTimeMicros, int rowCount, SpiQuery<?> query);
 
-  /**
-   * Start an enhanced transactional method.
-   */
-  void scopedTransactionEnter(TxScope txScope);
-
-  /**
-   * Handle the end of an enhanced Transactional method.
-   */
-  void scopedTransactionExit(Object returnOrThrowable, int opCode);
-
   /**
    * SqlQuery find single attribute.
    */

ebean-test/pom.xml

@@ -309,7 +309,7 @@
         <extensions>true</extensions>
         <configuration>
           <tiles>
-            <tile>io.ebean.tile:enhancement:14.8.0</tile>
+            <tile>io.ebean.tile:enhancement:14.8.1</tile>
           </tiles>
         </configuration>
       </plugin>

ebean-test/src/test/java/io/ebean/xtest/internal/api/TDSpiServer.java

@@ -187,6 +187,16 @@ public void register(TransactionCallback transactionCallback) throws Persistence
 
   }
 
+  @Override
+  public void scopedTransactionEnter(TxScope txScope) {
+
+  }
+
+  @Override
+  public void scopedTransactionExit(Object returnOrThrowable, int opCode) {
+
+  }
+
   @Override
   public Transaction createTransaction() {
     return null;