me.meilon.sftp.core

类 SftpConnect

java.lang.Object

me.meilon.sftp.core.SftpConnect

所有已实现的接口:

Closeable, AutoCloseable

public class SftpConnect
extends Object
implements Closeable

sftp 连接对象

作者:

meilon

构造器概要

构造器

限定符	构造器和说明
protected	SftpConnect(SftpConnConfig config, com.jcraft.jsch.ChannelSftp sftp)

方法概要

限定符和类型	方法和说明
void	cd(String path) 切换目录
void	chgrp(Integer gid, String path) 改变目录用户组
void	chmod(int permsion, String directory) 给目录授权
void	close()
void	copyfile(String from, String to) 复制文件 如果指定的目标文件名和原始文件名不同, 复制完成后文件名会改变
void	copyfile(String fromPath, String toPath, String fileName) 复制文件, 复制完成后文件名不变
void	delete(String deleteFile) 删除文件 删除当前目录下的文件
void	delete(String directory, String deleteFile) 删除文件 不能使用全路径删除, 先CD到文件所在目录, 删除完毕后在CD回原目录
void	download(String remoteFilePath, String localFilePath) 下载文件
boolean	downloadAsnFile(String remotePath, String fileName, String savePath, String suffixPattren) 下载文件，下载过程中采用重命名防止被其他程序误处理
com.jcraft.jsch.SftpATTRS	getAttrs(String path) 获取远程文件或目录属性
com.jcraft.jsch.ChannelSftp	getChannelSftp()
String	getId()
boolean	isConnected() 检查连接状态
boolean	isDir(String directory) 判断目标是否是目录
boolean	isExist(String path) 判断目录或文件是否存在
boolean	isFile(String filePath) 判断远程目标是否是文件
boolean	isPool()
List<String>	listFileNames(String directory) 列出指定目录下的文件 失败时返回空list
List<com.jcraft.jsch.ChannelSftp.LsEntry>	listFiles(String directory)
void	mkdir(String directory) 创建目录
void	mkdirs(String createPath) 创建多级目录
void	openDir(String directory) 功能说明:打开指定目录, 如果目录不存在则创建
InputStream	openFile(String filePath) 打开指定文件名的文件, 返回InputStream 失败返回 null
String	pwd() 查看当前所处目录
void	rename(String oldpath, String newpath) 重命名文件或者目录 ,移动文件或者目录
protected void	setPool(boolean pool)
void	uploadFile(File localFile, String remoteFilePath) 上传文件到指定的远程目录
void	uploadFile(InputStream fileIo, String remoteFilePath) 上传文件流到远程服务器
OutputStream	uploadFile(String remoteFilePath) 上传文件流到远程目录 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为 remoteFilePath remoteFilePath 不能为目录。
void	uploadFile(String filePath, String remotePath) 将本地文件名为 filePath 的文件上传到目标服务器，
void	uploadFile(String filePath, String remotePath, SftpMode mode) 按照指定模式上传文件
void	uploadFile(String filePath, String remotePath, com.jcraft.jsch.SftpProgressMonitor monitor) 文件上传 提供回调函数实时反馈上传进度
void	uploadFiles(String directory, String remoteDir) 批量上传本地目录下的文件到远程目录
void	uploadFiles(String directory, String remoteDir, FileFilter filter) 批量上传本地目录下的文件到远程目录

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

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

构造器详细资料

SftpConnect

protected SftpConnect(SftpConnConfig config,
                      com.jcraft.jsch.ChannelSftp sftp)

方法详细资料

isPool

public boolean isPool()

setPool

protected void setPool(boolean pool)

getId

public String getId()

getChannelSftp

public com.jcraft.jsch.ChannelSftp getChannelSftp()

isConnected

public boolean isConnected()

检查连接状态

返回:

true: 连接正常 false: 连接断开

isDir

public boolean isDir(String directory)
              throws com.jcraft.jsch.SftpException

判断目标是否是目录

参数:

directory - 目录路径

返回:

true: 是目录, false: 不是目录

抛出:

com.jcraft.jsch.SftpException - SftpException

isFile

public boolean isFile(String filePath)
               throws com.jcraft.jsch.SftpException

判断远程目标是否是文件

参数:

filePath - 目标文件路径

返回:

true: 是文件, false: 不是文件

抛出:

com.jcraft.jsch.SftpException - SftpException

isExist

public boolean isExist(String path)
                throws com.jcraft.jsch.SftpException

判断目录或文件是否存在

参数:

path - 目标路径

返回:

true: 存在, false: 不存在

抛出:

com.jcraft.jsch.SftpException - SftpException

getAttrs

public com.jcraft.jsch.SftpATTRS getAttrs(String path)
                                   throws com.jcraft.jsch.SftpException

获取远程文件或目录属性

参数:

path - 目标路径

返回:

文件或目录属性 注: 如果文件或目录不存在则返回 null

抛出:

com.jcraft.jsch.SftpException - SftpException

pwd

public String pwd()
           throws com.jcraft.jsch.SftpException

查看当前所处目录

返回:

当前目录字串

抛出:

com.jcraft.jsch.SftpException - SftpException

cd

public void cd(String path)
        throws com.jcraft.jsch.SftpException

切换目录

参数:

path - 路径

抛出:

com.jcraft.jsch.SftpException - SftpException

mkdir

public void mkdir(String directory)
           throws com.jcraft.jsch.SftpException

创建目录

参数:

directory - 目标路径

抛出:

com.jcraft.jsch.SftpException - SftpException

mkdirs

public void mkdirs(String createPath)
            throws com.jcraft.jsch.SftpException

创建多级目录

参数:

createPath - 目标路径

抛出:

com.jcraft.jsch.SftpException - SftpException

chmod

public void chmod(int permsion,
                  String directory)
           throws com.jcraft.jsch.SftpException

给目录授权

参数:

permsion - 授权值

directory - 目标路径

抛出:

com.jcraft.jsch.SftpException - SftpException

rename

public void rename(String oldpath,
                   String newpath)
            throws com.jcraft.jsch.SftpException

重命名文件或者目录 ,移动文件或者目录

参数:

oldpath - 旧文件或目录

newpath - 新文件或目录

抛出:

com.jcraft.jsch.SftpException - SftpException

openDir

public void openDir(String directory)
             throws com.jcraft.jsch.SftpException

功能说明:打开指定目录, 如果目录不存在则创建

参数:

directory - 目标路径

抛出:

com.jcraft.jsch.SftpException - SftpException

chgrp

public void chgrp(Integer gid,
                  String path)
           throws com.jcraft.jsch.SftpException

改变目录用户组

参数:

gid - 组名

path - 文件或目录的路径

抛出:

com.jcraft.jsch.SftpException - SftpException

delete

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

删除文件 删除当前目录下的文件

参数:

deleteFile - 要删除的文件

抛出:

com.jcraft.jsch.SftpException - SftpException

delete

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

删除文件 不能使用全路径删除, 先CD到文件所在目录, 删除完毕后在CD回原目录

参数:

directory - 要删除文件所在目录

deleteFile - 要删除的文件

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFile

public void uploadFile(String filePath,
                       String remotePath)
                throws com.jcraft.jsch.SftpException

将本地文件名为 filePath 的文件上传到目标服务器，

参数:

filePath - 本地文件路径

remotePath - 远程文件路径 注: remotePath 可以是目录, 也可以是文件 如果是目录则按照原文件名上传至 remotePath 目录 如果是文件则按照指定的文件名上传

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFile

public void uploadFile(String filePath,
                       String remotePath,
                       SftpMode mode)
                throws com.jcraft.jsch.SftpException

按照指定模式上传文件

参数:

filePath - 本地文件路径

remotePath - 远程文件路径

mode - 文件传输模式

抛出:

com.jcraft.jsch.SftpException - SftpException

另请参阅:

SftpMode

uploadFile

public void uploadFile(String filePath,
                       String remotePath,
                       com.jcraft.jsch.SftpProgressMonitor monitor)
                throws com.jcraft.jsch.SftpException

文件上传 提供回调函数实时反馈上传进度

参数:

filePath - 本地文件路径

remotePath - 远程路径

monitor - 回调函数

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFile

public void uploadFile(InputStream fileIo,
                       String remoteFilePath)
                throws com.jcraft.jsch.SftpException

上传文件流到远程服务器

参数:

fileIo - 文件流

remoteFilePath - 远程文件路径, 必须是包含文件名的完整路径, 不能是目录

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFile

public OutputStream uploadFile(String remoteFilePath)
                        throws com.jcraft.jsch.SftpException

上传文件流到远程目录 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为 remoteFilePath remoteFilePath 不能为目录。 采用默认的传输模式：OVERWRITE

参数:

remoteFilePath - 远程文件地址

返回:

文件输出流

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFile

public void uploadFile(File localFile,
                       String remoteFilePath)
                throws com.jcraft.jsch.SftpException

上传文件到指定的远程目录

参数:

localFile - 本地文件

remoteFilePath - 远程文件地址

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFiles

public void uploadFiles(String directory,
                        String remoteDir)
                 throws com.jcraft.jsch.SftpException

批量上传本地目录下的文件到远程目录

参数:

directory - 本地目录

remoteDir - 远程目录

抛出:

com.jcraft.jsch.SftpException - SftpException

uploadFiles

public void uploadFiles(String directory,
                        String remoteDir,
                        FileFilter filter)
                 throws com.jcraft.jsch.SftpException

批量上传本地目录下的文件到远程目录

参数:

directory - 本地目录

remoteDir - 远程目录

filter - 过滤器, 可以为空, 为空则不做过滤

抛出:

com.jcraft.jsch.SftpException - SftpException

download

public void download(String remoteFilePath,
                     String localFilePath)
              throws com.jcraft.jsch.SftpException

下载文件

参数:

remoteFilePath - 远程文件地址

localFilePath - 本地文件地址

抛出:

com.jcraft.jsch.SftpException - SftpException

downloadAsnFile

public boolean downloadAsnFile(String remotePath,
                               String fileName,
                               String savePath,
                               String suffixPattren)

下载文件，下载过程中采用重命名防止被其他程序误处理

参数:

remotePath - 远程目录

fileName - 文件名

savePath - 保存目录

suffixPattren - 下载中文件后缀名

返回:

boolean

listFileNames

public List<String> listFileNames(String directory)
                           throws com.jcraft.jsch.SftpException

列出指定目录下的文件 失败时返回空list

参数:

directory - 要列出的目录

返回:

文件名列表

抛出:

com.jcraft.jsch.SftpException - SftpException

listFiles

public List<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles(String directory)
                                                    throws com.jcraft.jsch.SftpException

抛出:

com.jcraft.jsch.SftpException

openFile

public InputStream openFile(String filePath)
                     throws com.jcraft.jsch.SftpException

打开指定文件名的文件, 返回InputStream 失败返回 null

参数:

filePath - 要打开的文件名

返回:

io流

抛出:

com.jcraft.jsch.SftpException - SftpException

copyfile

public void copyfile(String fromPath,
                     String toPath,
                     String fileName)
              throws com.jcraft.jsch.SftpException,
                     IOException

复制文件, 复制完成后文件名不变

参数:

fromPath - 文件所在路径

toPath - 要复制到的目标路径

fileName - 文件名

抛出:

com.jcraft.jsch.SftpException - SftpException

IOException

copyfile

public void copyfile(String from,
                     String to)
              throws com.jcraft.jsch.SftpException,
                     IOException

复制文件 如果指定的目标文件名和原始文件名不同, 复制完成后文件名会改变

参数:

from - 原始文件路径, 必须包含文件名

to - 目标文件路径, 必须包含文件名

抛出:

com.jcraft.jsch.SftpException - SftpException

IOException

close

public void close()

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable