Class SftpSession
java.lang.Object
org.springframework.integration.sftp.session.SftpSession
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable,org.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
public class SftpSession
extends java.lang.Object
implements org.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
Default SFTP
Session implementation. Wraps a JSCH session instance.- Since:
- 2.0
-
Constructor Summary
Constructors Constructor Description SftpSession(com.jcraft.jsch.Session jschSession)SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper) -
Method Summary
Modifier and Type Method Description voidappend(java.io.InputStream inputStream, java.lang.String destination)voidclose()booleanexists(java.lang.String path)booleanfinalizeRaw()com.jcraft.jsch.ChannelSftpgetClientInstance()java.lang.StringgetHostPort()booleanisOpen()com.jcraft.jsch.ChannelSftp.LsEntry[]list(java.lang.String path)java.lang.String[]listNames(java.lang.String path)booleanmkdir(java.lang.String remoteDirectory)voidread(java.lang.String source, java.io.OutputStream os)java.io.InputStreamreadRaw(java.lang.String source)booleanremove(java.lang.String path)voidrename(java.lang.String pathFrom, java.lang.String pathTo)booleanrmdir(java.lang.String remoteDirectory)voidsetChannelConnectTimeout(java.time.Duration timeout)Set the connect timeout.booleantest()voidwrite(java.io.InputStream inputStream, java.lang.String destination)
-
Constructor Details
-
SftpSession
public SftpSession(com.jcraft.jsch.Session jschSession) -
SftpSession
public SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper)
-
-
Method Details
-
setChannelConnectTimeout
public void setChannelConnectTimeout(java.time.Duration timeout)Set the connect timeout.- Parameters:
timeout- the timeout to set.- Since:
- 5.2
-
remove
public boolean remove(java.lang.String path) throws java.io.IOException- Specified by:
removein interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
list
public com.jcraft.jsch.ChannelSftp.LsEntry[] list(java.lang.String path) throws java.io.IOException- Specified by:
listin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
listNames
public java.lang.String[] listNames(java.lang.String path) throws java.io.IOException- Specified by:
listNamesin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
read
public void read(java.lang.String source, java.io.OutputStream os) throws java.io.IOException- Specified by:
readin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
readRaw
public java.io.InputStream readRaw(java.lang.String source) throws java.io.IOException- Specified by:
readRawin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
finalizeRaw
public boolean finalizeRaw()- Specified by:
finalizeRawin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
write
public void write(java.io.InputStream inputStream, java.lang.String destination) throws java.io.IOException- Specified by:
writein interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
append
public void append(java.io.InputStream inputStream, java.lang.String destination) throws java.io.IOException- Specified by:
appendin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
close
public void close()- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Specified by:
closein interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
isOpen
public boolean isOpen()- Specified by:
isOpenin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
rename
public void rename(java.lang.String pathFrom, java.lang.String pathTo) throws java.io.IOException- Specified by:
renamein interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
mkdir
public boolean mkdir(java.lang.String remoteDirectory) throws java.io.IOException- Specified by:
mkdirin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
rmdir
public boolean rmdir(java.lang.String remoteDirectory) throws java.io.IOException- Specified by:
rmdirin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>- Throws:
java.io.IOException
-
exists
public boolean exists(java.lang.String path)- Specified by:
existsin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
getClientInstance
public com.jcraft.jsch.ChannelSftp getClientInstance()- Specified by:
getClientInstancein interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
getHostPort
public java.lang.String getHostPort()- Specified by:
getHostPortin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-
test
public boolean test()- Specified by:
testin interfaceorg.springframework.integration.file.remote.session.Session<com.jcraft.jsch.ChannelSftp.LsEntry>
-