org.tinygroup.vfs.impl.sftp

Class SftpClient

java.lang.Object

org.tinygroup.vfs.impl.sftp.SftpClient

public class SftpClient
extends Object

Constructor Summary

Constructors

Constructor and Description
SftpClient(URL url) SFTP 安全文件传送协议

Method Summary

Modifier and Type	Method and Description
boolean	changeDir(String pathName) 切换工作目录
boolean	changeToHomeDir() 切换到根目录
boolean	changeToParentDir() 切换到上一级目录
String	currentDir() 当前工作目录
boolean	delDir(String dirName) 删除文件夹
boolean	delFile(String fileName) 删除文件
boolean	download(String fileName, OutputStream os) 下载当前目录下的文件
boolean	exist(String name) 当前目录是否存在文件或文件夹
boolean	exist(String path, String name) 指定目录下，是否存在文件或文件夹
boolean	existDir(String name) 当前目录是否存在文件夹
boolean	existDir(String path, String name) 指定目录下，是否存在文件夹
boolean	existFile(String name) 当前目录是否存在文件
boolean	existFile(String path, String name) 指定目录下，是否存在文件
com.jcraft.jsch.ChannelSftp.LsEntry	getEntry(String pathName, String fileName) 获取路径下该文件的entry对象
InputStream	getInputStream(String fileName) 获取当前工作目录下子文件的InputStream
OutputStream	getOutputStream(String fileName) 获取当前工作目录下子文件的OutputStream
void	login() 登陆SFTP服务器
void	logout() 登出
com.jcraft.jsch.ChannelSftp.LsEntry[]	ls() 当前目录下文件及文件夹名称列表
com.jcraft.jsch.ChannelSftp.LsEntry[]	ls(String pathName) 指定目录下文件及文件夹名称列表
com.jcraft.jsch.ChannelSftp.LsEntry[]	lsDirs() 当前目录下文件夹名称列表
com.jcraft.jsch.ChannelSftp.LsEntry[]	lsDirs(String pathName) 指定目录下文件夹名称列表
com.jcraft.jsch.ChannelSftp.LsEntry[]	lsFiles() 当前目录下文件名称列表
com.jcraft.jsch.ChannelSftp.LsEntry[]	lsFiles(String pathName) 指定目录下文件名称列表
boolean	makeDir(String dirName) 创建目录
boolean	upload(String fileName, InputStream is) 上传到当前目录下

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpClient

public SftpClient(URL url)

SFTP 安全文件传送协议

Parameters:

host - SFTP服务器IP地址

port - SFTP服务器端口

timeout - 连接超时时间，单位毫秒

username - 用户名

password - 密码

Method Detail

login

public void login()

登陆SFTP服务器

getInputStream

public InputStream getInputStream(String fileName)
                           throws com.jcraft.jsch.SftpException

获取当前工作目录下子文件的InputStream

Parameters:

fileName - 当前工作目录下子文件名

Returns:

InputStream

Throws:

com.jcraft.jsch.SftpException

getOutputStream

public OutputStream getOutputStream(String fileName)
                             throws com.jcraft.jsch.SftpException

获取当前工作目录下子文件的OutputStream

Parameters:

fileName - 当前工作目录下子文件名

Returns:

InputStream

Throws:

com.jcraft.jsch.SftpException

changeDir

public boolean changeDir(String pathName)

切换工作目录

使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/

当前目录	方法	参数(绝对路径/相对路径)	切换后的目录
/	changeDir("testA")	相对路径	/testA/
/	changeDir("testA/testA_B")	相对路径	/testA/testA_B/
/	changeDir("/testA")	绝对路径	/testA/
/testA/testA_B/	changeDir("/testA")	绝对路径	/testA/

Parameters:

pathName - 路径

Returns:

boolean

changeToParentDir

public boolean changeToParentDir()

切换到上一级目录

使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/

当前目录	方法	切换后的目录
/testA/	changeToParentDir()	/
/testA/testA_B/	changeToParentDir()	/testA/

Returns:

boolean

changeToHomeDir

public boolean changeToHomeDir()

切换到根目录

Returns:

boolean

makeDir

public boolean makeDir(String dirName)

创建目录

使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/

当前目录	方法	参数(绝对路径/相对路径)	创建成功后的目录
/testA/testA_B/	makeDir("testA_B_C")	相对路径	/testA/testA_B/testA_B_C/
/	makeDir("/testA/testA_B/testA_B_D")	绝对路径	/testA/testA_B/testA_B_D/

注意，当中间目录不存在的情况下，不能够使用绝对路径的方式期望创建中间目录及目标目录。 例如makeDir("/testNOEXIST1/testNOEXIST2/testNOEXIST3")，这是错误的。

Parameters:

dirName - 目录

Returns:

boolean

delDir

public boolean delDir(String dirName)

删除文件夹

Parameters:

dirName -

Returns:

boolean

delFile

public boolean delFile(String fileName)

删除文件

Parameters:

fileName - 文件名

Returns:

boolean

ls

public com.jcraft.jsch.ChannelSftp.LsEntry[] ls()

当前目录下文件及文件夹名称列表

Returns:

String[]

ls

public com.jcraft.jsch.ChannelSftp.LsEntry[] ls(String pathName)

指定目录下文件及文件夹名称列表

Returns:

String[]

lsFiles

public com.jcraft.jsch.ChannelSftp.LsEntry[] lsFiles()

当前目录下文件名称列表

Returns:

String[]

lsFiles

public com.jcraft.jsch.ChannelSftp.LsEntry[] lsFiles(String pathName)

指定目录下文件名称列表

Returns:

String[]

lsDirs

public com.jcraft.jsch.ChannelSftp.LsEntry[] lsDirs()

当前目录下文件夹名称列表

Returns:

String[]

lsDirs

public com.jcraft.jsch.ChannelSftp.LsEntry[] lsDirs(String pathName)

指定目录下文件夹名称列表

Returns:

String[]

getEntry

public com.jcraft.jsch.ChannelSftp.LsEntry getEntry(String pathName,
                                                    String fileName)

获取路径下该文件的entry对象

Parameters:

pathName -

fileName -

Returns:

exist

public boolean exist(String name)

当前目录是否存在文件或文件夹

Parameters:

name - 名称

Returns:

boolean

exist

public boolean exist(String path,
                     String name)

指定目录下，是否存在文件或文件夹

Parameters:

path - 目录

name - 名称

Returns:

boolean

existFile

public boolean existFile(String name)

当前目录是否存在文件

Parameters:

name - 文件名

Returns:

boolean

existFile

public boolean existFile(String path,
                         String name)

指定目录下，是否存在文件

Parameters:

path - 目录

name - 文件名

Returns:

boolean

existDir

public boolean existDir(String name)

当前目录是否存在文件夹

Parameters:

name - 文件夹名称

Returns:

boolean

existDir

public boolean existDir(String path,
                        String name)

指定目录下，是否存在文件夹

Parameters:

path - 目录

name - 文家夹名称

Returns:

boolean

currentDir

public String currentDir()

当前工作目录

Returns:

String

logout

public void logout()

登出

upload

public boolean upload(String fileName,
                      InputStream is)

上传到当前目录下

Parameters:

path -

is -

download

public boolean download(String fileName,
                        OutputStream os)

下载当前目录下的文件

Parameters:

remotePath -

fileName -

os -

Returns: