GH-322 - Move @ApplicationModuleListener into ….modulith.events in spring-modulith-events-api.

Author: odrotbohm

spring-modulith-api/src/main/java/org/springframework/modulith/ApplicationModuleListener.java

@@ -28,25 +28,28 @@
 import org.springframework.transaction.event.TransactionalEventListener;
 
 /**
- * An {@link ApplicationModuleListener} is an {@link Async} Spring {@link TransactionalEventListener} that
- * runs in a transaction itself. Thus, the annotation serves as syntactic sugar for the generally recommend setup to
- * integrate application modules via events. The setup makes sure that an original business transaction completes
- * successfully and the integration asynchronously runs in a transaction itself to decouple the integration as much as
- * possible from the original unit of work.
+ * An {@link ApplicationModuleListener} is an {@link Async} Spring {@link TransactionalEventListener} that runs in a
+ * transaction itself. Thus, the annotation serves as syntactic sugar for the generally recommend setup to integrate
+ * application modules via events. The setup makes sure that an original business transaction completes successfully and
+ * the integration asynchronously runs in a transaction itself to decouple the integration as much as possible from the
+ * original unit of work.
  * <p>
  * It is advisable that you use these integration listeners in combination with the Spring Modulith Event Publication
  * Registry to make sure that the event publication does not get lost in case of an application or listener failure.
  *
  * @author Oliver Drotbohm
- * @see <a href="https://docs.spring.io/spring-modulith/docs/current/reference/html/#events.publication-registry">Spring
- *      Modulith Event Publication Registry - Reference Documentation</a>
+ * @deprecated since, 1.1. Prefer {@code org.springframework.modulith.events.ApplicationModuleListener} in
+ *             {@code spring-modulith-events-api}.
+ * @see <a href="https://docs.spring.io/spring-modulith/reference/events.html#publication-registry">Spring Modulith
+ *      Event Publication Registry - Reference Documentation</a>
  */
 @Async
 @Transactional(propagation = Propagation.REQUIRES_NEW)
 @TransactionalEventListener
 @Documented
 @Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
 @Retention(RetentionPolicy.RUNTIME)
+@Deprecated(since = "1.1", forRemoval = true)
 public @interface ApplicationModuleListener {
 
 	/**

spring-modulith-events/spring-modulith-events-amqp/src/test/java/org/springframework/modulith/events/amqp/RabbitEventPublicationIntegrationTests.java

@@ -31,7 +31,7 @@
 import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.modulith.events.Externalized;
 import org.springframework.transaction.annotation.Transactional;
 import org.testcontainers.containers.RabbitMQContainer;

spring-modulith-events/spring-modulith-events-api/pom.xml

@@ -18,14 +18,13 @@
 	<dependencies>
 
 		<dependency>
-			<groupId>org.springframework.modulith</groupId>
-			<artifactId>spring-modulith-api</artifactId>
-			<version>${project.version}</version>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-context</artifactId>
 		</dependency>
 
 		<dependency>
 			<groupId>org.springframework</groupId>
-			<artifactId>spring-context</artifactId>
+			<artifactId>spring-tx</artifactId>
 		</dependency>
 
 		<dependency>

spring-modulith-events/spring-modulith-events-api/src/main/java/org/springframework/modulith/events/ApplicationModuleListener.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.modulith.events;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.transaction.annotation.Propagation;
+import org.springframework.transaction.annotation.Transactional;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+/**
+ * An {@link ApplicationModuleListener} is an {@link Async} Spring {@link TransactionalEventListener} that runs in a
+ * transaction itself. Thus, the annotation serves as syntactic sugar for the generally recommend setup to integrate
+ * application modules via events. The setup makes sure that an original business transaction completes successfully and
+ * the integration asynchronously runs in a transaction itself to decouple the integration as much as possible from the
+ * original unit of work.
+ * <p>
+ * It is advisable that you use these integration listeners in combination with the Spring Modulith Event Publication
+ * Registry to make sure that the event publication does not get lost in case of an application or listener failure.
+ *
+ * @author Oliver Drotbohm
+ * @see <a href="https://docs.spring.io/spring-modulith/reference/events.html#publication-registry">Spring Modulith
+ *      Event Publication Registry - Reference Documentation</a>
+ */
+@Async
+@Transactional(propagation = Propagation.REQUIRES_NEW)
+@TransactionalEventListener
+@Documented
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ApplicationModuleListener {
+
+	/**
+	 * Whether the transaction to be run for the event listener is supposed to be read-only (default {@literal false}).
+	 */
+	@AliasFor(annotation = Transactional.class, attribute = "readOnly")
+	boolean readOnlyTransaction() default false;
+}

spring-modulith-events/spring-modulith-events-core/pom.xml

@@ -18,12 +18,6 @@
 
 	<dependencies>
 
-		<dependency>
-			<groupId>org.springframework.modulith</groupId>
-			<artifactId>spring-modulith-api</artifactId>
-			<version>${project.version}</version>
-		</dependency>
-
 		<dependency>
 			<groupId>org.springframework.modulith</groupId>
 			<artifactId>spring-modulith-events-api</artifactId>

spring-modulith-events/spring-modulith-events-core/src/main/java/org/springframework/modulith/events/support/DelegatingEventExternalizer.java

@@ -17,7 +17,7 @@
 
 import java.util.function.BiConsumer;
 
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.modulith.events.EventExternalizationConfiguration;
 import org.springframework.modulith.events.RoutingTarget;
 import org.springframework.stereotype.Component;

spring-modulith-events/spring-modulith-events-core/src/main/java/org/springframework/modulith/events/support/EventExternalizationSupport.java

@@ -17,7 +17,7 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.modulith.events.EventExternalizationConfiguration;
 import org.springframework.modulith.events.RoutingTarget;
 import org.springframework.modulith.events.core.ConditionalEventListener;

spring-modulith-events/spring-modulith-events-jms/src/test/java/org/springframework/modulith/events/jms/JmsEventPublicationIntegrationTests.java

@@ -26,7 +26,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.modulith.events.Externalized;
 import org.springframework.transaction.annotation.Transactional;
 

spring-modulith-examples/spring-modulith-example-epr-jdbc/src/main/java/example/inventory/InventoryManagement.java

@@ -21,7 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.context.ApplicationEventPublisher;
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.stereotype.Service;
 
 /**

spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/inventory/InventoryManagement.java

@@ -21,7 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.context.ApplicationEventPublisher;
-import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.ApplicationModuleListener;
 import org.springframework.stereotype.Service;
 
 /**