INT-4381: MessageSources refactoring (#2517)

* INT-4381: MessageSources refactoring

JIRA: https://jira.spring.io/browse/INT-4381

* Make all the out-of-the-box `MessageSource` implementations based
on the `AbstractMessageSource`
* Fix `JdbcPollingChannelAdapterIntegrationTests` for sporadic failure
because of `fixed-rate` for the poller

* Fix HeaderEnricherTests race condition

The `errorChannel()` expect an error in the `testErrorChannel` after
`1000` ms, but at the same time the `poller` in configured for the
`3000` ms.

* Increase all the timeouts for replies
* Decrease a `fixed-delay` on the `poller`
* Some other code style polishing for the `HeaderEnricherTests`

Author: artembilan

spring-integration-core/src/main/java/org/springframework/integration/endpoint/MethodInvokingMessageSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -68,8 +68,7 @@ public String getComponentType() {
 	}
 
 	@Override
-	public void afterPropertiesSet() throws Exception {
-		super.afterPropertiesSet();
+	protected void onInit() {
 		synchronized (this.initializationMonitor) {
 			if (this.initialized) {
 				return;

spring-integration-core/src/main/java/org/springframework/integration/resource/ResourceRetrievingMessageSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -39,6 +39,8 @@
  * @author Oleg Zhurakousky
  * @author Mark Fisher
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 2.1
  */
 public class ResourceRetrievingMessageSource extends AbstractMessageSource<Resource[]>
@@ -79,8 +81,7 @@ public String getComponentType() {
 
 
 	@Override
-	public void afterPropertiesSet() throws Exception {
-		super.afterPropertiesSet();
+	protected void onInit() {
 		if (this.patternResolver == null) {
 			this.patternResolver = this.applicationContext;
 		}
@@ -100,7 +101,7 @@ else if (this.filter != null) {
 					resources = null;
 				}
 				else {
-					resources = filteredResources.toArray(new Resource[filteredResources.size()]);
+					resources = filteredResources.toArray(new Resource[0]);
 				}
 			}
 			return resources;

spring-integration-core/src/main/java/org/springframework/integration/util/AbstractExpressionEvaluator.java

@@ -88,11 +88,13 @@ protected MessageBuilderFactory getMessageBuilderFactory() {
 	}
 
 	@Override
-	public void afterPropertiesSet() throws Exception {
+	public final void afterPropertiesSet() throws Exception {
 		getEvaluationContext();
 		if (this.beanFactory != null) {
 			this.messageBuilderFactory = IntegrationUtils.getMessageBuilderFactory(this.beanFactory);
 		}
+
+		onInit();
 	}
 
 	protected StandardEvaluationContext getEvaluationContext() {
@@ -169,4 +171,8 @@ protected <T> T evaluateExpression(Expression expression, Object input, Class<T>
 		return expression.getValue(this.getEvaluationContext(), input, expectedType);
 	}
 
+	protected void onInit() {
+
+	}
+
 }

spring-integration-core/src/test/java/org/springframework/integration/config/xml/HeaderEnricherTests-context.xml

@@ -30,7 +30,7 @@
 	</channel>
 
 	<header-enricher input-channel="errorChannelInput" output-channel="failInput">
-		<poller max-messages-per-poll="1" fixed-delay="3000"/>
+		<poller max-messages-per-poll="1" fixed-delay="10"/>
 		<error-channel ref="testErrorChannel"/>
 	</header-enricher>
 

spring-integration-core/src/test/java/org/springframework/integration/config/xml/HeaderEnricherTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -50,6 +50,7 @@
 /**
  * @author Mark Fisher
  * @author Artem Bilan
+ *
  * @since 2.0
  */
 @ContextConfiguration
@@ -63,8 +64,8 @@ public class HeaderEnricherTests {
 	public void replyChannel() {
 		PollableChannel replyChannel = context.getBean("testReplyChannel", PollableChannel.class);
 		MessageChannel inputChannel = context.getBean("replyChannelInput", MessageChannel.class);
-		inputChannel.send(new GenericMessage<String>("test"));
-		Message<?> result = replyChannel.receive(0);
+		inputChannel.send(new GenericMessage<>("test"));
+		Message<?> result = replyChannel.receive(10000);
 		assertNotNull(result);
 		assertEquals("TEST", result.getPayload());
 		assertEquals(replyChannel, result.getHeaders().getReplyChannel());
@@ -74,8 +75,8 @@ public void replyChannel() {
 	public void replyChannelName() {
 		PollableChannel replyChannel = context.getBean("testReplyChannel", PollableChannel.class);
 		MessageChannel inputChannel = context.getBean("replyChannelNameInput", MessageChannel.class);
-		inputChannel.send(new GenericMessage<String>("test"));
-		Message<?> result = replyChannel.receive(0);
+		inputChannel.send(new GenericMessage<>("test"));
+		Message<?> result = replyChannel.receive(10000);
 		assertNotNull(result);
 		assertEquals("TEST", result.getPayload());
 		assertEquals("testReplyChannel", result.getHeaders().getReplyChannel());
@@ -85,8 +86,8 @@ public void replyChannelName() {
 	public void replyChannelExpression() {
 		PollableChannel replyChannel = context.getBean("testReplyChannel", PollableChannel.class);
 		MessageChannel inputChannel = context.getBean("replyChannelExpressionInput", MessageChannel.class);
-		inputChannel.send(new GenericMessage<String>("test"));
-		Message<?> result = replyChannel.receive(0);
+		inputChannel.send(new GenericMessage<>("test"));
+		Message<?> result = replyChannel.receive(10000);
 		assertNotNull(result);
 		assertEquals("TEST", result.getPayload());
 		assertEquals(replyChannel, result.getHeaders().getReplyChannel());
@@ -96,8 +97,8 @@ public void replyChannelExpression() {
 	public void errorChannel() {
 		PollableChannel errorChannel = context.getBean("testErrorChannel", PollableChannel.class);
 		MessageChannel inputChannel = context.getBean("errorChannelInput", MessageChannel.class);
-		inputChannel.send(new GenericMessage<String>("test"));
-		Message<?> errorMessage = errorChannel.receive(1000);
+		inputChannel.send(new GenericMessage<>("test"));
+		Message<?> errorMessage = errorChannel.receive(10000);
 		assertNotNull(errorMessage);
 		Object errorPayload = errorMessage.getPayload();
 		assertEquals(MessageTransformationException.class, errorPayload.getClass());
@@ -110,7 +111,7 @@ public void errorChannel() {
 	public void correlationIdValue() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("correlationIdValueInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals("ABC", new IntegrationMessageHeaderAccessor(result).getCorrelationId());
 	}
@@ -119,7 +120,7 @@ public void correlationIdValue() {
 	public void correlationIdValueWithType() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("correlationIdValueWithTypeInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		Object correlationId = new IntegrationMessageHeaderAccessor(result).getCorrelationId();
 		assertEquals(Long.class, correlationId.getClass());
@@ -130,7 +131,7 @@ public void correlationIdValueWithType() {
 	public void correlationIdRef() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("correlationIdRefInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(123, new IntegrationMessageHeaderAccessor(result).getCorrelationId());
 	}
@@ -139,7 +140,7 @@ public void correlationIdRef() {
 	public void expirationDateValue() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("expirationDateValueInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(new Long(1111), new IntegrationMessageHeaderAccessor(result).getExpirationDate());
 	}
@@ -148,7 +149,7 @@ public void expirationDateValue() {
 	public void expirationDateRef() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("expirationDateRefInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(new Long(9999), new IntegrationMessageHeaderAccessor(result).getExpirationDate());
 	}
@@ -157,7 +158,7 @@ public void expirationDateRef() {
 	public void priority() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("priorityInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(new Integer(42), new IntegrationMessageHeaderAccessor(result).getPriority());
 	}
@@ -167,7 +168,7 @@ public void priorityExpression() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("priorityExpressionInput", MessageChannel.class);
 		Message<?> result = template.sendAndReceive(channel,
-				new GenericMessage<Map<String, String>>(Collections.singletonMap("priority", "-10")));
+				new GenericMessage<>(Collections.singletonMap("priority", "-10")));
 		assertNotNull(result);
 		assertEquals(new Integer(-10), new IntegrationMessageHeaderAccessor(result).getPriority());
 	}
@@ -176,7 +177,7 @@ public void priorityExpression() {
 	public void expressionUsingPayload() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("payloadExpressionInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<TestBean>(new TestBean("foo")));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>(new TestBean("foo")));
 		assertNotNull(result);
 		assertEquals("foobar", result.getHeaders().get("testHeader"));
 	}
@@ -195,7 +196,7 @@ public void expressionUsingHeader() {
 	public void expressionWithDateType() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("expressionWithDateTypeInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		Object headerValue = result.getHeaders().get("currentDate");
 		assertEquals(Date.class, headerValue.getClass());
@@ -207,7 +208,7 @@ public void expressionWithDateType() {
 	public void expressionWithLongType() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("expressionWithLongTypeInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(Long.class, result.getHeaders().get("number").getClass());
 		assertEquals(12345L, result.getHeaders().get("number"));
@@ -217,7 +218,7 @@ public void expressionWithLongType() {
 	public void refWithMethod() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("refWithMethod", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(String.class, result.getHeaders().get("testHeader").getClass());
 		assertEquals("testBeanForMethodInvoker", result.getHeaders().get("testHeader"));
@@ -227,7 +228,7 @@ public void refWithMethod() {
 	public void ref() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("ref", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(TestBean.class, result.getHeaders().get("testHeader").getClass());
 		TestBean testBeanForRef = context.getBean("testBean1", TestBean.class);
@@ -238,7 +239,7 @@ public void ref() {
 	public void innerBean() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("innerBean", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(TestBean.class, result.getHeaders().get("testHeader").getClass());
 		TestBean testBeanForInnerBean = new TestBean("testBeanForInnerBean");
@@ -249,7 +250,7 @@ public void innerBean() {
 	public void innerBeanWithMethod() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("innerBeanWithMethod", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		assertEquals(String.class, result.getHeaders().get("testHeader").getClass());
 		assertEquals("testBeanForInnerBeanWithMethod", result.getHeaders().get("testHeader"));
@@ -265,7 +266,7 @@ public void testFailConfigUnexpectedSubElement() {
 	public void testRoutingSlip() {
 		MessagingTemplate template = new MessagingTemplate();
 		MessageChannel channel = context.getBean("routingSlipInput", MessageChannel.class);
-		Message<?> result = template.sendAndReceive(channel, new GenericMessage<String>("test"));
+		Message<?> result = template.sendAndReceive(channel, new GenericMessage<>("test"));
 		assertNotNull(result);
 		Object routingSlip = new IntegrationMessageHeaderAccessor(result)
 				.getHeader(IntegrationMessageHeaderAccessor.ROUTING_SLIP);
@@ -311,6 +312,7 @@ public boolean equals(Object o) {
 		public int hashCode() {
 			return name != null ? name.hashCode() : 0;
 		}
+
 	}
 
 }

spring-integration-feed/src/main/java/org/springframework/integration/feed/inbound/FeedEntryMessageSource.java

@@ -28,11 +28,10 @@
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.core.io.Resource;
 import org.springframework.integration.context.IntegrationContextUtils;
-import org.springframework.integration.context.IntegrationObjectSupport;
 import org.springframework.integration.core.MessageSource;
+import org.springframework.integration.endpoint.AbstractMessageSource;
 import org.springframework.integration.metadata.MetadataStore;
 import org.springframework.integration.metadata.SimpleMetadataStore;
-import org.springframework.messaging.Message;
 import org.springframework.messaging.MessagingException;
 import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
@@ -55,7 +54,7 @@
  *
  * @since 2.0
  */
-public class FeedEntryMessageSource extends IntegrationObjectSupport implements MessageSource<SyndEntry> {
+public class FeedEntryMessageSource extends AbstractMessageSource<SyndEntry> {
 
 	private final URL feedUrl;
 
@@ -145,18 +144,7 @@ public String getComponentType() {
 	}
 
 	@Override
-	public Message<SyndEntry> receive() {
-		Assert.isTrue(this.initialized,
-				"'FeedEntryReaderMessageSource' must be initialized before it can produce Messages.");
-		SyndEntry entry = doReceive();
-		if (entry == null) {
-			return null;
-		}
-		return this.getMessageBuilderFactory().withPayload(entry).build();
-	}
-
-	@Override
-	protected void onInit() throws Exception {
+	protected void onInit() {
 		if (this.metadataStore == null) {
 			// first try to look for a 'messageStore' in the context
 			BeanFactory beanFactory = this.getBeanFactory();
@@ -176,13 +164,16 @@ protected void onInit() throws Exception {
 		this.initialized = true;
 	}
 
-	private SyndEntry doReceive() {
+	@Override
+	protected SyndEntry doReceive() {
+		Assert.isTrue(this.initialized,
+				"'FeedEntryReaderMessageSource' must be initialized before it can produce Messages.");
 		SyndEntry nextEntry = null;
 		synchronized (this.monitor) {
 			nextEntry = getNextEntry();
 			if (nextEntry == null) {
 				// read feed and try again
-				this.populateEntryList();
+				populateEntryList();
 				nextEntry = getNextEntry();
 			}
 		}

spring-integration-feed/src/test/java/org/springframework/integration/feed/inbound/FeedEntryMessageSourceTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -75,7 +75,7 @@ public void testReceiveFeedWithNoEntries() throws Exception {
 	public void testReceiveFeedWithEntriesSorted() throws Exception {
 		ClassPathResource resource = new ClassPathResource("org/springframework/integration/feed/sample.rss");
 		FeedEntryMessageSource source = new FeedEntryMessageSource(resource, "foo");
-		source.setComponentName("feedReader");
+		source.setBeanName("feedReader");
 		source.setBeanFactory(mock(BeanFactory.class));
 		source.afterPropertiesSet();
 		Message<SyndEntry> message1 = source.receive();