INT-3129: FTP local-filename-generator-expression

* Add `local-filename-generator-expression` attribute to FTP and SFTP Outbound Gateway
* Refactoring for `(S)FtpOutboundGatewayParser`
* Add `local-filename-generator-expression` tests
* Add 'What's New' and attribute description

JIRA: https://jira.springsource.org/browse/INT-3129

Polishing

Doc Polishing

Assert attribute is only set for get/mget

Move tests to the get gateways

spring-integration-ftp/src/main/java/org/springframework/integration/ftp/config/FtpOutboundGatewayParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2013 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,28 +16,30 @@
 package org.springframework.integration.ftp.config;
 
 import org.springframework.integration.file.config.AbstractRemoteFileOutboundGatewayParser;
+import org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter;
+import org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter;
+import org.springframework.integration.ftp.gateway.FtpOutboundGateway;
 
 /**
  * @author Gary Russell
+ * @author Artem Bilan
  * @since 2.1
  *
  */
 public class FtpOutboundGatewayParser extends AbstractRemoteFileOutboundGatewayParser {
 
-	private static final String BASE_PACKAGE = "org.springframework.integration.ftp";
-
 	public String getGatewayClassName() {
-		return BASE_PACKAGE + ".gateway.FtpOutboundGateway";
+		return FtpOutboundGateway.class.getName();
 	}
 
 	@Override
-	protected String getSimplePatternFileListFilterClassname() {
-		return BASE_PACKAGE + ".filters.FtpSimplePatternFileListFilter";
+	protected String getSimplePatternFileListFilterClassName() {
+		return FtpSimplePatternFileListFilter.class.getName();
 	}
 
 	@Override
-	protected String getRegexPatternFileListFilterClassname() {
-		return BASE_PACKAGE + ".filters.FtpRegexPatternFileListFilter";
+	protected String getRegexPatternFileListFilterClassName() {
+		return FtpRegexPatternFileListFilter.class.getName();
 	}
 
 }

spring-integration-ftp/src/main/resources/org/springframework/integration/ftp/config/spring-integration-ftp-3.0.xsd

@@ -394,6 +394,21 @@
 							</xsd:documentation>
 						</xsd:annotation>
 					</xsd:attribute>
+					<xsd:attribute name="local-filename-generator-expression" type="xsd:string">
+						<xsd:annotation>
+							<xsd:documentation>
+								Allows you to provide a SpEL expression to
+								generate the file name of
+								the local (transferred) file. The root
+								object of the SpEL
+								evaluation is the request Message, but the name of the original
+								remote file is also provided as the 'remoteFileName' variable.
+								For example, a valid expression would be:
+								"#remoteFileName.toUpperCase() + headers.foo".
+								Only used with 'get' and 'mget' commands.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 					<xsd:attribute name="local-directory" type="xsd:string">
 						<xsd:annotation>
 							<xsd:documentation>

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/config/FtpOutboundGatewayParserTests-context.xml

@@ -31,6 +31,10 @@
 		order="1"
 		/>
 
+	<bean id="fooString" class="java.lang.String">
+		<constructor-arg value="foo" />
+	</bean>
+
 	<int-ftp:outbound-gateway id="gateway2"
 		local-directory="local-test-dir"
 		session-factory="csf"
@@ -44,6 +48,7 @@
 		expression="payload"
 		order="2"
 		requires-reply="false"
+		local-filename-generator-expression="#remoteFileName.toUpperCase() + '.a' + @fooString"
 		>
 		<int-ftp:request-handler-advice-chain>
 			<bean class="org.springframework.integration.ftp.config.FtpOutboundGatewayParserTests$FooAdvice" />

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/config/FtpOutboundGatewayParserTests.java

@@ -21,10 +21,13 @@ import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 
 import java.io.File;
+import java.lang.reflect.Method;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicReference;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.integration.Message;
 import org.springframework.integration.endpoint.AbstractEndpoint;
@@ -39,6 +42,7 @@ import org.springframework.integration.support.MessageBuilder;
 import org.springframework.integration.test.util.TestUtils;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.util.ReflectionUtils;
 
 /**
  * @author Gary Russell
@@ -77,8 +81,9 @@ public class FtpOutboundGatewayParserTests {
 		assertFalse((Boolean) TestUtils.getPropertyValue(gateway, "autoCreateLocalDirectory"));
 		assertNotNull(TestUtils.getPropertyValue(gateway, "filter"));
 		assertEquals(Command.LS, TestUtils.getPropertyValue(gateway, "command"));
+
 		@SuppressWarnings("unchecked")
-		Set<String> options = TestUtils.getPropertyValue(gateway, "options", Set.class);
+		Set<Option> options = TestUtils.getPropertyValue(gateway, "options", Set.class);
 		assertTrue(options.contains(Option.NAME_ONLY));
 		assertTrue(options.contains(Option.NOSORT));
 
@@ -88,7 +93,7 @@ public class FtpOutboundGatewayParserTests {
 	}
 
 	@Test
-	public void testGateway2() {
+	public void testGateway2() throws Exception {
 		FtpOutboundGateway gateway = TestUtils.getPropertyValue(gateway2,
 				"handler", FtpOutboundGateway.class);
 		assertEquals("X", TestUtils.getPropertyValue(gateway, "remoteFileSeparator"));
@@ -104,6 +109,21 @@ public class FtpOutboundGatewayParserTests {
 		gateway.handleMessage(new GenericMessage<String>("foo"));
 		assertFalse(TestUtils.getPropertyValue(gateway, "requiresReply", Boolean.class));
 		assertEquals(1, adviceCalled);
+
+		//INT-3129
+		assertNotNull(TestUtils.getPropertyValue(gateway, "localFilenameGeneratorExpression"));
+		final AtomicReference<Method> genMethod = new AtomicReference<Method>();
+		ReflectionUtils.doWithMethods(FtpOutboundGateway.class, new ReflectionUtils.MethodCallback() {
+
+			@Override
+			public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
+				if ("generateLocalFileName".equals(method.getName())) {
+					method.setAccessible(true);
+					genMethod.set(method);
+				}
+			}
+		});
+		assertEquals("FOO.afoo", genMethod.get().invoke(gateway, new GenericMessage<String>(""), "foo"));
 	}
 
 	@Test