Skip to content

Optimize DefaultSftpSessionFactory #2896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 15, 2019
Merged

Optimize DefaultSftpSessionFactory #2896

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
131a9da
Optimize DefaultSftpSessionFactory
artembilan Apr 15, 2019
fb7ed51
* Wrap `sharedJschSession` initialization to the lock
artembilan Apr 15, 2019
48e605e
* Store `sharedJschSession` back when it is really fresh and while th…
artembilan Apr 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 57 additions & 65 deletions ...src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
import java.io.IOException;
import java.util.Arrays;
import java.util.Properties;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand Down Expand Up @@ -64,51 +64,51 @@ public class DefaultSftpSessionFactory implements SessionFactory<LsEntry>, Share
JSch.setLogger(new JschLogger());
}

private final ReadWriteLock sharedSessionLock = new ReentrantReadWriteLock();

private final UserInfo userInfoWrapper = new UserInfoWrapper();

private final JSch jsch;

private final boolean isSharedSession;

private volatile String host;
private final Lock sharedSessionLock;

private volatile int port = 22; // the default
private String host;

private volatile String user;
private int port = 22; // the default

private volatile String password;
private String user;

private volatile String knownHosts;
private String password;

private volatile Resource privateKey;
private String knownHosts;

private volatile String privateKeyPassphrase;
private Resource privateKey;

private volatile Properties sessionConfig;
private String privateKeyPassphrase;

private volatile Proxy proxy;
private Properties sessionConfig;

private volatile SocketFactory socketFactory;
private Proxy proxy;

private volatile Integer timeout;
private SocketFactory socketFactory;

private volatile String clientVersion;
private Integer timeout;

private volatile String hostKeyAlias;
private String clientVersion;

private volatile Integer serverAliveInterval;
private String hostKeyAlias;

private volatile Integer serverAliveCountMax;
private Integer serverAliveInterval;

private volatile Boolean enableDaemonThread;
private Integer serverAliveCountMax;

private volatile JSchSessionWrapper sharedJschSession;
private Boolean enableDaemonThread;

private volatile UserInfo userInfo;
private UserInfo userInfo;

private volatile boolean allowUnknownKeys = false;
private boolean allowUnknownKeys = false;

private volatile JSchSessionWrapper sharedJschSession;


public DefaultSftpSessionFactory() {
Expand All @@ -130,6 +130,12 @@ public DefaultSftpSessionFactory(boolean isSharedSession) {
public DefaultSftpSessionFactory(JSch jsch, boolean isSharedSession) {
this.jsch = jsch;
this.isSharedSession = isSharedSession;
if (this.isSharedSession) {
this.sharedSessionLock = new ReentrantLock();
}
else {
this.sharedSessionLock = null;
}
}

/**
Expand Down Expand Up @@ -349,57 +355,41 @@ public void setAllowUnknownKeys(boolean allowUnknownKeys) {

@Override
public SftpSession getSession() {
Assert.hasText(this.host, "host must not be empty");
Assert.hasText(this.user, "user must not be empty");
Assert.isTrue(StringUtils.hasText(this.userInfoWrapper.getPassword()) || this.privateKey != null,
"either a password or a private key is required");
JSchSessionWrapper jschSession = this.sharedJschSession;
SftpSession sftpSession;
if (this.sharedSessionLock != null) {
this.sharedSessionLock.lock();
}
try {
JSchSessionWrapper jschSession;
SftpSession sftpSession;
if (this.isSharedSession) {
this.sharedSessionLock.readLock().lock();
try {
if (this.sharedJschSession == null || !this.sharedJschSession.isConnected()) {
this.sharedSessionLock.readLock().unlock();
this.sharedSessionLock.writeLock().lock();
try {
if (this.sharedJschSession == null || !this.sharedJschSession.isConnected()) {
this.sharedJschSession = new JSchSessionWrapper(initJschSession());
try {
this.sharedJschSession.getSession().connect();
}
catch (JSchException e) {
throw new IllegalStateException("failed to connect", e);
}
}
}
finally {
this.sharedSessionLock.readLock().lock();
this.sharedSessionLock.writeLock().unlock();
}
}
jschSession = this.sharedJschSession;
sftpSession = new SftpSession(jschSession);
sftpSession.connect();
}
finally {
this.sharedSessionLock.readLock().unlock();
}
}
else {
boolean freshJschSession = false;
if (jschSession == null || !jschSession.isConnected()) {
jschSession = new JSchSessionWrapper(initJschSession());
sftpSession = new SftpSession(jschSession);
sftpSession.connect();
freshJschSession = true;
}
sftpSession = new SftpSession(jschSession);
sftpSession.connect();
if (this.isSharedSession && freshJschSession) {
this.sharedJschSession = jschSession;
}
jschSession.addChannel();
return sftpSession;
}
catch (Exception e) {
throw new IllegalStateException("failed to create SFTP Session", e);
}
finally {
if (this.sharedSessionLock != null) {
this.sharedSessionLock.unlock();
}
}
jschSession.addChannel();
return sftpSession;
}

private com.jcraft.jsch.Session initJschSession() throws JSchException, IOException {
Assert.hasText(this.host, "host must not be empty");
Assert.hasText(this.user, "user must not be empty");
Assert.isTrue(StringUtils.hasText(this.userInfoWrapper.getPassword()) || this.privateKey != null,
"either a password or a private key is required");

if (this.port <= 0) {
this.port = 22;
}
Expand Down Expand Up @@ -564,18 +554,20 @@ public void showMessage(String message) {
@Override
public String[] promptKeyboardInteractive(String destination, String name, String instruction, String[] prompt,
boolean[] echo) {

if (hasDelegate() && getDelegate() instanceof UIKeyboardInteractive) {
return ((UIKeyboardInteractive) getDelegate()).promptKeyboardInteractive(destination, name,
instruction, prompt, echo);
}
else {
if (logger.isDebugEnabled()) {
logger.debug("No UIKeyboardInteractive provided - " + destination + ":" + name + ":" + instruction
+ ":" + Arrays.asList(prompt) + ":" + Arrays.asList(echo));
+ ":" + Arrays.asList(prompt) + ":" + Arrays.toString(echo));
}
return null;
}
}

}

}