Merge pull request #524 from garyrussell/INT-2636

* garyrussell-INT-2636:
  INT-2636 Gateway Timeout Changes

spring-integration-core/src/main/java/org/springframework/integration/annotation/Gateway.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -43,6 +43,7 @@ import java.lang.annotation.Target;
  * the return value if necessary.
  *
  * @author Mark Fisher
+ * @author Gary Russell
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
@@ -54,8 +55,8 @@ public @interface Gateway {
 
 	String replyChannel() default "";
 
-	long requestTimeout() default -1;
+	long requestTimeout() default Long.MIN_VALUE;
 
-	long replyTimeout() default -1;
+	long replyTimeout() default Long.MIN_VALUE;
 
 }

spring-integration-core/src/main/java/org/springframework/integration/gateway/GatewayProxyFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -66,6 +66,7 @@ import org.springframework.util.StringUtils;
  *
  * @author Mark Fisher
  * @author Oleg Zhurakousky
+ * @author Gary Russell
  */
 public class GatewayProxyFactoryBean extends AbstractEndpoint implements TrackableComponent, FactoryBean<Object>, MethodInterceptor, BeanClassLoaderAware {
 
@@ -77,9 +78,9 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Trackab
 
 	private volatile MessageChannel errorChannel;
 
-	private volatile long defaultRequestTimeout = -1;
+	private volatile Long defaultRequestTimeout;
 
-	private volatile long defaultReplyTimeout = -1;
+	private volatile Long defaultReplyTimeout;
 
 	private volatile ChannelResolver channelResolver;
 
@@ -336,8 +337,8 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Trackab
 		Gateway gatewayAnnotation = method.getAnnotation(Gateway.class);
 		MessageChannel requestChannel = this.defaultRequestChannel;
 		MessageChannel replyChannel = this.defaultReplyChannel;
-		long requestTimeout = this.defaultRequestTimeout;
+		Long requestTimeout = this.defaultRequestTimeout;
-		long replyTimeout = this.defaultReplyTimeout;
+		Long replyTimeout = this.defaultReplyTimeout;
 		String payloadExpression = null;
 		Map<String, Expression> headerExpressions = null;
 		if (gatewayAnnotation != null) {
@@ -349,8 +350,19 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Trackab
 			if (StringUtils.hasText(replyChannelName)) {
 				replyChannel = this.resolveChannelName(replyChannelName);
 			}
-			requestTimeout = gatewayAnnotation.requestTimeout();
+			/*
-			replyTimeout = gatewayAnnotation.replyTimeout();
+			 * INT-2636 Unspecified annotation attributes should not
+			 * override the default values supplied by explicit configuration.
+			 * There is a small risk that someone has used Long.MIN_VALUE explicitly
+			 * to indicate an indefinite timeout on a gateway method and that will
+			 * no longer work as expected; they will need to use, say, -1 instead.
+			 */
+			if (requestTimeout == null || gatewayAnnotation.requestTimeout() != Long.MIN_VALUE) {
+				requestTimeout = gatewayAnnotation.requestTimeout();
+			}
+			if (replyTimeout == null || gatewayAnnotation.replyTimeout() != Long.MIN_VALUE) {
+				replyTimeout = gatewayAnnotation.replyTimeout();
+			}
 		}
 		else if (methodMetadataMap != null && methodMetadataMap.size() > 0) {
 			GatewayMethodMetadata methodMetadata = methodMetadataMap.get(method.getName());
@@ -388,8 +400,18 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Trackab
 		gateway.setBeanName(this.getComponentName());
 		gateway.setRequestChannel(requestChannel);
 		gateway.setReplyChannel(replyChannel);
-		gateway.setRequestTimeout(requestTimeout);
+		if (requestTimeout == null) {
-		gateway.setReplyTimeout(replyTimeout);
+			gateway.setRequestTimeout(-1);
+		}
+		else {
+			gateway.setRequestTimeout(requestTimeout);
+		}
+		if (replyTimeout == null) {
+			gateway.setReplyTimeout(-1);
+		}
+		else {
+			gateway.setReplyTimeout(replyTimeout);
+		}
 		if (this.getBeanFactory() != null) {
 			gateway.setBeanFactory(this.getBeanFactory());
 		}

spring-integration-core/src/test/java/org/springframework/integration/gateway/GatewayXmlAndAnnotationTests-context.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
+
+	<int:gateway service-interface="org.springframework.integration.gateway.GatewayXmlAndAnnotationTests.AGateway"
+		default-reply-timeout="123" default-request-channel="nullChannel">
+		<int:method name="explicitTimeoutShouldOverrideDefault" reply-timeout="456" />
+	</int:gateway>
+
+</beans>

spring-integration-core/src/test/java/org/springframework/integration/gateway/GatewayXmlAndAnnotationTests.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2002-2012 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
+ *
+ *      http://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.integration.gateway;
+
+import static org.junit.Assert.assertEquals;
+
+import java.lang.reflect.Method;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.integration.annotation.Gateway;
+import org.springframework.integration.test.util.TestUtils;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+/**
+ * @author Gary Russell
+ * @since 2.2
+ *
+ */
+@ContextConfiguration
+@RunWith(SpringJUnit4ClassRunner.class)
+public class GatewayXmlAndAnnotationTests {
+
+	@Autowired
+	GatewayProxyFactoryBean gatewayProxyFactoryBean;
+
+	@Test
+	public void test() {
+		assertEquals(123L, TestUtils.getPropertyValue(gatewayProxyFactoryBean, "defaultReplyTimeout"));
+		@SuppressWarnings("unchecked")
+		Map<Method, MessagingGatewaySupport> gatewayMap = TestUtils.getPropertyValue(gatewayProxyFactoryBean,
+				"gatewayMap", Map.class);
+		int assertions = 0;
+		for (Entry<Method, MessagingGatewaySupport> entry : gatewayMap.entrySet()) {
+			if (entry.getKey().getName().equals("annotationShouldntOverrideDefault")) {
+				assertEquals(123L, TestUtils.getPropertyValue(entry.getValue(),
+						"replyTimeout"));
+				assertions++;
+			}
+			else if (entry.getKey().getName().equals("annotationShouldOverrideDefault")) {
+				assertEquals(234L, TestUtils.getPropertyValue(entry.getValue(),
+						"replyTimeout"));
+				assertions++;
+			}
+			else if (entry.getKey().getName().equals("annotationShouldOverrideDefaultToInfinity")) {
+				assertEquals(-1L, TestUtils.getPropertyValue(entry.getValue(),
+						"replyTimeout"));
+				assertions++;
+			}
+			else if (entry.getKey().getName().equals("explicitTimeoutShouldOverrideDefault")) {
+				assertEquals(456L, TestUtils.getPropertyValue(entry.getValue(),
+						"replyTimeout"));
+				assertions++;
+			}
+		}
+		assertEquals(4, assertions);
+	}
+
+	public static interface AGateway {
+		@Gateway
+		String annotationShouldntOverrideDefault(String foo);
+
+		@Gateway(replyTimeout=234)
+		String annotationShouldOverrideDefault(String foo);
+
+		@Gateway(replyTimeout=-1)
+		String annotationShouldOverrideDefaultToInfinity(String foo);
+
+		String explicitTimeoutShouldOverrideDefault(String foo);
+	}
+}