Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INT-2521 - SFTP Adapter Session Factory Doc Improvement

Browse Source 
* fix Missing documentation of "enableDaemonThread" property of the SFTP session factory
* Reference documentation clean-up
* Document all properties of the DefaultSftpSessionFactory
This commit is contained in:
Gunnar Hillert
2012-06-23 16:23:43 -04:00
committed by Gary Russell
parent 9b541c8618
commit 13890dab14
2 changed files with 378 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
View File

@@ -38,10 +38,12 @@ import com.jcraft.jsch.UserInfo;
* @author Josh Long
* @author Mario Gray
* @author Oleg Zhurakousky
* @author Gunnar Hillert
*
* @since 2.0
*/
public class DefaultSftpSessionFactory implements SessionFactory<LsEntry> {
private volatile String host;
private volatile int port = 22; // the default
@@ -55,94 +57,199 @@ public class DefaultSftpSessionFactory implements SessionFactory<LsEntry> {
private volatile Resource privateKey;
private volatile String privateKeyPassphrase;
private volatile Properties sessionConfig;
private volatile Proxy proxy;
private volatile SocketFactory socketFactory;
private volatile Integer timeout;
private volatile String clientVersion;
private volatile String hostKeyAlias;
private volatile Integer serverAliveInterval;
private volatile Integer serverAliveCountMax;
private volatile Boolean enableDaemonThread;
private final JSch jsch = new JSch();
public void setHost(String host) {
/**
* The url of the host you want connect to. This is a mandatory property.
*
* @see JSch#getSession(String, String, int)
*/
public void setHost(String host) {
this.host = host;
}
/**
* The port over which the SFTP connection shall be established. If not specified,
* this value defaults to <code>22</code>. If specified, this properties must
* be a positive number.
*
* @see JSch#getSession(String, String, int)
*/
public void setPort(int port) {
this.port = port;
}
/**
* The remote user to use. This is a mandatory property.
*
* @see JSch#getSession(String, String, int)
*/
public void setUser(String user) {
this.user = user;
}
/**
* The password to authenticate against the remote host. If a password is
* not provided, then the {@link DefaultSftpSessionFactory#privateKey} is
* mandatory.
*
* @see com.jcraft.jsch.Session#setPassword(String)
*/
public void setPassword(String password) {
this.password = password;
}
/**
* Specifies the filename that will be used to create a host key repository.
* The resulting file has the same format as OpenSSH's known_hosts file.
*
* @see JSch#setKnownHosts(String)
*/
public void setKnownHosts(String knownHosts) {
this.knownHosts = knownHosts;
}
/**
* Allows you to set a {@link Resource}, which represents the location of the
* private key used for authenticating against the remote host. If the privateKey
* is not provided, then the {@link DefaultSftpSessionFactory#setPassword(String)}
* property is mandatory.
*
* @see JSch#addIdentity(String)
* @see JSch#addIdentity(String, String)
*
*/
public void setPrivateKey(Resource privateKey) {
this.privateKey = privateKey;
}
/**
* The password for the private key. Optional.
*
* @see JSch#addIdentity(String, String)
*/
public void setPrivateKeyPassphrase(String privateKeyPassphrase) {
this.privateKeyPassphrase = privateKeyPassphrase;
}
/**
* Using {@link Properties}, you can set additional configuration settings on
* the underlying JSch {@link com.jcraft.jsch.Session}.
*
* @see com.jcraft.jsch.Session#setConfig(Properties)
*/
public void setSessionConfig(Properties sessionConfig) {
this.sessionConfig = sessionConfig;
}
public void setProxy(Proxy proxy){
/**
* Allows for specifying a JSch-based {@link Proxy}. If set, then the proxy
* object is used to create the connection to the remote host.
*
* @see com.jcraft.jsch.Session#setProxy(Proxy)
*/
public void setProxy(Proxy proxy){
this.proxy = proxy;
}
public void setSocketFactory(SocketFactory socketFactory){
/**
* Allows you to pass in a {@link SocketFactory}. The socket factory is used
* to create a socket to the target host. When a {@link Proxy} is used, the
* socket factory is passed to the proxy. By default plain TCP sockets are used.
*
* @see com.jcraft.jsch.Session#setSocketFactory(SocketFactory)
*/
public void setSocketFactory(SocketFactory socketFactory){
this.socketFactory = socketFactory;
}
public void setTimeout(Integer timeout) {
this.timeout = timeout;
}
public void setClientVersion(String clientVersion){
this.clientVersion = clientVersion;
}
public void setHostKeyAlias(String hostKeyAlias){
this.hostKeyAlias = hostKeyAlias;
}
public void setServerAliveInterval(Integer serverAliveInterval){
this.serverAliveInterval = serverAliveInterval;
}
public void setServerAliveCountMax(Integer serverAliveCountMax){
this.serverAliveCountMax = serverAliveCountMax;
}
public void setEnableDaemonThread(Boolean enableDaemonThread){
this.enableDaemonThread = enableDaemonThread;
}
/**
* The timeout property is used as the socket timeout parameter, as well as
* the default connection timeout. Defaults to <code>0</code>, which means,
* that no timeout will occur.
*
* @see com.jcraft.jsch.Session#setTimeout(int)
*/
public void setTimeout(Integer timeout) {
this.timeout = timeout;
}
/**
* Allows you to set the client version property. It's default depends on the
* underlying JSch version but it will look like <code>SSH-2.0-JSCH-0.1.45</code>
*
* @see com.jcraft.jsch.Session#setClientVersion(String)
*/
public void setClientVersion(String clientVersion){
this.clientVersion = clientVersion;
}
/**
* Sets the host key alias, used when comparing the host key to the known
* hosts list.
*
* @see com.jcraft.jsch.Session#setHostKeyAlias(String)
*/
public void setHostKeyAlias(String hostKeyAlias){
this.hostKeyAlias = hostKeyAlias;
}
/**
* Sets the timeout interval (milliseconds) before a server alive message is
* sent, in case no message is received from the server.
*
* @see com.jcraft.jsch.Session#setServerAliveInterval(int)
*/
public void setServerAliveInterval(Integer serverAliveInterval){
this.serverAliveInterval = serverAliveInterval;
}
/**
* Specifies the number of server-alive messages, which will be sent without
* any reply from the server before disconnecting. If not set, this property
* defaults to <code>1</code>.
*
* @see com.jcraft.jsch.Session#setServerAliveCountMax(int)
*/
public void setServerAliveCountMax(Integer serverAliveCountMax){
this.serverAliveCountMax = serverAliveCountMax;
}
/**
* If true, all threads will be daemon threads. If set to <code>false</code>,
* normal non-daemon threads will be used. This property will be set on the
* underlying {@link com.jcraft.jsch.Session} using
* {@link com.jcraft.jsch.Session#setDaemonThread(boolean)}. There, this
* property will default to <code>false</code>, if not explicitly set.
*
* @see com.jcraft.jsch.Session#setDaemonThread(boolean)
*/
public void setEnableDaemonThread(Boolean enableDaemonThread){
this.enableDaemonThread = enableDaemonThread;
}
public Session<LsEntry> getSession() {
Assert.hasText(this.host, "host must not be empty");
Assert.hasText(this.user, "user must not be empty");
@@ -160,9 +267,9 @@ public class DefaultSftpSessionFactory implements SessionFactory<LsEntry> {
}
}
private com.jcraft.jsch.Session initJschSession() throws Exception {
private com.jcraft.jsch.Session initJschSession() throws Exception {
JSch.setLogger(new JschLogger());
if (this.port <= 0) {
this.port = 22;
}
@@ -183,12 +290,12 @@ public class DefaultSftpSessionFactory implements SessionFactory<LsEntry> {
com.jcraft.jsch.Session jschSession = this.jsch.getSession(this.user, this.host, this.port);
if (this.sessionConfig != null){
jschSession.setConfig(this.sessionConfig);
}
}
if (StringUtils.hasText(this.password)) {
jschSession.setPassword(this.password);
}
jschSession.setUserInfo(new OptimisticUserInfoImpl(this.password));
try {
if (proxy != null){
jschSession.setProxy(proxy);