INT-4519: Improve JMS inbound-c-a receiveTimeout (#2540)

* INT-4519: Improve JMS inbound-c-a receiveTimeout

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

* Modify `DynamicJmsTemplate` to default for `-1` if we get
`CachingConnectionFactory` and it is with `cacheConsumers`, otherwise
1 second
* Polishing for some JMS XML parsers, in particular remove
`receiveTimeout` population

**Cherry-pick to 5.0.x**

* * Polishing according PR comments

* * Properly use a `CachingConnectionFactory` in `JmsTests`

Author: artembilan

spring-integration-jms/src/main/java/org/springframework/integration/jms/DynamicJmsTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -16,7 +16,11 @@
 
 package org.springframework.integration.jms;
 
+import javax.jms.ConnectionFactory;
+
+import org.springframework.jms.connection.CachingConnectionFactory;
 import org.springframework.jms.core.JmsTemplate;
+import org.springframework.jms.support.destination.JmsDestinationAccessor;
 import org.springframework.util.Assert;
 
 /**
@@ -27,6 +31,30 @@
  */
 public class DynamicJmsTemplate extends JmsTemplate {
 
+	private static final long NO_CACHING_RECEIVE_TIMEOUT = 1000L;
+
+	private boolean receiveTimeoutExplicitlySet;
+
+	@Override
+	public void setReceiveTimeout(long receiveTimeout) {
+		super.setReceiveTimeout(receiveTimeout);
+		this.receiveTimeoutExplicitlySet = true;
+	}
+
+	@Override
+	public void setConnectionFactory(ConnectionFactory connectionFactory) {
+		super.setConnectionFactory(connectionFactory);
+		if (!this.receiveTimeoutExplicitlySet) {
+			if (connectionFactory instanceof CachingConnectionFactory &&
+					((CachingConnectionFactory) connectionFactory).isCacheConsumers()) {
+				super.setReceiveTimeout(JmsDestinationAccessor.RECEIVE_TIMEOUT_NO_WAIT);
+			}
+			else {
+				super.setReceiveTimeout(NO_CACHING_RECEIVE_TIMEOUT);
+			}
+		}
+	}
+
 	@Override
 	public int getPriority() {
 		Integer priority = DynamicJmsTemplateProperties.getPriority();

spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsInboundChannelAdapterParser.java

@@ -50,7 +50,6 @@ protected BeanMetadataElement parseSource(Element element, ParserContext parserC
 		String jmsTemplate = element.getAttribute(JmsParserUtils.JMS_TEMPLATE_ATTRIBUTE);
 		String destination = element.getAttribute(JmsParserUtils.DESTINATION_ATTRIBUTE);
 		String destinationName = element.getAttribute(JmsParserUtils.DESTINATION_NAME_ATTRIBUTE);
-		String headerMapper = element.getAttribute(JmsParserUtils.HEADER_MAPPER_ATTRIBUTE);
 		boolean hasJmsTemplate = StringUtils.hasText(jmsTemplate);
 		boolean hasDestinationRef = StringUtils.hasText(destination);
 		boolean hasDestinationName = StringUtils.hasText(destinationName);
@@ -80,9 +79,7 @@ else if (!hasJmsTemplate) {
 					+ JmsParserUtils.DESTINATION_NAME_ATTRIBUTE +
 					"' attributes must be provided for a polling JMS adapter", parserContext.extractSource(element));
 		}
-		if (StringUtils.hasText(headerMapper)) {
-			builder.addPropertyReference(JmsParserUtils.HEADER_MAPPER_PROPERTY, headerMapper);
-		}
+		IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, JmsParserUtils.HEADER_MAPPER_ATTRIBUTE);
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "selector", "messageSelector");
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "extract-payload");
 		return builder.getBeanDefinition();

spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsOutboundChannelAdapterParser.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.
@@ -32,6 +32,7 @@
  *
  * @author Mark Fisher
  * @author Gary Russell
+ * @author Artem Bilan
  */
 public class JmsOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser {
 
@@ -42,7 +43,6 @@ protected AbstractBeanDefinition parseConsumer(Element element, ParserContext pa
 		String destination = element.getAttribute(JmsParserUtils.DESTINATION_ATTRIBUTE);
 		String destinationName = element.getAttribute(JmsParserUtils.DESTINATION_NAME_ATTRIBUTE);
 		String destinationExpression = element.getAttribute(JmsParserUtils.DESTINATION_EXPRESSION_ATTRIBUTE);
-		String headerMapper = element.getAttribute(JmsParserUtils.HEADER_MAPPER_ATTRIBUTE);
 		boolean hasJmsTemplate = StringUtils.hasText(jmsTemplate);
 		boolean hasDestinationRef = StringUtils.hasText(destination);
 		boolean hasDestinationName = StringUtils.hasText(destinationName);
@@ -79,9 +79,8 @@ else if (!hasJmsTemplate) {
 					JmsParserUtils.DESTINATION_EXPRESSION_ATTRIBUTE +
 					"' attributes must be provided", parserContext.extractSource(element));
 		}
-		if (StringUtils.hasText(headerMapper)) {
-			builder.addPropertyReference(JmsParserUtils.HEADER_MAPPER_PROPERTY, headerMapper);
-		}
+
+		IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, JmsParserUtils.HEADER_MAPPER_ATTRIBUTE);
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "extract-payload");
 		return builder.getBeanDefinition();
 	}

spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsParserUtils.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.
@@ -23,14 +23,14 @@
 import org.springframework.beans.factory.xml.ParserContext;
 import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
 import org.springframework.integration.jms.DynamicJmsTemplate;
-import org.springframework.jms.core.JmsTemplate;
 import org.springframework.util.StringUtils;
 
 /**
  * Utility methods and constants for JMS adapter parsers.
  *
  * @author Mark Fisher
  * @author Gary Russell
+ * @author Artem Bilan
  */
 abstract class JmsParserUtils {
 
@@ -63,7 +63,7 @@ abstract class JmsParserUtils {
 	static final String HEADER_MAPPER_PROPERTY = "headerMapper";
 
 	private static final String[] JMS_TEMPLATE_ATTRIBUTES = {
-		"connection-factory", "message-converter", "destination-resolver", "pub-sub-domain",
+			CONNECTION_FACTORY_ATTRIBUTE, "message-converter", "destination-resolver", PUB_SUB_DOMAIN_ATTRIBUTE,
 		"time-to-live", "priority", "delivery-persistent", "explicit-qos-enabled", "acknowledge",
 		"receive-timeout", "session-transacted"
 	};
@@ -86,18 +86,12 @@ static BeanDefinition parseJmsTemplateBeanDefinition(Element element, ParserCont
 				determineConnectionFactoryBeanName(element, parserContext));
 		IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "message-converter");
 		IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "destination-resolver");
-		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "pub-sub-domain");
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, PUB_SUB_DOMAIN_ATTRIBUTE);
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "time-to-live");
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "priority");
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "delivery-persistent");
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "explicit-qos-enabled");
-		String receiveTimeout = element.getAttribute("receive-timeout");
-		if (StringUtils.hasText(receiveTimeout)) {
-			builder.addPropertyValue("receiveTimeout", receiveTimeout);
-		}
-		else {
-			builder.addPropertyValue("receiveTimeout", JmsTemplate.RECEIVE_TIMEOUT_NO_WAIT);
-		}
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "receive-timeout");
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "session-transacted");
 		return builder.getBeanDefinition();
 	}