xyz.zhangbohan.common.tools

类 SFTPUtil

java.lang.Object

xyz.zhangbohan.common.tools.SFTPUtil

public class SFTPUtil
extends Object

类说明 sftp工具类

字段概要

字段

限定符和类型	字段和说明
private String	host SFTP 服务器地址IP地址
private org.slf4j.Logger	log
private String	password SFTP 登录密码
private int	port SFTP 端口
private String	privateKey 私钥
private com.jcraft.jsch.Session	session
private com.jcraft.jsch.ChannelSftp	sftp
private String	username SFTP 登录用户名

构造器概要

构造器

构造器和说明
SFTPUtil()
SFTPUtil(String username, String host, int port, String privateKey) 构造基于秘钥认证的sftp对象
SFTPUtil(String username, String password, String host, int port) 构造基于密码认证的sftp对象

方法概要

限定符和类型	方法和说明
void	delete(String directory, String deleteFile) 删除文件
byte[]	download(String directory, String downloadFile) 下载文件
void	download(String directory, String downloadFile, String saveFile) 下载文件。
Vector<?>	listFiles(String directory) 列出目录下的文件
void	login() 连接sftp服务器
void	logout() 关闭连接 server
void	upload(String basePath, String directory, String sftpFileName, InputStream input) 将输入流的数据上传到sftp作为文件。

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

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

字段详细资料

log

private transient org.slf4j.Logger log

sftp

private com.jcraft.jsch.ChannelSftp sftp

session

private com.jcraft.jsch.Session session

username

private String username

SFTP 登录用户名

password

private String password

SFTP 登录密码

privateKey

private String privateKey

私钥

host

private String host

SFTP 服务器地址IP地址

port

private int port

SFTP 端口

构造器详细资料

SFTPUtil

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

构造基于密码认证的sftp对象

SFTPUtil

public SFTPUtil(String username,
                String host,
                int port,
                String privateKey)

构造基于秘钥认证的sftp对象

SFTPUtil

public SFTPUtil()

方法详细资料

login

public void login()

连接sftp服务器

logout

public void logout()

关闭连接 server

upload

public void upload(String basePath,
                   String directory,
                   String sftpFileName,
                   InputStream input)
            throws com.jcraft.jsch.SftpException

将输入流的数据上传到sftp作为文件。文件完整路径=basePath+directory

参数:

basePath - 服务器的基础路径

directory - 上传到该目录

sftpFileName - sftp端文件名

input - 输入流

抛出:

com.jcraft.jsch.SftpException

download

public void download(String directory,
                     String downloadFile,
                     String saveFile)
              throws com.jcraft.jsch.SftpException,
                     FileNotFoundException

下载文件。

参数:

directory - 下载目录

downloadFile - 下载的文件

saveFile - 存在本地的路径

抛出:

com.jcraft.jsch.SftpException

FileNotFoundException

download

public byte[] download(String directory,
                       String downloadFile)
                throws com.jcraft.jsch.SftpException,
                       IOException

下载文件

参数:

directory - 下载目录

downloadFile - 下载的文件名

返回:

字节数组

抛出:

com.jcraft.jsch.SftpException

IOException

delete

public void delete(String directory,
                   String deleteFile)
            throws com.jcraft.jsch.SftpException

删除文件

参数:

directory - 要删除文件所在目录

deleteFile - 要删除的文件

抛出:

com.jcraft.jsch.SftpException

listFiles

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

列出目录下的文件

参数:

directory - 要列出的目录

抛出:

com.jcraft.jsch.SftpException