BaseFtpInstance (orion-kit 2.0.5 API)

java.lang.Object
- cn.orionsec.kit.net.ftp.client.instance.BaseFtpInstance

All Implemented Interfaces:

Destroyable, SafeCloseable, IFtpInstance, Closeable, AutoCloseable

Direct Known Subclasses:

FtpInstance
```
public abstract class BaseFtpInstance
extends Object
implements IFtpInstance
```
ftp 操作实例基类

Since:

2022/5/20 11:18

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bufferSize`
`protected org.apache.commons.net.ftp.FTPClient`	`client` FTP 连接
`protected FtpConfig`	`config` FTP 配置
`protected FtpClientPool`	`pool` FTP 连接池
`protected static String`	`SEPARATOR` 分隔符

Constructor Summary

Constructors
Constructor and Description

BaseFtpInstance(org.apache.commons.net.ftp.FTPClient client, FtpConfig config)

BaseFtpInstance(FtpClientPool pool)

Constructors
Constructor and Description
`BaseFtpInstance(org.apache.commons.net.ftp.FTPClient client, FtpConfig config)`
`BaseFtpInstance(FtpClientPool pool)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(String path, byte[] bs, int off, int len)` 拼接字节数组到文件文件不存在则自动创建
`void`	`append(String path, InputStream in)` 拼接流到文件文件不存在则自动创建
`void`	`close()` 安全关闭
`void`	`destroy()` 销毁
`protected abstract void`	`doAppend(String path, InputStream in, StreamEntry entry)` 执行拼接
`protected abstract long`	`doTransfer(String path, OutputStream out, long skip, int size, boolean close)` 执行传输
`void`	`downloadFile(String remoteFile, String localFile)` 下载文件
`protected abstract void`	`doWrite(String path, InputStream in, StreamEntry entry)` 执行写入
`org.apache.commons.net.ftp.FTPClient`	`getClient()` 获取连接
`FtpConfig`	`getConfig()` 获取配置
`FtpClientPool`	`getPool()` 获取连接池
`String`	`getStatus()` 获取文件夹状态
`String`	`getStatus(String path)` 获取文件夹状态会获取文件列表
`String`	`getSystemType()` 获取系统类型
`List<FtpFile>`	`listDirs(String path, boolean child)` 列出文件夹
`List<FtpFile>`	`listFiles(String path, boolean child, boolean dir)` 文件和文件夹列表
`String`	`localCharset(String chars)` 本地编码
`boolean`	`pending()` 等待处理命令完毕事务
`boolean`	`reply()` 获取上一次命令的reply
`int`	`replyCode()` 获取上一次命令的 replyCode
`String`	`replyMsg()` 获取上一次命令的 replyCode 对应的 message
`void`	`reset()` 重置 io
`void`	`restartOffset(long offset)` 设置偏移量
`boolean`	`sendNoop()` 发送心跳
`String`	`serverCharset(String chars)` ftp 服务文件编码
`long`	`transfer(String path, OutputStream out, long skip, int size)` 读取字节到输出流文件不存在则报错
`long`	`transfer(String path, String file, long skip, int size)` 读取字节到文件文件不存在则报错
`void`	`uploadFile(String remoteFile, String localFile)` 上传文件远程文件存在则会覆盖远程文件是个文件夹则会报错
`void`	`write(String path, byte[] bs, int off, int len)` 写入字节数组到文件文件不存在则自动创建
`void`	`write(String path, InputStream in)` 写入流到文件文件不存在则自动创建

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

Methods inherited from interface cn.orionsec.kit.net.ftp.client.instance.IFtpInstance
append, append, change, change, download, download, downloadDir, downloadDir, downloadDir, downloadDir, downloadFile, downloadFile, downloadFile, getFile, getModifyTime, getSize, getWorkDirectory, isExist, listDirs, listFiles, listFiles, listFilesFilter, listFilesFilter, listFilesFilter, makeDirectories, move, openInputStream, openInputStream, openOutputStream, openOutputStream, read, read, read, read, remove, removeDir, removeFile, setModifyTime, touch, transfer, transfer, transfer, transfer, transfer, transfer, truncate, upload, upload, uploadDir, uploadDir, uploadDir, uploadDir, uploadFile, uploadFile, uploadFile, write, write

- Field Detail
  - SEPARATOR
```
protected static final String SEPARATOR
```
    分隔符
    
    See Also:
    
    Constant Field Values
  - client
```
protected org.apache.commons.net.ftp.FTPClient client
```
    FTP 连接
  - config
```
protected FtpConfig config
```
    FTP 配置
  - pool
```
protected FtpClientPool pool
```
    FTP 连接池
  - bufferSize
```
protected int bufferSize
```
- Constructor Detail
  - BaseFtpInstance
```
public BaseFtpInstance(FtpClientPool pool)
```
  - BaseFtpInstance
```
public BaseFtpInstance(org.apache.commons.net.ftp.FTPClient client,
                       FtpConfig config)
```
- Method Detail
  - replyCode
```
public int replyCode()
```
    Description copied from interface: IFtpInstance
    
    获取上一次命令的 replyCode
    
    Specified by:
    
    replyCode in interface IFtpInstance
    
    Returns:
    
    replyCode
  - replyMsg
```
public String replyMsg()
```
    Description copied from interface: IFtpInstance
    
    获取上一次命令的 replyCode 对应的 message
    
    Specified by:
    
    replyMsg in interface IFtpInstance
    
    Returns:
    
    信息
  - reply
```
public boolean reply()
```
    Description copied from interface: IFtpInstance
    
    获取上一次命令的reply
    
    Specified by:
    
    reply in interface IFtpInstance
    
    Returns:
    
    true执行成功
  - transfer
```
public long transfer(String path,
                     String file,
                     long skip,
                     int size)
              throws IOException
```
    Description copied from interface: IFtpInstance
    
    读取字节到文件
    文件不存在则报错
    
    Specified by:
    
    transfer in interface IFtpInstance
    
    Parameters:
    
    path - 文件绝对路径
    
    file - 输出流
    
    skip - 跳过字数
    
    size - 读取长度 -1 读取全部
    
    Returns:
    
    已读取长度
    
    Throws:
    
    IOException - IOException
  - transfer
```
public long transfer(String path,
                     OutputStream out,
                     long skip,
                     int size)
              throws IOException
```
    Description copied from interface: IFtpInstance
    
    读取字节到输出流
    文件不存在则报错
    
    Specified by:
    
    transfer in interface IFtpInstance
    
    Parameters:
    
    path - 文件绝对路径
    
    out - 输出流
    
    skip - 跳过字数
    
    size - 读取长度 -1 读取全部
    
    Returns:
    
    已读取长度
    
    Throws:
    
    IOException - IOException
  - doTransfer
```
protected abstract long doTransfer(String path,
                                   OutputStream out,
                                   long skip,
                                   int size,
                                   boolean close)
                            throws IOException
```
    执行传输
    
    Parameters:
    
    path - path
    
    out - out
    
    skip - skip
    
    size - size
    
    close - close
    
    Returns:
    
    read
    
    Throws:
    
    IOException - IOException
  - write
```
public void write(String path,
                  InputStream in)
           throws IOException
```
    Description copied from interface: IFtpInstance
    
    写入流到文件
    文件不存在则自动创建
    
    Specified by:
    
    write in interface IFtpInstance
    
    Parameters:
    
    path - 文件
    
    in - in
    
    Throws:
    
    IOException - IOException
  - write
```
public void write(String path,
                  byte[] bs,
                  int off,
                  int len)
           throws IOException
```
    Description copied from interface: IFtpInstance
    
    写入字节数组到文件
    文件不存在则自动创建
    
    Specified by:
    
    write in interface IFtpInstance
    
    Parameters:
    
    path - 文件
    
    bs - 字节数组
    
    off - 偏移量
    
    len - 长度
    
    Throws:
    
    IOException - IOException
  - doWrite
```
protected abstract void doWrite(String path,
                                InputStream in,
                                StreamEntry entry)
                         throws IOException
```
    执行写入
    
    Parameters:
    
    path - path
    
    in - in
    
    entry - entry
    
    Throws:
    
    IOException - IOException
  - append
```
public void append(String path,
                   InputStream in)
            throws IOException
```
    Description copied from interface: IFtpInstance
    
    拼接流到文件
    文件不存在则自动创建
    
    Specified by:
    
    append in interface IFtpInstance
    
    Parameters:
    
    path - 文件
    
    in - in
    
    Throws:
    
    IOException - IOException
  - append
```
public void append(String path,
                   byte[] bs,
                   int off,
                   int len)
            throws IOException
```
    Description copied from interface: IFtpInstance
    
    拼接字节数组到文件
    文件不存在则自动创建
    
    Specified by:
    
    append in interface IFtpInstance
    
    Parameters:
    
    path - 文件
    
    bs - 字节数组
    
    off - 偏移量
    
    len - 长度
    
    Throws:
    
    IOException - IOException
  - doAppend
```
protected abstract void doAppend(String path,
                                 InputStream in,
                                 StreamEntry entry)
                          throws IOException
```
    执行拼接
    
    Parameters:
    
    path - path
    
    in - in
    
    entry - entry
    
    Throws:
    
    IOException - IOException
  - uploadFile
```
public void uploadFile(String remoteFile,
                       String localFile)
                throws IOException
```
    Description copied from interface: IFtpInstance
    
    上传文件
    远程文件存在则会覆盖
    远程文件是个文件夹则会报错
    
    Specified by:
    
    uploadFile in interface IFtpInstance
    
    Parameters:
    
    remoteFile - 远程文件
    
    localFile - 本地文件
    
    Throws:
    
    IOException - IOException
  - downloadFile
```
public void downloadFile(String remoteFile,
                         String localFile)
                  throws IOException
```
    Description copied from interface: IFtpInstance
    
    下载文件
    
    Specified by:
    
    downloadFile in interface IFtpInstance
    
    Parameters:
    
    remoteFile - 远程文件路径
    
    localFile - 本地文件
    
    Throws:
    
    IOException - pending
  - listFiles
```
public List<FtpFile> listFiles(String path,
                               boolean child,
                               boolean dir)
```
    Description copied from interface: IFtpInstance
    
    文件和文件夹列表
    
    Specified by:
    
    listFiles in interface IFtpInstance
    
    Parameters:
    
    path - 路径
    
    child - 是否遍历子目录
    
    dir - 是否添加文件夹
    
    Returns:
    
    文件列表
  - listDirs
```
public List<FtpFile> listDirs(String path,
                              boolean child)
```
    Description copied from interface: IFtpInstance
    
    列出文件夹
    
    Specified by:
    
    listDirs in interface IFtpInstance
    
    Parameters:
    
    path - 路径
    
    child - 是否遍历
    
    Returns:
    
    文件夹
  - pending
```
public boolean pending()
                throws IOException
```
    Description copied from interface: IFtpInstance
    
    等待处理命令完毕事务
    
    Specified by:
    
    pending in interface IFtpInstance
    
    Returns:
    
    是否完成
    
    Throws:
    
    IOException - IOException
  - restartOffset
```
public void restartOffset(long offset)
```
    Description copied from interface: IFtpInstance
    
    设置偏移量
    
    Specified by:
    
    restartOffset in interface IFtpInstance
    
    Parameters:
    
    offset - offset
  - reset
```
public void reset()
```
    Description copied from interface: IFtpInstance
    
    重置 io
    
    Specified by:
    
    reset in interface IFtpInstance
  - getSystemType
```
public String getSystemType()
```
    Description copied from interface: IFtpInstance
    
    获取系统类型
    
    Specified by:
    
    getSystemType in interface IFtpInstance
    
    Returns:
    
    系统类型
  - getStatus
```
public String getStatus()
```
    Description copied from interface: IFtpInstance
    
    获取文件夹状态
    
    Specified by:
    
    getStatus in interface IFtpInstance
    
    Returns:
    
    状态
  - getStatus
```
public String getStatus(String path)
```
    Description copied from interface: IFtpInstance
    
    获取文件夹状态会获取文件列表
    
    Specified by:
    
    getStatus in interface IFtpInstance
    
    Parameters:
    
    path - 文件夹
    
    Returns:
    
    状态
  - getClient
```
public org.apache.commons.net.ftp.FTPClient getClient()
```
    Description copied from interface: IFtpInstance
    
    获取连接
    
    Specified by:
    
    getClient in interface IFtpInstance
    
    Returns:
    
    client
  - getConfig
```
public FtpConfig getConfig()
```
    Description copied from interface: IFtpInstance
    
    获取配置
    
    Specified by:
    
    getConfig in interface IFtpInstance
    
    Returns:
    
    config
  - getPool
```
public FtpClientPool getPool()
```
    Description copied from interface: IFtpInstance
    
    获取连接池
    
    Specified by:
    
    getPool in interface IFtpInstance
    
    Returns:
    
    连接池
  - sendNoop
```
public boolean sendNoop()
                 throws IOException
```
    Description copied from interface: IFtpInstance
    
    发送心跳
    
    Specified by:
    
    sendNoop in interface IFtpInstance
    
    Returns:
    
    true存活
    
    Throws:
    
    IOException - IOException
  - serverCharset
```
public String serverCharset(String chars)
```
    Description copied from interface: IFtpInstance
    
    ftp 服务文件编码
    
    Specified by:
    
    serverCharset in interface IFtpInstance
    
    Parameters:
    
    chars - chars
    
    Returns:
    
    编码
  - localCharset
```
public String localCharset(String chars)
```
    Description copied from interface: IFtpInstance
    
    本地编码
    
    Specified by:
    
    localCharset in interface IFtpInstance
    
    Parameters:
    
    chars - chars
    
    Returns:
    
    编码
  - destroy
```
public void destroy()
```
    Description copied from interface: Destroyable
    
    销毁
    
    Specified by:
    
    destroy in interface Destroyable
  - close
```
public void close()
```
    Description copied from interface: SafeCloseable
    
    安全关闭
    
    Specified by:
    
    close in interface SafeCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class BaseFtpInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cn.orionsec.kit.net.ftp.client.instance.IFtpInstance

Field Detail

SEPARATOR

client

config

pool

bufferSize

Constructor Detail

BaseFtpInstance

BaseFtpInstance

Method Detail

replyCode

replyMsg

reply

transfer

transfer

doTransfer

write

write

doWrite

append

append

doAppend

uploadFile

downloadFile

listFiles

listDirs

pending

restartOffset

reset

getSystemType

getStatus

getStatus

getClient

getConfig

getPool

sendNoop

serverCharset

localCharset

destroy

close