Polishing; PR Comments

Also add/remove factories.

Author: garyrussell

spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryFactory.java renamed to spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryLocator.java

@@ -19,32 +19,52 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * The default implementation of {@link SessionFactoryFactory} using a simple map lookup.
+ * The default implementation of {@link SessionFactoryLocator} using a simple map lookup
+ * and an optional default to fall back on.
  *
  * @author Gary Russell
  * @since 4.2
  *
  */
-public class DefaultSessionFactoryFactory<F> implements SessionFactoryFactory<F> {
+public class DefaultSessionFactoryLocator<F> implements SessionFactoryLocator<F> {
 
 	private final Map<Object, SessionFactory<F>> factories = new ConcurrentHashMap<Object, SessionFactory<F>>();
 
 	private final SessionFactory<F> defaultFactory;
 
-	public DefaultSessionFactoryFactory(Map<Object, SessionFactory<F>> factories) {
+	/**
+	 * @param factories A map of factories, keyed by lookup key.
+	 */
+	public DefaultSessionFactoryLocator(Map<Object, SessionFactory<F>> factories) {
 		this(factories, null);
 	}
 
-	public DefaultSessionFactoryFactory(Map<Object, SessionFactory<F>> factories, Object defaultKey) {
+	/**
+	 * @param factories A map of factories, keyed by lookup key.
+	 * @param defaultFactory A default to be used if the lookup fails.
+	 */
+	public DefaultSessionFactoryLocator(Map<Object, SessionFactory<F>> factories, SessionFactory<F> defaultFactory) {
 		this.factories.putAll(factories);
-		if (defaultKey != null) {
-			this.defaultFactory = factories.get(defaultKey);
-		}
-		else {
-			this.defaultFactory = null;
-		}
+		this.defaultFactory = defaultFactory;
 	}
 
+	/**
+	 * Add a session factory.
+	 * @param key the lookup key.
+	 * @param factory the factory.
+	 */
+	public void addSessionFactory(String key, SessionFactory<F> factory) {
+		this.factories.put(key, factory);
+	}
+
+	/**
+	 * Remove a session factory.
+	 * @param key the lookup key.
+	 * @return the factory, if it was present.
+	 */
+	public SessionFactory<F> removeSessionFactory(Object key) {
+		return this.factories.remove(key);
+	}
 
 	@Override
 	public SessionFactory<F> getSessionFactory(Object key) {

spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DelegatingSessionFactory.java

@@ -22,35 +22,43 @@
 
 /**
  * {@link SessionFactory} that delegates to a {@link SessionFactory} retrieved from a
- * {@link SessionFactoryFactory}.
+ * {@link SessionFactoryLocator}.
  *
  * @author Gary Russell
  * @since 4.2
  *
  */
 public class DelegatingSessionFactory<F> implements SessionFactory<F> {
 
-	private final SessionFactoryFactory<F> factoryFactory;
+	private final SessionFactoryLocator<F> factoryLocator;
 
 	private final ThreadLocal<Object> threadKey = new ThreadLocal<Object>();
 
 	/**
-	 * Construct an instance with a {@link DefaultSessionFactoryFactory} using the
+	 * Construct an instance with a {@link DefaultSessionFactoryLocator} using the
 	 * supplied factories and default key.
 	 * @param factories the factories.
-	 * @param defaultKey the default key.
+	 * @param defaultFactory the default to use if the lookup fails.
 	 */
-	public DelegatingSessionFactory(Map<Object, SessionFactory<F>> factories, Object defaultKey) {
-		this(new DefaultSessionFactoryFactory<F>(factories, defaultKey));
+	public DelegatingSessionFactory(Map<Object, SessionFactory<F>> factories, SessionFactory<F> defaultFactory) {
+		this(new DefaultSessionFactoryLocator<F>(factories, defaultFactory));
 	}
 
 	/**
 	 * Construct an instance using the supplied factory.
-	 * @param factoryFactory the factory.
+	 * @param factoryLocator the factory.
 	 */
-	public DelegatingSessionFactory(SessionFactoryFactory<F> factoryFactory) {
-		Assert.notNull(factoryFactory, "'factoryFactory' cannot be null");
-		this.factoryFactory = factoryFactory;
+	public DelegatingSessionFactory(SessionFactoryLocator<F> factoryLocator) {
+		Assert.notNull(factoryLocator, "'factoryFactory' cannot be null");
+		this.factoryLocator = factoryLocator;
+	}
+
+	/**
+	 * Return this factory's locator.
+	 * @return the locator.
+	 */
+	public SessionFactoryLocator<F> getFactoryLocator() {
+		return factoryLocator;
 	}
 
 	/**
@@ -97,7 +105,7 @@ public Session<F> getSession() {
 	}
 
 	public Session<F> getSession(Object key) {
-		SessionFactory<F> sessionFactory = this.factoryFactory.getSessionFactory(key);
+		SessionFactory<F> sessionFactory = this.factoryLocator.getSessionFactory(key);
 		Assert.notNull(sessionFactory, "No default SessionFactory configured");
 		return sessionFactory.getSession();
 	}

spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryFactory.java renamed to spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryLocator.java

@@ -23,7 +23,7 @@
  * @since 4.2
  *
  */
-public interface SessionFactoryFactory<F> {
+public interface SessionFactoryLocator<F> {
 
 	/**
 	 * Return a {@link SessionFactory} for the key.

spring-integration-file/src/test/java/org/springframework/integration/file/remote/session/DelegatingSessionFactoryTests.java

@@ -18,6 +18,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertSame;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 
@@ -70,15 +71,24 @@ public class DelegatingSessionFactoryTests {
 	@Autowired
 	PollableChannel out;
 
+	@Autowired
+	DefaultSessionFactoryLocator<String> sessionFactoryLocator;
+
 	@Test
 	public void testDelegates() {
-		assertEquals(foo.mockSession, dsf.getSession("foo"));
-		assertEquals(bar.mockSession, dsf.getSession("bar"));
-		assertEquals(bar.mockSession, dsf.getSession("junk"));
-		assertEquals(bar.mockSession, dsf.getSession());
-		dsf.setThreadKey("foo");
-		assertEquals(foo.mockSession, dsf.getSession("foo"));
-		dsf.clearThreadKey();
+		assertEquals(foo.mockSession, this.dsf.getSession("foo"));
+		assertEquals(bar.mockSession, this.dsf.getSession("bar"));
+		assertEquals(bar.mockSession, this.dsf.getSession("junk"));
+		assertEquals(bar.mockSession, this.dsf.getSession());
+		this.dsf.setThreadKey("foo");
+		assertEquals(foo.mockSession, this.dsf.getSession("foo"));
+		this.dsf.clearThreadKey();
+		TestSessionFactory factory = new TestSessionFactory();
+		this.sessionFactoryLocator.addSessionFactory("baz", factory);
+		this.dsf.setThreadKey("baz");
+		assertEquals(factory.mockSession, this.dsf.getSession("baz"));
+		this.dsf.clearThreadKey();
+		assertSame(factory, sessionFactoryLocator.removeSessionFactory("baz"));
 	}
 
 	@Test
@@ -107,11 +117,18 @@ TestSessionFactory bar() {
 
 		@Bean
 		DelegatingSessionFactory<String> dsf() {
+			SessionFactoryLocator<String> sff = sessionFactoryLocator();
+			return new DelegatingSessionFactory<String>(sff);
+		}
+
+		@Bean
+		public SessionFactoryLocator<String> sessionFactoryLocator() {
 			Map<Object, SessionFactory<String>> factories = new HashMap<Object, SessionFactory<String>>();
 			factories.put("foo", foo());
-			factories.put("bar", bar());
-			SessionFactoryFactory<String> sff = new DefaultSessionFactoryFactory<String>(factories, "bar");
-			return new DelegatingSessionFactory<String>(sff);
+			TestSessionFactory bar = bar();
+			factories.put("bar", bar);
+			SessionFactoryLocator<String> sff = new DefaultSessionFactoryLocator<String>(factories, bar);
+			return sff;
 		}
 
 		@ServiceActivator(inputChannel="c1")

src/reference/asciidoc/ftp.adoc

@@ -135,7 +135,11 @@ Convenience methods have been added so this can easily be done from a message fl
 [source, xml]
 ----
 <bean id="dsf" class="org.springframework.integration.file.remote.session.DelegatingSessionFactory">
-    <!-- delegate factories here -->
+    <constructor-arg>
+        <bean class="o.s.i.file.remote.session.DefaultSessionFactoryLocator">
+		    <!-- delegate factories here -->
+        </bean>
+    </constructor-arg>
 </bean>
 
 <int:service-activator input-channel="in" output-channel="c1"

src/reference/asciidoc/sftp.adoc

@@ -173,7 +173,11 @@ Convenience methods have been added so this can easily be done from a message fl
 [source, xml]
 ----
 <bean id="dsf" class="org.springframework.integration.file.remote.session.DelegatingSessionFactory">
-    <!-- delegate factories here -->
+    <constructor-arg>
+        <bean class="o.s.i.file.remote.session.DefaultSessionFactoryLocator">
+		    <!-- delegate factories here -->
+        </bean>
+    </constructor-arg>
 </bean>
 
 <int:service-activator input-channel="in" output-channel="c1"