From 9f3f0a91bf8340bafba9a5a519c44f502766f4b0 Mon Sep 17 00:00:00 2001 From: Josh Long Date: Wed, 18 Aug 2010 05:45:09 +0000 Subject: [PATCH] I can be so forgetful sometimes! I've just changed *SFTP* -> *Sftp*. Looks *much* better now and feels more like the Spring I know and love. --- ...r.java => AbstractSftpFileListFilter.java} | 2 +- ...r.java => CompositeFtpFileListFilter.java} | 16 ++++---- ...=> PatternMatchingSftpFileListFilter.java} | 2 +- ...onPool.java => QueuedSftpSessionPool.java} | 24 ++++++------ ...{SFTPConstants.java => SftpConstants.java} | 4 +- ...istFilter.java => SftpFileListFilter.java} | 2 +- ...izer.java => SftpInboundSynchronizer.java} | 18 ++++----- ...sageSource.java => SftpMessageSource.java} | 19 ++++------ ...er.java => SftpSendingMessageHandler.java} | 17 ++++----- .../{SFTPSession.java => SftpSession.java} | 10 ++--- ...onFactory.java => SftpSessionFactory.java} | 14 +++---- ...PSessionPool.java => SftpSessionPool.java} | 10 ++--- ...ftpMessageSendingConsumerFactoryBean.java} | 20 +++++----- ...java => SftpMessageSourceFactoryBean.java} | 38 +++++++++---------- ...Handler.java => SftpNamespaceHandler.java} | 7 ++-- ...essionUtils.java => SftpSessionUtils.java} | 14 +++---- .../main/resources/META-INF/spring.handlers | 2 +- .../integration/sftp/TestSFTPReceipt.java | 15 +++----- 18 files changed, 109 insertions(+), 125 deletions(-) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{AbstractSFTPFileListFilter.java => AbstractSftpFileListFilter.java} (95%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{CompositeFTPFileListFilter.java => CompositeFtpFileListFilter.java} (74%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{PatternMatchingSFTPFileListFilter.java => PatternMatchingSftpFileListFilter.java} (95%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{QueuedSFTPSessionPool.java => QueuedSftpSessionPool.java} (75%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPConstants.java => SftpConstants.java} (96%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPFileListFilter.java => SftpFileListFilter.java} (96%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPInboundSynchronizer.java => SftpInboundSynchronizer.java} (95%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPMessageSource.java => SftpMessageSource.java} (89%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPSendingMessageHandler.java => SftpSendingMessageHandler.java} (92%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPSession.java => SftpSession.java} (96%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPSessionFactory.java => SftpSessionFactory.java} (83%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/{SFTPSessionPool.java => SftpSessionPool.java} (85%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/{SFTPMessageSendingConsumerFactoryBean.java => SftpMessageSendingConsumerFactoryBean.java} (76%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/{SFTPMessageSourceFactoryBean.java => SftpMessageSourceFactoryBean.java} (87%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/{SFTPNamespaceHandler.java => SftpNamespaceHandler.java} (92%) rename spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/{SFTPSessionUtils.java => SftpSessionUtils.java} (84%) diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSFTPFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSftpFileListFilter.java similarity index 95% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSFTPFileListFilter.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSftpFileListFilter.java index f8a91a9107..cc5d1b8691 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSFTPFileListFilter.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/AbstractSftpFileListFilter.java @@ -26,7 +26,7 @@ import java.util.List; * * @author Josh Long */ -public abstract class AbstractSFTPFileListFilter implements SFTPFileListFilter { +public abstract class AbstractSftpFileListFilter implements SftpFileListFilter { abstract public boolean accept(ChannelSftp.LsEntry lsEntry); diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFTPFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFtpFileListFilter.java similarity index 74% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFTPFileListFilter.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFtpFileListFilter.java index a906d90533..4d2d0b54a3 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFTPFileListFilter.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/CompositeFtpFileListFilter.java @@ -26,18 +26,18 @@ import java.util.*; * * @author Josh Long */ -public class CompositeFTPFileListFilter implements SFTPFileListFilter { - private Set filters; +public class CompositeFtpFileListFilter implements SftpFileListFilter { + private Set filters; - public CompositeFTPFileListFilter(SFTPFileListFilter... ftpFileListFilter) { - this.filters = new LinkedHashSet(Arrays.asList(ftpFileListFilter)); + public CompositeFtpFileListFilter(SftpFileListFilter... ftpFileListFilter) { + this.filters = new LinkedHashSet(Arrays.asList(ftpFileListFilter)); } - public CompositeFTPFileListFilter(Collection ftpFileListFilter) { - this.filters = new LinkedHashSet(ftpFileListFilter); + public CompositeFtpFileListFilter(Collection ftpFileListFilter) { + this.filters = new LinkedHashSet(ftpFileListFilter); } - public void addFilter(SFTPFileListFilter ftpFileListFilter) { + public void addFilter(SftpFileListFilter ftpFileListFilter) { this.filters.add(ftpFileListFilter); } @@ -46,7 +46,7 @@ public class CompositeFTPFileListFilter implements SFTPFileListFilter { List leftOver = Arrays.asList(files); - for (SFTPFileListFilter ff : this.filters) + for (SftpFileListFilter ff : this.filters) leftOver = ff.filterFiles(leftOver.toArray(new ChannelSftp.LsEntry[leftOver.size()])); return leftOver; diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSFTPFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSftpFileListFilter.java similarity index 95% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSFTPFileListFilter.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSftpFileListFilter.java index a6ca0b9216..c79f1d9a0c 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSFTPFileListFilter.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/PatternMatchingSftpFileListFilter.java @@ -32,7 +32,7 @@ import java.util.regex.Pattern; * * @author Josh Long */ -public class PatternMatchingSFTPFileListFilter extends AbstractSFTPFileListFilter implements InitializingBean { +public class PatternMatchingSftpFileListFilter extends AbstractSftpFileListFilter implements InitializingBean { private Log logger = LogFactory.getLog(getClass()); diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSFTPSessionPool.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSftpSessionPool.java similarity index 75% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSFTPSessionPool.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSftpSessionPool.java index aa55db4ce0..4cd55d898d 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSFTPSessionPool.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/QueuedSftpSessionPool.java @@ -23,36 +23,36 @@ import java.util.concurrent.ArrayBlockingQueue; /** - * This approach - of having a SessionPool ({@link org.springframework.integration.sftp.SFTPSessionPool}) that has an - * implementation of Queued*SessionPool ({@link org.springframework.integration.sftp.QueuedSFTPSessionPool}) - was + * This approach - of having a SessionPool ({@link SftpSessionPool}) that has an + * implementation of Queued*SessionPool ({@link QueuedSftpSessionPool}) - was * taken pretty directly from the incredibly good Spring IntegrationFTP adapter. * * @author Josh Long * @since 2.0 */ -public class QueuedSFTPSessionPool implements SFTPSessionPool, InitializingBean { +public class QueuedSftpSessionPool implements SftpSessionPool, InitializingBean { public static final int DEFAULT_POOL_SIZE = 10; - private Queue queue; - private final SFTPSessionFactory sftpSessionFactory; + private Queue queue; + private final SftpSessionFactory sftpSessionFactory; private int maxPoolSize; - public QueuedSFTPSessionPool(SFTPSessionFactory factory) { + public QueuedSftpSessionPool(SftpSessionFactory factory) { this(DEFAULT_POOL_SIZE, factory); } - public QueuedSFTPSessionPool(int maxPoolSize, SFTPSessionFactory sessionFactory) { + public QueuedSftpSessionPool(int maxPoolSize, SftpSessionFactory sessionFactory) { this.sftpSessionFactory = sessionFactory; this.maxPoolSize = maxPoolSize; } public void afterPropertiesSet() throws Exception { assert maxPoolSize > 0 : "poolSize must be greater than 0!"; - queue = new ArrayBlockingQueue(maxPoolSize, true); // size, faireness to avoid starvation + queue = new ArrayBlockingQueue(maxPoolSize, true); // size, faireness to avoid starvation assert sftpSessionFactory != null : "sftpSessionFactory must not be null!"; } - public SFTPSession getSession() throws Exception { - SFTPSession session = this.queue.poll(); + public SftpSession getSession() throws Exception { + SftpSession session = this.queue.poll(); if (null == session) { session = this.sftpSessionFactory.getObject(); @@ -69,7 +69,7 @@ public class QueuedSFTPSessionPool implements SFTPSessionPool, InitializingBean return session; } - public void release(SFTPSession session) { + public void release(SftpSession session) { if (queue.size() < maxPoolSize) { queue.add(session); // somehow one snuck in before session was finished! } else { @@ -77,7 +77,7 @@ public class QueuedSFTPSessionPool implements SFTPSessionPool, InitializingBean } } - private void dispose(SFTPSession s) { + private void dispose(SftpSession s) { if (s == null) { return; } diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPConstants.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpConstants.java similarity index 96% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPConstants.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpConstants.java index 9cf75d4cae..662e9ec473 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPConstants.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpConstants.java @@ -20,6 +20,6 @@ package org.springframework.integration.sftp; /** * @author Josh Long */ -public class SFTPConstants { +public class SftpConstants { public static final String SFTP_REMOTE_DIRECTORY_HEADER = "SFTP_REMOTE_DIRECTORY_HEADER"; -} \ No newline at end of file +} diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpFileListFilter.java similarity index 96% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPFileListFilter.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpFileListFilter.java index 8d15dabd04..98a14fc56d 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPFileListFilter.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpFileListFilter.java @@ -25,6 +25,6 @@ import java.util.List; * * @author Josh Long */ -public interface SFTPFileListFilter { +public interface SftpFileListFilter { List filterFiles (ChannelSftp.LsEntry [] files); } diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPInboundSynchronizer.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpInboundSynchronizer.java similarity index 95% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPInboundSynchronizer.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpInboundSynchronizer.java index d11ec51cfa..fe04a7e3ff 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPInboundSynchronizer.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpInboundSynchronizer.java @@ -45,29 +45,29 @@ import java.util.concurrent.ScheduledFuture; * @author Josh Long * @author Mario Gray */ -public class SFTPInboundSynchronizer implements InitializingBean { +public class SftpInboundSynchronizer implements InitializingBean { private static final long DEFAULT_REFRESH_RATE = 10 * 1000; // 10 seconds // a lot of the approach for this (including the use of a FileReadingMessageSource and the regex / mask approach were lifted from FtpInboundSynchronizer static final String INCOMPLETE_EXTENSION = ".INCOMPLETE"; private Log logger = LogFactory.getLog(getClass()); private volatile Resource localDirectory; - private volatile SFTPSessionPool pool; + private volatile SftpSessionPool pool; private volatile ScheduledFuture scheduledFuture; private volatile String remotePath; private volatile TaskScheduler taskScheduler; private volatile Trigger trigger = new PeriodicTrigger(DEFAULT_REFRESH_RATE); private volatile boolean autoCreatePath; private volatile boolean running; - private SFTPFileListFilter filter; + private SftpFileListFilter filter; - public void setFilter(SFTPFileListFilter filter) { + public void setFilter(SftpFileListFilter filter) { this.filter = filter; } private volatile boolean shouldDeleteDownloadedRemoteFiles; //.. this is false - private SFTPFileListFilter acceptAllFilteListFilter = new SFTPFileListFilter(){ + private SftpFileListFilter acceptAllFilteListFilter = new SftpFileListFilter(){ public List filterFiles(ChannelSftp.LsEntry[] files) { return Arrays.asList( files); } @@ -108,7 +108,7 @@ public class SFTPInboundSynchronizer implements InitializingBean { this.localDirectory = localDirectory; } - public void setPool(SFTPSessionPool pool) { + public void setPool(SftpSessionPool pool) { this.pool = pool; } @@ -157,7 +157,7 @@ public class SFTPInboundSynchronizer implements InitializingBean { @SuppressWarnings("unchecked") public void synchronize() throws Exception { - SFTPSession session = null; + SftpSession session = null; try { session = pool.getSession(); @@ -193,7 +193,7 @@ public class SFTPInboundSynchronizer implements InitializingBean { * existed.) */ private boolean checkThatRemotePathExists(String remotePath) { - SFTPSession session = null; + SftpSession session = null; ChannelSftp channelSftp = null; try { @@ -230,7 +230,7 @@ public class SFTPInboundSynchronizer implements InitializingBean { } @SuppressWarnings("ignored") - private boolean copyFromRemoteToLocalDirectory(SFTPSession sftpSession, ChannelSftp.LsEntry entry, Resource localDir) + private boolean copyFromRemoteToLocalDirectory(SftpSession sftpSession, ChannelSftp.LsEntry entry, Resource localDir) throws Exception { File fileForLocalDir = localDir.getFile(); diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPMessageSource.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpMessageSource.java similarity index 89% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPMessageSource.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpMessageSource.java index 3ad240ebf9..3d418ba1e6 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPMessageSource.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpMessageSource.java @@ -17,23 +17,18 @@ package org.springframework.integration.sftp; import org.springframework.beans.factory.InitializingBean; - import org.springframework.context.Lifecycle; - import org.springframework.core.io.Resource; - import org.springframework.integration.Message; import org.springframework.integration.core.MessageSource; import org.springframework.integration.file.AcceptOnceFileListFilter; import org.springframework.integration.file.CompositeFileListFilter; import org.springframework.integration.file.FileReadingMessageSource; import org.springframework.integration.file.PatternMatchingFileListFilter; - import org.springframework.scheduling.TaskScheduler; import org.springframework.scheduling.Trigger; import java.io.File; - import java.io.IOException; import java.util.regex.Pattern; @@ -45,18 +40,18 @@ import java.util.regex.Pattern; * * @author Josh Long */ -public class SFTPMessageSource implements MessageSource, InitializingBean, Lifecycle { +public class SftpMessageSource implements MessageSource, InitializingBean, Lifecycle { private FileReadingMessageSource fileReadingMessageSource; private Resource localDirectory; - private SFTPInboundSynchronizer synchronizer; + private SftpInboundSynchronizer synchronizer; private TaskScheduler taskScheduler; private Trigger trigger; - public SFTPMessageSource(FileReadingMessageSource fileSource, SFTPInboundSynchronizer synchronizer) { + public SftpMessageSource(FileReadingMessageSource fileSource, SftpInboundSynchronizer synchronizer) { this.fileReadingMessageSource = fileSource; this.synchronizer = synchronizer; - Pattern completePattern = Pattern.compile("^.*(?, InitializingBean, return localDirectory; } - public SFTPInboundSynchronizer getSynchronizer() { + public SftpInboundSynchronizer getSynchronizer() { return synchronizer; } @@ -107,7 +102,7 @@ public class SFTPMessageSource implements MessageSource, InitializingBean, this.synchronizer.setLocalDirectory(localDirectory); } - public void setSynchronizer(final SFTPInboundSynchronizer synchronizer) { + public void setSynchronizer(final SftpInboundSynchronizer synchronizer) { this.synchronizer = synchronizer; } @@ -128,4 +123,4 @@ public class SFTPMessageSource implements MessageSource, InitializingBean, public void stop() { synchronizer.stop(); } -} \ No newline at end of file +} diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSendingMessageHandler.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSendingMessageHandler.java similarity index 92% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSendingMessageHandler.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSendingMessageHandler.java index b6e8f14549..fb1953d836 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSendingMessageHandler.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSendingMessageHandler.java @@ -17,12 +17,9 @@ package org.springframework.integration.sftp; import com.jcraft.jsch.ChannelSftp; - import org.apache.commons.io.IOUtils; import org.apache.commons.lang.StringUtils; - import org.springframework.beans.factory.InitializingBean; - import org.springframework.integration.*; import org.springframework.integration.core.MessageHandler; @@ -38,19 +35,19 @@ import java.io.InputStream; * * @author Josh Long */ -public class SFTPSendingMessageHandler implements MessageHandler, InitializingBean { - private SFTPSessionPool pool; +public class SftpSendingMessageHandler implements MessageHandler, InitializingBean { + private SftpSessionPool pool; private String remoteDirectory; private volatile boolean afterPropertiesSetRan; - public SFTPSendingMessageHandler(SFTPSessionPool pool) { + public SftpSendingMessageHandler(SftpSessionPool pool) { this.pool = pool; } public void afterPropertiesSet() throws Exception { assert this.pool != null : "the pool can't be null!"; - // logger.debug("afterPropertiesSet() called on SFTPSendingMessageHandler"); + // logger.debug("afterPropertiesSet() called on SftpSendingMessageHandler"); if (!afterPropertiesSetRan) { if (StringUtils.isEmpty(this.remoteDirectory)) { remoteDirectory = null; @@ -89,7 +86,7 @@ public class SFTPSendingMessageHandler implements MessageHandler, InitializingBe throws Throwable { assert this.pool != null : "need a working pool"; - SFTPSession session = this.pool.getSession(); + SftpSession session = this.pool.getSession(); if (session == null) { throw new RuntimeException("the session returned from the pool is null, can't possibly proceed."); @@ -113,8 +110,8 @@ public class SFTPSendingMessageHandler implements MessageHandler, InitializingBe if (message != null) { messageHeaders = message.getHeaders(); - if ((messageHeaders != null) && messageHeaders.containsKey(SFTPConstants.SFTP_REMOTE_DIRECTORY_HEADER)) { - dynRd = (String) messageHeaders.get(SFTPConstants.SFTP_REMOTE_DIRECTORY_HEADER); + if ((messageHeaders != null) && messageHeaders.containsKey(SftpConstants.SFTP_REMOTE_DIRECTORY_HEADER)) { + dynRd = (String) messageHeaders.get(SftpConstants.SFTP_REMOTE_DIRECTORY_HEADER); if (!StringUtils.isEmpty(dynRd)) { baseOfRemotePath = dynRd; diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSession.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSession.java similarity index 96% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSession.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSession.java index ceb8c732d3..f3c0c76a05 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSession.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSession.java @@ -20,15 +20,13 @@ import com.jcraft.jsch.ChannelSftp; import com.jcraft.jsch.JSch; import com.jcraft.jsch.Session; import com.jcraft.jsch.UserInfo; - import org.apache.commons.lang.StringUtils; - import java.io.InputStream; /** - * There are many ways to create a {@link org.springframework.integration.sftp.SFTPSession} just as there are many ways to SSH into a remote system. + * There are many ways to create a {@link SftpSession} just as there are many ways to SSH into a remote system. * You may use a username and password, you may use a username and private key, you may use a username and a private key with a password, etc. * * This object represents the connection to the remote server, and to use it you must provide it with all the components you'd normally provide an @@ -38,7 +36,7 @@ import java.io.InputStream; * @author Josh Long * @author Mario Gray */ -public class SFTPSession { +public class SftpSession { private volatile ChannelSftp channel; private volatile Session session; private String privateKey; @@ -70,7 +68,7 @@ public class SFTPSession { * * @throws Exception thrown if any of a myriad of scenarios plays out */ - public SFTPSession(String userName, String hostName, String userPassword, int port, String knownHostsFile, InputStream knownHostsInputStream, String privateKey, String pvKeyPassPhrase) + public SftpSession(String userName, String hostName, String userPassword, int port, String knownHostsFile, InputStream knownHostsInputStream, String privateKey, String pvKeyPassPhrase) throws Exception { JSch jSch = new JSch(); @@ -156,4 +154,4 @@ public class SFTPSession { public void showMessage(String string) { } } -} \ No newline at end of file +} diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionFactory.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionFactory.java similarity index 83% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionFactory.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionFactory.java index f84af72df1..8d9ed4c071 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionFactory.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionFactory.java @@ -22,14 +22,14 @@ import org.springframework.util.StringUtils; /** - * Factories {@link org.springframework.integration.sftp.SFTPSession} instances. There are lots of ways to construct a - * {@link org.springframework.integration.sftp.SFTPSession} instance, and not all of them are obvious. This factory + * Factories {@link SftpSession} instances. There are lots of ways to construct a + * {@link SftpSession} instance, and not all of them are obvious. This factory * does its best to make it work. * * @author Josh Long * @author Mario Gray */ -public class SFTPSessionFactory implements FactoryBean, InitializingBean { +public class SftpSessionFactory implements FactoryBean, InitializingBean { private volatile String knownHosts; private volatile String password; private volatile String privateKey; @@ -46,12 +46,12 @@ public class SFTPSessionFactory implements FactoryBean, Initializin Assert.state(this.port >= 0, "port must be a valid number! "); } - public SFTPSession getObject() throws Exception { - return new SFTPSession( this.user, this.remoteHost , this.password ,this.port, this.knownHosts, null, this.privateKey , this.privateKeyPassphrase); + public SftpSession getObject() throws Exception { + return new SftpSession( this.user, this.remoteHost , this.password ,this.port, this.knownHosts, null, this.privateKey , this.privateKeyPassphrase); } - public Class getObjectType() { - return SFTPSession.class; + public Class getObjectType() { + return SftpSession.class; } public boolean isSingleton() { diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionPool.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionPool.java similarity index 85% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionPool.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionPool.java index c8cff47a4e..a81c9e0354 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SFTPSessionPool.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/SftpSessionPool.java @@ -18,13 +18,13 @@ package org.springframework.integration.sftp; /** * - * Holds instances of {@link org.springframework.integration.sftp.SFTPSession} since they're stateful + * Holds instances of {@link SftpSession} since they're stateful * and might be in use while another run happens. * * * @author Josh Long */ -public interface SFTPSessionPool { +public interface SftpSessionPool { /** * this returns a session that can be used to connct to an sftp instance and perform operations * @@ -32,7 +32,7 @@ public interface SFTPSessionPool { * @throws Exception thrown if theres any of the numerous faults possible when trying to connect to the remote * server */ - SFTPSession getSession() throws Exception; + SftpSession getSession() throws Exception; /** * Frees up the client. Im not sure what the meaningful semantics of this are. Perhaps it just calls (session @@ -40,5 +40,5 @@ public interface SFTPSessionPool { * * @param session the session to relinquish / renew */ - void release(SFTPSession session); -} \ No newline at end of file + void release(SftpSession session); +} diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSendingConsumerFactoryBean.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSendingConsumerFactoryBean.java similarity index 76% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSendingConsumerFactoryBean.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSendingConsumerFactoryBean.java index f2727ed9d5..40dfc1e623 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSendingConsumerFactoryBean.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSendingConsumerFactoryBean.java @@ -16,9 +16,9 @@ package org.springframework.integration.sftp.config; import org.springframework.beans.factory.FactoryBean; -import org.springframework.integration.sftp.QueuedSFTPSessionPool; -import org.springframework.integration.sftp.SFTPSendingMessageHandler; -import org.springframework.integration.sftp.SFTPSessionFactory; +import org.springframework.integration.sftp.QueuedSftpSessionPool; +import org.springframework.integration.sftp.SftpSendingMessageHandler; +import org.springframework.integration.sftp.SftpSessionFactory; /** @@ -27,7 +27,7 @@ import org.springframework.integration.sftp.SFTPSessionFactory; * * @author Josh Long */ -public class SFTPMessageSendingConsumerFactoryBean implements FactoryBean { +public class SftpMessageSendingConsumerFactoryBean implements FactoryBean { private String host; private String keyFile; private String keyFilePassword; @@ -37,22 +37,22 @@ public class SFTPMessageSendingConsumerFactoryBean implements FactoryBean getObjectType() { - return SFTPSendingMessageHandler.class; + public Class getObjectType() { + return SftpSendingMessageHandler.class; } public boolean isSingleton() { diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSourceFactoryBean.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSourceFactoryBean.java similarity index 87% rename from spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSourceFactoryBean.java rename to spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSourceFactoryBean.java index d6ef0cd39b..cc44d6dd34 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SFTPMessageSourceFactoryBean.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/SftpMessageSourceFactoryBean.java @@ -37,18 +37,18 @@ import java.util.Map; /** - * Building a {@link org.springframework.integration.sftp.SFTPMessageSource} is a complicated because we also + * Building a {@link org.springframework.integration.sftp.SftpMessageSource} is a complicated because we also * use a {@link org.springframework.integration.file.FileReadingMessageSource} to handle the "receipt" of files in * a {@link #localWorkingDirectory}. * * @author Josh Long */ -public class SFTPMessageSourceFactoryBean extends AbstractFactoryBean implements ApplicationContextAware, ResourceLoaderAware { +public class SftpMessageSourceFactoryBean extends AbstractFactoryBean implements ApplicationContextAware, ResourceLoaderAware { private ApplicationContext applicationContext; private FileReadingMessageSource fileReadingMessageSource; private Resource localDirectoryResource; private ResourceLoader resourceLoader; - private SFTPInboundSynchronizer synchronizer; + private SftpInboundSynchronizer synchronizer; private String host; private String keyFile; private String keyFilePassword; @@ -61,7 +61,7 @@ public class SFTPMessageSourceFactoryBean extends AbstractFactoryBean getObjectType() { - return SFTPMessageSource.class; + public Class getObjectType() { + return SftpMessageSource.class; } public String getPassword() { @@ -101,7 +101,7 @@ public class SFTPMessageSourceFactoryBean extends AbstractFactoryBean tss = null; @@ -258,17 +258,17 @@ public class SFTPMessageSourceFactoryBean extends AbstractFactoryBeananything */ - public static SFTPSessionFactory buildSftpSessionFactory(String host, String pw, String usr, String pvKey, String pvKeyPass, int port) + public static SftpSessionFactory buildSftpSessionFactory(String host, String pw, String usr, String pvKey, String pvKeyPass, int port) throws Exception { - SFTPSessionFactory sftpSessionFactory = new SFTPSessionFactory(); + SftpSessionFactory sftpSessionFactory = new SftpSessionFactory(); sftpSessionFactory.setPassword(pw); sftpSessionFactory.setPort(port); sftpSessionFactory.setRemoteHost(host); diff --git a/spring-integration-sftp/src/main/resources/META-INF/spring.handlers b/spring-integration-sftp/src/main/resources/META-INF/spring.handlers index 6889a5f16f..8e52f8fe48 100644 --- a/spring-integration-sftp/src/main/resources/META-INF/spring.handlers +++ b/spring-integration-sftp/src/main/resources/META-INF/spring.handlers @@ -1 +1 @@ -http\://www.springframework.org/schema/integration/sftp=org.springframework.integration.sftp.config.SFTPNamespaceHandler \ No newline at end of file +http\://www.springframework.org/schema/integration/sftp=org.springframework.integration.sftp.config.SftpNamespaceHandler diff --git a/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/TestSFTPReceipt.java b/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/TestSFTPReceipt.java index b599782058..64f4f737d3 100644 --- a/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/TestSFTPReceipt.java +++ b/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/TestSFTPReceipt.java @@ -2,19 +2,14 @@ package org.springframework.integration.sftp; import org.apache.commons.lang.SystemUtils; import org.apache.commons.lang.exception.ExceptionUtils; - import org.junit.Before; import org.junit.Test; - import org.springframework.core.io.FileSystemResource; import org.springframework.core.io.Resource; - import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; - import org.springframework.util.ErrorHandler; import java.io.File; - import java.util.logging.Logger; @@ -26,7 +21,7 @@ import java.util.logging.Logger; public class TestSFTPReceipt { private static final Logger logger = Logger.getLogger(TestSFTPReceipt.class.getName()); - private SFTPSessionFactory sftpSessionFactory; + private SftpSessionFactory sftpSessionFactory; private String host; private String password; private String user; @@ -59,7 +54,7 @@ public class TestSFTPReceipt { Resource localDirectory = new FileSystemResource(local); // pool - QueuedSFTPSessionPool queuedSFTPSessionPool = new QueuedSFTPSessionPool(sftpSessionFactory); + QueuedSftpSessionPool queuedSFTPSessionPool = new QueuedSftpSessionPool(sftpSessionFactory); queuedSFTPSessionPool.afterPropertiesSet(); ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler(); @@ -74,7 +69,7 @@ public class TestSFTPReceipt { taskScheduler.initialize(); // synchronizer - final SFTPInboundSynchronizer sftpInboundSynchronizer = new SFTPInboundSynchronizer(); + final SftpInboundSynchronizer sftpInboundSynchronizer = new SftpInboundSynchronizer(); sftpInboundSynchronizer.setLocalDirectory(localDirectory); sftpInboundSynchronizer.setRemotePath(remoteMount); sftpInboundSynchronizer.setAutoCreatePath(true); @@ -97,9 +92,9 @@ public class TestSFTPReceipt { }).start(); } - private SFTPSessionFactory buildSFTPSessionFactory(String host, String pw, String usr, String pvKey, String pvKeyPass, int port) + private SftpSessionFactory buildSFTPSessionFactory(String host, String pw, String usr, String pvKey, String pvKeyPass, int port) throws Throwable { - SFTPSessionFactory sftpSessionFactory = new SFTPSessionFactory(); + SftpSessionFactory sftpSessionFactory = new SftpSessionFactory(); sftpSessionFactory.setPassword(pw); sftpSessionFactory.setPort(port); sftpSessionFactory.setRemoteHost(host);