Ftp (bus-extra 5.9.3 API)

java.lang.Object
- org.aoju.bus.extra.ftp.AbstractFtp
- - org.aoju.bus.extra.ftp.Ftp

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Ftp
extends AbstractFtp
```
FTP客户端封装此客户端基于Apache-Commons-Net

Since:

JDK 1.8+

Version:

5.9.3

Author:

Kimi Liu

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PORT
默认端口
- Fields inherited from class org.aoju.bus.extra.ftp.AbstractFtp
  DEFAULT_CHARSET, ftpConfig

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PORT` 默认端口

Constructor Summary

Constructors
Constructor and Description
`Ftp(FtpConfig config, FtpMode mode)` 构造
`Ftp(String host)` 构造,匿名登录
`Ftp(String host, int port)` 构造,匿名登录
`Ftp(String host, int port, String user, String password)` 构造
`Ftp(String host, int port, String user, String password, Charset charset)` 构造
`Ftp(String host, int port, String user, String password, Charset charset, FtpMode mode)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cd(String directory)` 改变目录
`void`	`close()`
`boolean`	`delDir(String dirPath)` 删除文件夹及其文件夹下的所有文件
`boolean`	`delFile(String path)` 删除指定目录下的指定文件
`void`	`download(String path, File outFile)` 下载文件
`void`	`download(String sourcePath, String desPath)` 递归获取远程文件
`void`	`download(String path, String fileName, File outFile)` 下载文件
`void`	`download(String path, String fileName, OutputStream out)` 下载文件到输出流
`boolean`	`existFile(String path)` 判断ftp服务器文件是否存在
`org.apache.commons.net.ftp.FTPClient`	`getClient()` 获取FTPClient客户端对象
`Ftp`	`init()` 初始化连接
`Ftp`	`init(FtpConfig config, FtpMode mode)` 初始化连接
`Ftp`	`init(String host, int port, String user, String password)` 初始化连接
`Ftp`	`init(String host, int port, String user, String password, FtpMode mode)` 初始化连接
`List<String>`	`ls(String path)` 遍历某个目录下所有文件和目录,不会递归遍历
`org.apache.commons.net.ftp.FTPFile[]`	`lsFiles(String path)` 遍历某个目录下所有文件和目录,不会递归遍历
`boolean`	`mkdir(String dir)` 在当前远程目录(工作目录)下创建新的目录
`String`	`pwd()` 远程当前目录
`Ftp`	`reconnectIfTimeout()` 如果连接超时的话，重新进行连接经测试，当连接超时时，client.isConnected()仍然返回ture，无法判断是否连接超时因此，通过发送pwd命令的方式，检查连接是否超时
`Ftp`	`setBackToPwd(boolean backToPwd)` 设置执行完操作是否返回当前目录
`Ftp`	`setMode(FtpMode mode)` 设置FTP连接模式，可选主动和被动模式
`boolean`	`upload(String destPath, File file)` 上传文件到指定目录,可选：
`boolean`	`upload(String path, String fileName, File file)` 上传文件到指定目录，可选：
`boolean`	`upload(String path, String fileName, InputStream fileStream)` 上传文件到指定目录,可选：

Methods inherited from class org.aoju.bus.extra.ftp.AbstractFtp
exist, mkDirs, toParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    默认端口
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Ftp
```
public Ftp(String host)
```
    构造,匿名登录
    
    Parameters:
    
    host - 域名或IP
  - Ftp
```
public Ftp(String host,
           int port)
```
    构造,匿名登录
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
  - Ftp
```
public Ftp(String host,
           int port,
           String user,
           String password)
```
    构造
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
    
    user - 用户名
    
    password - 密码
  - Ftp
```
public Ftp(String host,
           int port,
           String user,
           String password,
           Charset charset)
```
    构造
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
    
    user - 用户名
    
    password - 密码
    
    charset - 编码
  - Ftp
```
public Ftp(String host,
           int port,
           String user,
           String password,
           Charset charset,
           FtpMode mode)
```
    构造
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
    
    user - 用户名
    
    password - 密码
    
    charset - 编码
    
    mode - 模式
  - Ftp
```
public Ftp(FtpConfig config,
           FtpMode mode)
```
    构造
    
    Parameters:
    
    config - FTP配置
    
    mode - 模式
- Method Detail
  - init
```
public Ftp init()
```
    初始化连接
    
    Returns:
    
    this
  - init
```
public Ftp init(String host,
                int port,
                String user,
                String password)
```
    初始化连接
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
    
    user - 用户名
    
    password - 密码
    
    Returns:
    
    this
  - init
```
public Ftp init(String host,
                int port,
                String user,
                String password,
                FtpMode mode)
```
    初始化连接
    
    Parameters:
    
    host - 域名或IP
    
    port - 端口
    
    user - 用户名
    
    password - 密码
    
    mode - 模式
    
    Returns:
    
    this
  - init
```
public Ftp init(FtpConfig config,
                FtpMode mode)
```
    初始化连接
    
    Parameters:
    
    config - FTP配置
    
    mode - 模式
    
    Returns:
    
    this
  - setMode
```
public Ftp setMode(FtpMode mode)
```
    设置FTP连接模式，可选主动和被动模式
    
    Parameters:
    
    mode - 模式枚举
    
    Returns:
    
    this
  - setBackToPwd
```
public Ftp setBackToPwd(boolean backToPwd)
```
    设置执行完操作是否返回当前目录
    
    Parameters:
    
    backToPwd - 执行完操作是否返回当前目录
    
    Returns:
    
    this
  - reconnectIfTimeout
```
public Ftp reconnectIfTimeout()
```
    如果连接超时的话，重新进行连接经测试，当连接超时时，client.isConnected()仍然返回ture，无法判断是否连接超时因此，通过发送pwd命令的方式，检查连接是否超时
    
    Specified by:
    
    reconnectIfTimeout in class AbstractFtp
    
    Returns:
    
    this
  - cd
```
public boolean cd(String directory)
```
    改变目录
    
    Specified by:
    
    cd in class AbstractFtp
    
    Parameters:
    
    directory - 目录
    
    Returns:
    
    是否成功
  - pwd
```
public String pwd()
```
    远程当前目录
    
    Specified by:
    
    pwd in class AbstractFtp
    
    Returns:
    
    远程当前目录
  - ls
```
public List<String> ls(String path)
```
    Description copied from class: AbstractFtp
    
    遍历某个目录下所有文件和目录,不会递归遍历
    
    Specified by:
    
    ls in class AbstractFtp
    
    Parameters:
    
    path - 需要遍历的目录
    
    Returns:
    
    文件和目录列表
  - lsFiles
```
public org.apache.commons.net.ftp.FTPFile[] lsFiles(String path)
```
    遍历某个目录下所有文件和目录,不会递归遍历
    
    Parameters:
    
    path - 目录
    
    Returns:
    
    文件或目录列表
  - mkdir
```
public boolean mkdir(String dir)
```
    Description copied from class: AbstractFtp
    
    在当前远程目录(工作目录)下创建新的目录
    
    Specified by:
    
    mkdir in class AbstractFtp
    
    Parameters:
    
    dir - 目录名
    
    Returns:
    
    是否创建成功
  - existFile
```
public boolean existFile(String path)
```
    判断ftp服务器文件是否存在
    
    Parameters:
    
    path - 文件路径
    
    Returns:
    
    是否存在
  - delFile
```
public boolean delFile(String path)
```
    Description copied from class: AbstractFtp
    
    删除指定目录下的指定文件
    
    Specified by:
    
    delFile in class AbstractFtp
    
    Parameters:
    
    path - 目录路径
    
    Returns:
    
    是否存在
  - delDir
```
public boolean delDir(String dirPath)
```
    Description copied from class: AbstractFtp
    
    删除文件夹及其文件夹下的所有文件
    
    Specified by:
    
    delDir in class AbstractFtp
    
    Parameters:
    
    dirPath - 文件夹路径
    
    Returns:
    
    boolean 是否删除成功
  - upload
```
public boolean upload(String destPath,
                      File file)
```
    上传文件到指定目录,可选：
```
 1. path为null或""上传到当前路径
 2. path为相对路径则相对于当前路径的子路径
 3. path为绝对路径则上传到此路径
 
```
    Specified by:
    
    upload in class AbstractFtp
    
    Parameters:
    
    destPath - 服务端路径，可以为null 或者相对路径或绝对路径
    
    file - 文件
    
    Returns:
    
    是否上传成功
  - upload
```
public boolean upload(String path,
                      String fileName,
                      File file)
```
    上传文件到指定目录，可选：
```
 1. path为null或""上传到当前路径
 2. path为相对路径则相对于当前路径的子路径
 3. path为绝对路径则上传到此路径
 
```
    Parameters:
    
    file - 文件
    
    path - 服务端路径,可以为null 或者相对路径或绝对路径
    
    fileName - 自定义在服务端保存的文件名
    
    Returns:
    
    是否上传成功
  - upload
```
public boolean upload(String path,
                      String fileName,
                      InputStream fileStream)
```
    上传文件到指定目录,可选：
```
 1. path为null或""上传到当前路径
 2. path为相对路径则相对于当前路径的子路径
 3. path为绝对路径则上传到此路径
 
```
    Parameters:
    
    path - 服务端路径,可以为null 或者相对路径或绝对路径
    
    fileName - 文件名
    
    fileStream - 文件流
    
    Returns:
    
    是否上传成功
  - download
```
public void download(String path,
                     File outFile)
```
    下载文件
    
    Specified by:
    
    download in class AbstractFtp
    
    Parameters:
    
    path - 文件路径
    
    outFile - 输出文件或目录
  - download
```
public void download(String path,
                     String fileName,
                     File outFile)
```
    下载文件
    
    Parameters:
    
    path - 文件路径
    
    fileName - 文件名
    
    outFile - 输出文件或目录
  - download
```
public void download(String path,
                     String fileName,
                     OutputStream out)
```
    下载文件到输出流
    
    Parameters:
    
    path - 文件路径
    
    fileName - 文件名
    
    out - 输出位置
  - download
```
public void download(String sourcePath,
                     String desPath)
```
    递归获取远程文件
    
    Specified by:
    
    download in class AbstractFtp
    
    Parameters:
    
    sourcePath - 服务器目录
    
    desPath - 本地目录
  - getClient
```
public org.apache.commons.net.ftp.FTPClient getClient()
```
    获取FTPClient客户端对象
    
    Returns:
    
    FTPClient
  - close
```
public void close()
           throws IOException
```
    Throws:
    
    IOException

Class Ftp

Field Summary

Fields inherited from class org.aoju.bus.extra.ftp.AbstractFtp

Constructor Summary

Method Summary

Methods inherited from class org.aoju.bus.extra.ftp.AbstractFtp

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

Constructor Detail

Ftp

Ftp

Ftp

Ftp

Ftp

Ftp

Method Detail

init

init

init

init

setMode

setBackToPwd

reconnectIfTimeout

cd

pwd

ls

lsFiles

mkdir

existFile

delFile

delDir

upload

upload

upload

download

download

download

download

getClient

close