refs #77: Moved MessageListenerContainer to API as this is not spring specific

Author: jashmoreAtlassian

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-api/src/main/java/com/jashmore/sqs/spring/container/MessageListenerContainer.java renamed to java-dynamic-sqs-listener-api/src/main/java/com/jashmore/sqs/container/MessageListenerContainer.java

@@ -1,8 +1,7 @@
-package com.jashmore.sqs.spring.container;
+package com.jashmore.sqs.container;
 
 import com.jashmore.sqs.broker.MessageBroker;
 import com.jashmore.sqs.retriever.AsyncMessageRetriever;
-import com.jashmore.sqs.spring.QueueContainerService;
 
 import javax.annotation.concurrent.ThreadSafe;
 
@@ -13,21 +12,10 @@
  * may only need to call down to the underlying {@link MessageBroker#start()} but there could be more complicated actions needing
  * to be made, such as starting an {@link AsyncMessageRetriever}.
  *
- * <p>These containers must be thread safe as there could be multiple threads starting and stopping these containers using the
- * {@link QueueContainerService}.
+ * <p>These containers must be thread safe as there could be multiple threads starting and stopping these containers.
  */
 @ThreadSafe
 public interface MessageListenerContainer {
-    /**
-     * The unique identifier for this container which should not be the same as any other container.
-     *
-     * <p>For the default implementations provided by the core Spring Starter the unique identifier is the URL for the queue
-     * and therefore it isn't possible two different methods call the same queue.
-     *
-     * @return the unique identifier
-     */
-    String getIdentifier();
-
     /**
      * Start processing messages for a queue by starting any necessary dependencies internally.
      *

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-starter/src/main/java/com/jashmore/sqs/spring/container/SimpleMessageListenerContainer.java renamed to java-dynamic-sqs-listener-core/src/main/java/com/jashmore/sqs/container/SimpleMessageListenerContainer.java

@@ -1,4 +1,4 @@
-package com.jashmore.sqs.spring.container;
+package com.jashmore.sqs.container;
 
 import com.google.common.annotations.VisibleForTesting;
 
@@ -8,7 +8,6 @@
 import com.jashmore.sqs.resolver.MessageResolver;
 import com.jashmore.sqs.retriever.AsyncMessageRetriever;
 import com.jashmore.sqs.retriever.MessageRetriever;
-import com.jashmore.sqs.spring.QueueContainerService;
 import lombok.extern.slf4j.Slf4j;
 
 import java.util.concurrent.ExecutionException;
@@ -23,16 +22,6 @@
  */
 @Slf4j
 public class SimpleMessageListenerContainer implements MessageListenerContainer {
-    /**
-     * The identifier for this container.
-     *
-     * <p>This identifier must be unique across all other containers so that it can be uniquely obtained to start
-     * or stop specifically.
-     *
-     * @see QueueContainerService#startContainer(String) for usage of this identifier
-     * @see QueueContainerService#stopContainer(String) for usage of this identifier
-     */
-    private final String identifier;
 
     /**
      * The {@link MessageRetriever} that will be used in this container to obtain messages to process.
@@ -73,16 +62,13 @@ public class SimpleMessageListenerContainer implements MessageListenerContainer
      * Container that can be built when the {@link MessageBroker} is using an {@link AsyncMessageRetriever}. This takes the {@link AsyncMessageRetriever} so
      * that during the lifecycle of the spring container, it can be enabled and disabled at the same time that the {@link MessageBroker} is.
      *
-     * @param identifier       the unique identifier for this container
      * @param messageRetriever the message retriever for this listener
      * @param messageBroker    the message broker that handles the processing of messages
      * @param messageResolver  the message resolver that will be used in this container
      */
-    public SimpleMessageListenerContainer(final String identifier,
-                                          final MessageRetriever messageRetriever,
+    public SimpleMessageListenerContainer(final MessageRetriever messageRetriever,
                                           final MessageBroker messageBroker,
                                           final MessageResolver messageResolver) {
-        this.identifier = identifier;
         this.messageRetriever = messageRetriever;
         this.messageBroker = messageBroker;
         this.messageResolver = messageResolver;
@@ -92,12 +78,10 @@ public SimpleMessageListenerContainer(final String identifier,
     }
 
     @VisibleForTesting
-    SimpleMessageListenerContainer(final String identifier,
-                                   final MessageRetriever messageRetriever,
+    SimpleMessageListenerContainer(final MessageRetriever messageRetriever,
                                    final MessageBroker messageBroker,
                                    final MessageResolver messageResolver,
                                    final ExecutorService executorService) {
-        this.identifier = identifier;
         this.messageRetriever = messageRetriever;
         this.messageBroker = messageBroker;
         this.messageResolver = messageResolver;
@@ -106,11 +90,6 @@ public SimpleMessageListenerContainer(final String identifier,
         this.messageResolverCompletableFuture = null;
     }
 
-    @Override
-    public String getIdentifier() {
-        return identifier;
-    }
-
     @Override
     public synchronized void start() {
         if (isRunning) {
@@ -142,7 +121,6 @@ public synchronized void stop() {
                 ((AsyncMessageRetriever)messageRetriever).stop().get();
             }
 
-            // TODO: All of the tests for these
             if (messageResolverCompletableFuture != null) {
                 messageResolverCompletableFuture.cancel(true);
             }

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-starter/src/test/java/com/jashmore/sqs/spring/container/SimpleMessageListenerContainerTest.java renamed to java-dynamic-sqs-listener-core/src/test/java/com/jashmore/sqs/container/SimpleMessageListenerContainerTest.java

@@ -1,6 +1,5 @@
-package com.jashmore.sqs.spring.container;
+package com.jashmore.sqs.container;
 
-import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.times;
@@ -31,7 +30,7 @@ public class SimpleMessageListenerContainerTest {
 
     @Mock
     private MessageBroker messageBroker;
-    
+
     @Mock
     private MessageResolver messageResolver;
 
@@ -56,19 +55,10 @@ public void setUp() {
         when(asyncMessageRetriever.stop()).thenReturn(asyncMessageRetrieverStoppedFuture);
     }
 
-    @Test
-    public void identifierPassedIsTheIdentifierForTheContainer() {
-        // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
-
-        // assert
-        assertThat(container.getIdentifier()).isEqualTo("identifier");
-    }
-
     @Test
     public void onStartTheMessageBrokerIsStarted() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
 
         // act
         container.start();
@@ -80,7 +70,7 @@ public void onStartTheMessageBrokerIsStarted() {
     @Test
     public void whenContainerIsAlreadyStartedTheMessageBrokerAndMessageRetrieverAreNotStartedAgain() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
 
         // act
         container.start();
@@ -94,7 +84,7 @@ public void whenContainerIsAlreadyStartedTheMessageBrokerAndMessageRetrieverAreN
     @Test
     public void stoppingContainerWhenNotRunningDoesNothing() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
 
         // act
         container.stop();
@@ -106,7 +96,7 @@ public void stoppingContainerWhenNotRunningDoesNothing() {
     @Test
     public void stoppingContainerWhenRunningWillStopAsyncMessageRetrievers() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
 
         // act
@@ -119,7 +109,7 @@ public void stoppingContainerWhenRunningWillStopAsyncMessageRetrievers() {
     @Test
     public void stoppingContainerWhenRunningWillStopTheMessageBroker() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
 
         // act
@@ -132,7 +122,7 @@ public void stoppingContainerWhenRunningWillStopTheMessageBroker() {
     @Test
     public void stoppingContainerWhenRunningWillWaitUntilMessageBrokerIsStopped() throws InterruptedException, ExecutionException {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
 
         // act
@@ -145,7 +135,7 @@ public void stoppingContainerWhenRunningWillWaitUntilMessageBrokerIsStopped() th
     @Test
     public void stoppingContainerWhenRunningWillWaitUntilAsyncMessageRetrieverIsStopped() throws InterruptedException, ExecutionException {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
 
         // act
@@ -158,7 +148,7 @@ public void stoppingContainerWhenRunningWillWaitUntilAsyncMessageRetrieverIsStop
     @Test
     public void exceptionThrownWhileStoppingAsyncMessageRetrieverWillNotBubbleException() throws InterruptedException, ExecutionException {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
         when(asyncMessageRetrieverStoppedFuture.get()).thenThrow(new ExecutionException("test", new IllegalArgumentException()));
 
@@ -170,7 +160,7 @@ public void exceptionThrownWhileStoppingAsyncMessageRetrieverWillNotBubbleExcept
     @Test
     public void exceptionThrownWhileStoppingMessageBrokerWillNotBubbleException() throws InterruptedException, ExecutionException {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
         when(messageBrokerStoppedFuture.get()).thenThrow(new ExecutionException("test", new IllegalArgumentException()));
 
@@ -181,7 +171,7 @@ public void exceptionThrownWhileStoppingMessageBrokerWillNotBubbleException() th
     @Test
     public void stoppingAlreadyStoppedContainerWillDoNothing() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever, messageBroker, messageResolver);
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever, messageBroker, messageResolver);
         container.start();
 
         // act
@@ -196,7 +186,7 @@ public void stoppingAlreadyStoppedContainerWillDoNothing() {
     @Test
     public void asyncMessageResolverWillBeStartedOnBackgroundThreadWhenStartCalled() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever,
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever,
                 messageBroker, asyncMessageResolver, executorService);
 
         // act
@@ -209,7 +199,7 @@ public void asyncMessageResolverWillBeStartedOnBackgroundThreadWhenStartCalled()
     @Test
     public void whenAsyncMessageResolverStartedItWillCancelThreadWhenContainerIsStopped() {
         // arrange
-        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer("identifier", asyncMessageRetriever,
+        final SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(asyncMessageRetriever,
                 messageBroker, asyncMessageResolver, executorService);
         doReturn(messageResolverThreadFuture).when(executorService).submit(asyncMessageResolver);
         container.start();

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-api/pom.xml

@@ -22,6 +22,11 @@
             <artifactId>java-dynamic-sqs-listener-api</artifactId>
             <version>${project.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+        </dependency>
     </dependencies>
 
 </project>

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-api/src/main/java/com/jashmore/sqs/spring/IdentifiableMessageListenerContainer.java

@@ -0,0 +1,27 @@
+package com.jashmore.sqs.spring;
+
+import com.jashmore.sqs.container.MessageListenerContainer;
+import lombok.Builder;
+import lombok.Value;
+import lombok.experimental.NonFinal;
+
+/**
+ * Defines a {@link MessageListenerContainer} with a provided identifier that can be used by the {@link QueueContainerService} to start and stop them during
+ * execution.
+ */
+@Value
+@NonFinal
+@Builder
+public class IdentifiableMessageListenerContainer {
+    /**
+     * The unique identifier for this container which should not be the same as any other container.
+     *
+     * <p>For the default implementations provided by the core Spring Starter the unique identifier is the URL for the queue
+     * and therefore it isn't possible two different methods call the same queue.
+     */
+    private String identifier;
+    /**
+     * The container that wraps a method and is identifiable by the {@link #identifier}.
+     */
+    private MessageListenerContainer container;
+}

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-api/src/main/java/com/jashmore/sqs/spring/QueueWrapper.java

@@ -1,6 +1,6 @@
 package com.jashmore.sqs.spring;
 
-import com.jashmore.sqs.spring.container.MessageListenerContainer;
+import com.jashmore.sqs.container.MessageListenerContainer;
 
 import java.lang.reflect.Method;
 
@@ -20,11 +20,11 @@ public interface QueueWrapper {
     boolean canWrapMethod(Method method);
 
     /**
-     * Wrap a method with a {@link MessageListenerContainer} that will handle the messages being processed.
+     * Wrap a method with a {@link MessageListenerContainer} that will handle the messages being processed and identify it with a unique identifier.
      *
      * @param bean   the specific bean for this method
      * @param method the method of the bean that will be run for each message
      * @return the container that will wrap this method
      */
-    MessageListenerContainer wrapMethod(Object bean, Method method);
+    IdentifiableMessageListenerContainer wrapMethod(Object bean, Method method);
 }

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-starter/src/main/java/com/jashmore/sqs/spring/AbstractQueueAnnotationWrapper.java

@@ -1,6 +1,5 @@
 package com.jashmore.sqs.spring;
 
-import com.jashmore.sqs.spring.container.MessageListenerContainer;
 import com.jashmore.sqs.util.annotation.AnnotationUtils;
 
 import java.lang.annotation.Annotation;
@@ -20,7 +19,7 @@ public boolean canWrapMethod(final Method method) {
     }
 
     @Override
-    public MessageListenerContainer wrapMethod(final Object bean, final Method method) {
+    public IdentifiableMessageListenerContainer wrapMethod(final Object bean, final Method method) {
         final T annotation = AnnotationUtils.findMethodAnnotation(method, getAnnotationClass())
                 .orElseThrow(() -> new RuntimeException("Trying to wrap method that does not contain annotation: @" + getAnnotationClass().getSimpleName()));
 
@@ -42,5 +41,5 @@ public MessageListenerContainer wrapMethod(final Object bean, final Method metho
      * @param annotation the annotation found on the method containing details about this listener
      * @return the container that wraps the method for usage by the queue listeners
      */
-    protected abstract MessageListenerContainer wrapMethodContainingAnnotation(final Object bean, final Method method, T annotation);
+    protected abstract IdentifiableMessageListenerContainer wrapMethodContainingAnnotation(final Object bean, final Method method, T annotation);
 }

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-starter/src/main/java/com/jashmore/sqs/spring/DefaultQueueContainerService.java

@@ -6,7 +6,7 @@
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 
-import com.jashmore.sqs.spring.container.MessageListenerContainer;
+import com.jashmore.sqs.container.MessageListenerContainer;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.BeansException;
 import org.springframework.context.ApplicationContext;
@@ -68,12 +68,6 @@ public DefaultQueueContainerService(final List<QueueWrapper> queueWrappers) {
         this.queueWrappers = queueWrappers;
     }
 
-    @VisibleForTesting
-    DefaultQueueContainerService(final ExecutorService executorService, final List<QueueWrapper> queueWrappers) {
-        this.executorService = executorService;
-        this.queueWrappers = queueWrappers;
-    }
-
     /**
      * Initialise all of the containers for this application by finding all bean methods that need to be wrapped.
      */
@@ -97,13 +91,13 @@ public synchronized void setApplicationContext(@Nonnull final ApplicationContext
             for (final Method method : bean.getClass().getMethods()) {
                 for (final QueueWrapper annotationProcessor : queueWrappers) {
                     if (annotationProcessor.canWrapMethod(method)) {
-                        final MessageListenerContainer messageListenerContainer = annotationProcessor.wrapMethod(bean, method);
-                        if (messageContainers.containsKey(messageListenerContainer.getIdentifier())) {
+                        final IdentifiableMessageListenerContainer identifiableMessageListenerContainer = annotationProcessor.wrapMethod(bean, method);
+                        if (messageContainers.containsKey(identifiableMessageListenerContainer.getIdentifier())) {
                             throw new IllegalStateException("Created two MessageListenerContainers with the same identifier: "
-                                    + messageListenerContainer.getIdentifier());
+                                    + identifiableMessageListenerContainer.getIdentifier());
                         }
-                        log.debug("Created MessageListenerContainer with id: {}", messageListenerContainer.getIdentifier());
-                        messageContainers.put(messageListenerContainer.getIdentifier(), messageListenerContainer);
+                        log.debug("Created MessageListenerContainer with id: {}", identifiableMessageListenerContainer.getIdentifier());
+                        messageContainers.put(identifiableMessageListenerContainer.getIdentifier(), identifiableMessageListenerContainer.getContainer());
                     }
                 }
             }

java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-starter/src/main/java/com/jashmore/sqs/spring/config/QueueListenerConfiguration.java

@@ -9,10 +9,10 @@
 import com.jashmore.sqs.argument.payload.mapper.JacksonPayloadMapper;
 import com.jashmore.sqs.argument.payload.mapper.PayloadMapper;
 import com.jashmore.sqs.argument.visibility.VisibilityExtenderArgumentResolver;
+import com.jashmore.sqs.container.MessageListenerContainer;
 import com.jashmore.sqs.spring.DefaultQueueContainerService;
 import com.jashmore.sqs.spring.QueueContainerService;
 import com.jashmore.sqs.spring.QueueWrapper;
-import com.jashmore.sqs.spring.container.MessageListenerContainer;
 import com.jashmore.sqs.spring.container.basic.QueueListenerWrapper;
 import com.jashmore.sqs.spring.container.batching.BatchingQueueListenerWrapper;
 import com.jashmore.sqs.spring.container.prefetch.PrefetchingQueueListenerWrapper;