[GEOS-7403] TransactionPlugin can no longer alter transaction items -…

… Apply Jody's feedback
geoserver · Oct 31, 2017 · 65ea527 · 65ea527
1 parent 31550b3
commit 65ea527
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 35 deletions.
diff --git a/src/gwc/src/main/java/org/geoserver/gwc/GWCTransactionListener.java b/src/gwc/src/main/java/org/geoserver/gwc/GWCTransactionListener.java
@@ -49,7 +49,7 @@
  * @version $Id$
  * 
  */
-public class GWCTransactionListener implements TransactionPlugin2 {
+public class GWCTransactionListener implements TransactionCallback {
 
     private static Logger log = Logging.getLogger(GWCTransactionListener.class);
 

diff --git a/src/wfs/src/main/java/org/geoserver/wfs/Transaction.java b/src/wfs/src/main/java/org/geoserver/wfs/Transaction.java
@@ -74,7 +74,7 @@ public class Transaction {
     protected List<TransactionElementHandler> transactionElementHandlers = new ArrayList<>();
     protected List<TransactionListener> transactionListeners = new ArrayList<>();
     protected List<TransactionPlugin> transactionPlugins = new ArrayList<>();
-    protected List<TransactionPlugin2> transactionPlugins2 = new ArrayList<>();
+    protected List<TransactionCallback> transactionPlugins2 = new ArrayList<>();
 
     public Transaction(WFSInfo wfs, Catalog catalog, ApplicationContext context) {
         this.wfs = wfs;
@@ -84,7 +84,7 @@ public Transaction(WFSInfo wfs, Catalog catalog, ApplicationContext context) {
         transactionElementHandlers.addAll(GeoServerExtensions.extensions(TransactionElementHandler.class));
         transactionListeners.addAll(GeoServerExtensions.extensions(TransactionListener.class));
         transactionPlugins.addAll(GeoServerExtensions.extensions(TransactionPlugin.class));
-        transactionPlugins2.addAll(GeoServerExtensions.extensions(TransactionPlugin2.class));
+        transactionPlugins2.addAll(GeoServerExtensions.extensions(TransactionCallback.class));
         // plugins are listeners too, but I want to make sure they are notified
         // of
         // changes in the same order as the other plugin callbacks
@@ -447,7 +447,7 @@ private TransactionRequest fireBeforeTransaction(TransactionRequest request) {
                 tp.beforeTransaction(tx);
             }
         }
-        for (TransactionPlugin2 tp : transactionPlugins2) {
+        for (TransactionCallback tp : transactionPlugins2) {
             request = tp.beforeTransaction(request);
         }
 
@@ -462,7 +462,7 @@ private void fireAfterTransaction(TransactionRequest request, TransactionRespons
                 tp.afterTransaction(tx, tr, committed);
             }
         }
-        for (TransactionPlugin2 tp : transactionPlugins2) {
+        for (TransactionCallback tp : transactionPlugins2) {
             tp.afterTransaction(request, result, committed);
         }
     }
@@ -475,7 +475,7 @@ private void fireBeforeCommit(TransactionRequest request) {
                 tp.beforeCommit(tx);
             }
         }
-        for (TransactionPlugin2 tp : transactionPlugins2) {
+        for (TransactionCallback tp : transactionPlugins2) {
             tp.beforeCommit(request);
         }
     }
@@ -684,7 +684,6 @@ public void dataStoreChange(List listeners, TransactionEvent event)
         public void dataStoreChange(TransactionEvent event)
             throws WFSException {
             dataStoreChange(transactionPlugins, event);
-            dataStoreChange(transactionPlugins2, event);
             dataStoreChange(transactionListeners, event);
         }
     }

diff --git a/...org/geoserver/wfs/TransactionPlugin2.java → ...rg/geoserver/wfs/TransactionCallback.java b/...org/geoserver/wfs/TransactionPlugin2.java → ...rg/geoserver/wfs/TransactionCallback.java
@@ -13,7 +13,7 @@
  * A transaction plugin is able to listen to a transaction evolution, perform
  * checks and throw exceptions, alter transaction requests, as well as
  */
-public interface TransactionPlugin2 extends TransactionListener, ExtensionPriority {
+public interface TransactionCallback extends ExtensionPriority {
     /**
      * Check/alter the transaction request elements
      */

diff --git a/src/wfs/src/main/java/org/geoserver/wfs/TransactionPlugin.java b/src/wfs/src/main/java/org/geoserver/wfs/TransactionPlugin.java
@@ -12,7 +12,7 @@
 /**
  * A transaction plugin is able to listen to a transaction evolution, perform
  * checks and throw exceptions, alter transaction requests, as well as
- * @deprecated Use {@link TransactionPlugin2 instead}
+ * @deprecated Use {@link TransactionCallback instead}
  */
 @Deprecated
 public interface TransactionPlugin extends TransactionListener {

diff --git a/...ver/wfs/TransactionPlugin2TestContext.xml → ...er/wfs/TransactionCallbackTestContext.xml b/...ver/wfs/TransactionPlugin2TestContext.xml → ...er/wfs/TransactionCallbackTestContext.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
 
 <beans>
-  <bean id="transactionPlugin2Tester" class="org.geoserver.wfs.TransactionPlugin2Tester">
+  <bean id="transactionCallbackTester" class="org.geoserver.wfs.TransactionCallbackTester">
     <constructor-arg index="0" ref="catalog"/>
   </bean>
 </beans>
diff --git a/...oserver/wfs/TransactionPlugin2Tester.java → ...server/wfs/TransactionCallbackTester.java b/...oserver/wfs/TransactionPlugin2Tester.java → ...server/wfs/TransactionCallbackTester.java
@@ -2,7 +2,6 @@
 
 import com.vividsolutions.jts.geom.Geometry;
 import com.vividsolutions.jts.io.WKTReader;
-import net.opengis.wfs.*;
 import org.geoserver.catalog.Catalog;
 import org.geoserver.data.test.MockData;
 import org.geoserver.wfs.request.*;
@@ -13,14 +12,12 @@
 import org.opengis.feature.simple.SimpleFeatureType;
 
 import javax.xml.namespace.QName;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.function.BiFunction;
-import java.util.function.Function;
 
-public class TransactionPlugin2Tester extends TransactionListenerTester implements TransactionPlugin2 {
+public class TransactionCallbackTester implements TransactionCallback {
 
     public static final String FOLSOM_STREET = "Folsom Street";
 
@@ -120,10 +117,10 @@ public static TransactionRequest replaceWithFixedRoadsDelete(Catalog catalog, Tr
     boolean beforeCommitCalled;
     TransactionRequest request;
     BiFunction<Catalog, TransactionRequest, TransactionRequest> beforeTransaction =
-            TransactionPlugin2Tester::defaultTransformation;
+            TransactionCallbackTester::defaultTransformation;
     Catalog catalog;
 
-    public TransactionPlugin2Tester(Catalog catalog) {
+    public TransactionCallbackTester(Catalog catalog) {
         this.catalog = catalog;
     }
 
@@ -148,12 +145,10 @@ public void afterTransaction(TransactionRequest request, TransactionResponse res
         this.committed = committed;
     }
 
-    @Override
     public void clear() {
-        super.clear();
         this.result = null;
         this.committed = false;
         this.beforeCommitCalled = false;
-        this.beforeTransaction = TransactionPlugin2Tester::defaultTransformation;
+        this.beforeTransaction = TransactionCallbackTester::defaultTransformation;
     }
 }
diff --git a/...erver/wfs/TransactionPluginWFS11Test.java → ...ver/wfs/TransactionCallbackWFS11Test.java b/...erver/wfs/TransactionPluginWFS11Test.java → ...ver/wfs/TransactionCallbackWFS11Test.java
@@ -15,7 +15,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
-public class TransactionPluginWFS11Test extends WFSTestSupport {
+public class TransactionCallbackWFS11Test extends WFSTestSupport {
 
     public static final String DELETE_ROAD_102 = "<wfs:Transaction service=\"WFS\" version=\"1.1.0\"" +
             " xmlns:cite=\"http://www.opengis.net/cite\"" +
@@ -31,18 +31,18 @@ public class TransactionPluginWFS11Test extends WFSTestSupport {
             "   </ogc:Filter>" +
             " </wfs:Delete>" +
             "</wfs:Transaction>";
-    private TransactionPlugin2Tester plugin;
+    private TransactionCallbackTester plugin;
 
     @Override
     protected void setUpSpring(List<String> springContextLocations) {
         super.setUpSpring(springContextLocations);
-        springContextLocations.add("classpath:/org/geoserver/wfs/TransactionPlugin2TestContext.xml");
+        springContextLocations.add("classpath:/org/geoserver/wfs/TransactionCallbackTestContext.xml");
     }
 
     @Before
     public void clearState() throws Exception {
         revertLayer(MockData.ROAD_SEGMENTS);
-        plugin = (TransactionPlugin2Tester) applicationContext.getBean("transactionPlugin2Tester");
+        plugin = (TransactionCallbackTester) applicationContext.getBean("transactionCallbackTester");
         plugin.clear();
     }
 
@@ -133,7 +133,7 @@ public void testUpdate() throws Exception {
         Document roadSegments = getAsDOM("wfs?service=WFS&version=1.1.0&request=GetFeature&typeName=cite:RoadSegments" +
                 "&CQL_FILTER=FID=102");
         // print(roadSegments);
-        assertXpathEvaluatesTo(TransactionPlugin2Tester.FOLSOM_STREET, "//cite:RoadSegments/cite:NAME", roadSegments);
+        assertXpathEvaluatesTo(TransactionCallbackTester.FOLSOM_STREET, "//cite:RoadSegments/cite:NAME", roadSegments);
     }
 
 
@@ -165,7 +165,7 @@ public void testDelete() throws Exception {
     @Test
     public void testReplaceWithInsert() throws Exception {
         // the plugin will remove all elements and replace it with an insert
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsInsert;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsInsert;
         String xml = DELETE_ROAD_102;
 
         Document dom = postAsDOM("wfs", xml);
@@ -191,7 +191,7 @@ public void testReplaceWithInsert() throws Exception {
     @Test
     public void testReplaceWithUpdate() throws Exception {
         // the plugin will remove all elements and replace it with a fixed delete on road 106
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsUpdate;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsUpdate;
         String xml = DELETE_ROAD_102;
 
         Document dom = postAsDOM("wfs", xml);
@@ -217,7 +217,7 @@ public void testReplaceWithUpdate() throws Exception {
     @Test
     public void testReplaceWithDelete() throws Exception {
         // the plugin will remove all elements and replace it with a fixed delete on road 106
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsDelete;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsDelete;
         String xml = DELETE_ROAD_102;
 
         Document dom = postAsDOM("wfs", xml);

diff --git a/...erver/wfs/TransactionPluginWFS20Test.java → ...ver/wfs/TransactionCallbackWFS20Test.java b/...erver/wfs/TransactionPluginWFS20Test.java → ...ver/wfs/TransactionCallbackWFS20Test.java
@@ -19,7 +19,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
-public class TransactionPluginWFS20Test extends WFS20TestSupport {
+public class TransactionCallbackWFS20Test extends WFS20TestSupport {
 
     public static final String DELETE_ROAD_102 = "<wfs:Transaction service=\"WFS\" version=\"2.0.0\" " +
             "xmlns:cite=\"http://www.opengis.net/cite\" " +
@@ -35,18 +35,18 @@ public class TransactionPluginWFS20Test extends WFS20TestSupport {
             "   </fes:Filter>" +
             " </wfs:Delete>" +
             "</wfs:Transaction>";
-    private TransactionPlugin2Tester plugin;
+    private TransactionCallbackTester plugin;
 
     @Override
     protected void setUpSpring(List<String> springContextLocations) {
         super.setUpSpring(springContextLocations);
-        springContextLocations.add("classpath:/org/geoserver/wfs/TransactionPlugin2TestContext.xml");
+        springContextLocations.add("classpath:/org/geoserver/wfs/TransactionCallbackTestContext.xml");
     }
 
     @Before
     public void clearState() throws Exception {
         revertLayer(MockData.ROAD_SEGMENTS);
-        plugin = (TransactionPlugin2Tester) applicationContext.getBean("transactionPlugin2Tester");
+        plugin = (TransactionCallbackTester) applicationContext.getBean("transactionCallbackTester");
         plugin.clear();
     }
 
@@ -137,7 +137,7 @@ public void testUpdate() throws Exception {
         // check the road name has been modified too
         Document roadSegments = getAsDOM("wfs?service=WFS&version=1.1.0&request=GetFeature&typeName=cite:RoadSegments&CQL_FILTER=FID=102");
         // print(roadSegments);
-        assertXpathEvaluatesTo(TransactionPlugin2Tester.FOLSOM_STREET, "//cite:RoadSegments/cite:NAME", roadSegments);
+        assertXpathEvaluatesTo(TransactionCallbackTester.FOLSOM_STREET, "//cite:RoadSegments/cite:NAME", roadSegments);
     }
 
 
@@ -169,7 +169,7 @@ public void testDelete() throws Exception {
     @Test
     public void testReplaceWithInsert() throws Exception {
         // the plugin will remove all elements and replace it with an insert
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsInsert;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsInsert;
         String xml = DELETE_ROAD_102;
 
         Document dom = postAsDOM("wfs", xml);
@@ -195,7 +195,7 @@ public void testReplaceWithInsert() throws Exception {
     @Test
     public void testReplaceWithUpdate() throws Exception {
         // the plugin will remove all elements and replace it with a fixed update on Dirt road
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsUpdate;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsUpdate;
         String xml = DELETE_ROAD_102;
         Document dom = postAsDOM("wfs", xml);
         // print(dom);
@@ -220,7 +220,7 @@ public void testReplaceWithUpdate() throws Exception {
     @Test
     public void testReplaceWithDelete() throws Exception {
         // the plugin will remove all elements and replace it with a fixed delete on road 106
-        plugin.beforeTransaction = TransactionPlugin2Tester::replaceWithFixedRoadsDelete;
+        plugin.beforeTransaction = TransactionCallbackTester::replaceWithFixedRoadsDelete;
         String xml = DELETE_ROAD_102;
 
         Document dom = postAsDOM("wfs", xml);