cn.liboss.ass.sftp

类 SFTPUtils

java.lang.Object

cn.liboss.ass.sftp.SFTPUtils

public class SFTPUtils
extends Object

sftp的工具类。 【2022-12-30】 liaimin 1. 类初始化。 【2023-06-14】 liaimin 1、新增：getInputStream方法。获取sftp文件流，用于转为解压、或直接转为bytes。

字段概要

字段

限定符和类型	字段和说明
com.jcraft.jsch.ChannelSftp	sftp
com.jcraft.jsch.Session	sshSession

构造器概要

构造器

构造器和说明
SFTPUtils(String host, int port, String username, String password)
SFTPUtils(String host, String username, String password)

方法概要

限定符和类型	方法和说明
void	bacthUploadFile(String remotePath, String localPath, boolean del) [未使用]批量上传文件
List<String>	batchDownLoadFile(String remotePath, String localPath, String fileFormat, String fileEndFormat, boolean del) [未验证]批量下载文件
void	connect() 【v1.0】通过SFTP连接服务器
boolean	createDir(String createpath) 创建目录
void	deleteSFTP(String sftpPathFile) 删除stfp文件
void	disconnect() 【v1.0】关闭连接
void	downloadFile(String remoteFilePath, String localFilePath) 下载单个文件
void	downloadFile(String remoteDirPath, String remoteFileName, String localPath, String localFileName) 【v1.0】下载单个文件
String	getHost()
InputStream	getInputStream(String sftp_file_path) 【v1.0】获取一个sftp文件的inputStream
String	getPassword()
int	getPort()
com.jcraft.jsch.ChannelSftp	getSftp()
String	getUsername()
boolean	isDirExist(String directory) 判断目录是否存在
Vector	listFiles(String directory) 列出目录下的文件
void	mkdirs(String path) 如果目录不存在就创建目录
void	setHost(String host)
void	setPassword(String password)
void	setPort(int port)
void	setSftp(com.jcraft.jsch.ChannelSftp sftp)
void	setUsername(String username)
void	uploadFile(String localFile, String remoteFile) 上传单个文件
void	uploadFileToFolder(String localFile, String remoteDir) 上传单个文件指定目录

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

sftp

public com.jcraft.jsch.ChannelSftp sftp

sshSession

public com.jcraft.jsch.Session sshSession

构造器详细资料

SFTPUtils

public SFTPUtils(String host,
                 int port,
                 String username,
                 String password)

SFTPUtils

public SFTPUtils(String host,
                 String username,
                 String password)

方法详细资料

connect

public void connect()

【v1.0】通过SFTP连接服务器

disconnect

public void disconnect()

【v1.0】关闭连接

batchDownLoadFile

public List<String> batchDownLoadFile(String remotePath,
                                      String localPath,
                                      String fileFormat,
                                      String fileEndFormat,
                                      boolean del)

[未验证]批量下载文件

参数:

remotePath - 远程下载目录(以路径符号结束,可以为相对路径. g:/assess/sftp/jiesuan_2/2014/)

localPath - 本地保存目录(以路径符号结束,D:\Duansha\sftp\)

fileFormat - 下载文件格式(以特定字符开头,为空不做检验)

fileEndFormat - 下载文件格式(文件格式)

del - 下载后是否删除sftp文件

downloadFile

public void downloadFile(String remoteFilePath,
                         String localFilePath)
                  throws Exception

下载单个文件

参数:

remoteFilePath - 远程sftp文件路径

localFilePath - 本地保存的文件路径

抛出:

Exception

downloadFile

public void downloadFile(String remoteDirPath,
                         String remoteFileName,
                         String localPath,
                         String localFileName)
                  throws Exception

【v1.0】下载单个文件

参数:

remoteDirPath - 远程下载目录(以路径符号结束)

remoteFileName - 下载文件名

localPath - 本地保存目录(以路径符号结束)

localFileName - 保存文件名

抛出:

Exception

uploadFile

public void uploadFile(String localFile,
                       String remoteFile)
                throws Exception

上传单个文件

参数:

localFile - 本地上传的文件

remoteFile - 远程的sftp文件的完整路径

抛出:

Exception

uploadFileToFolder

public void uploadFileToFolder(String localFile,
                               String remoteDir)
                        throws Exception

上传单个文件指定目录

参数:

localFile - 要上传的本地文件路径

remoteDir - 远程的sftp目录

抛出:

Exception

bacthUploadFile

public void bacthUploadFile(String remotePath,
                            String localPath,
                            boolean del)

[未使用]批量上传文件

参数:

remotePath - 远程保存目录

localPath - 本地上传目录(以路径符号结束)

del - 上传后是否删除本地文件

createDir

public boolean createDir(String createpath)

创建目录

参数:

createpath -

isDirExist

public boolean isDirExist(String directory)

判断目录是否存在

参数:

directory -

deleteSFTP

public void deleteSFTP(String sftpPathFile)
                throws com.jcraft.jsch.SftpException

删除stfp文件

参数:

sftpPathFile -

抛出:

com.jcraft.jsch.SftpException

mkdirs

public void mkdirs(String path)

如果目录不存在就创建目录

参数:

path -

listFiles

public Vector listFiles(String directory)
                 throws com.jcraft.jsch.SftpException

列出目录下的文件

参数:

directory - 要列出的目录

返回:

返回一个目录（不含子目录）的文件和目录清单

抛出:

com.jcraft.jsch.SftpException

getHost

public String getHost()

setHost

public void setHost(String host)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public int getPort()

setPort

public void setPort(int port)

getSftp

public com.jcraft.jsch.ChannelSftp getSftp()

setSftp

public void setSftp(com.jcraft.jsch.ChannelSftp sftp)

getInputStream

public InputStream getInputStream(String sftp_file_path)
                           throws Exception

【v1.0】获取一个sftp文件的inputStream

参数:

sftp_file_path -

返回:

一个sftp文件的的InputStream

抛出:

Exception