Module bus.storage
Package org.miaixz.bus.storage.metric

Class FtpFileProvider

java.lang.Object
org.miaixz.bus.storage.metric.AbstractProvider
org.miaixz.bus.storage.metric.FtpFileProvider
All Implemented Interfaces:
org.miaixz.bus.core.Provider, Provider
public class FtpFileProvider extends AbstractProvider
存储服务-FTP
Since:
Java 17+
Author:
Kimi Liu

  • Field Summary

    Fields inherited from class org.miaixz.bus.storage.metric.AbstractProvider

    context

  • Constructor Summary

    Constructors
    Constructor
    Description
    FtpFileProvider(Context context)
    构造函数，初始化 FTP 客户端。

  • Method Summary

    Modifier and Type
    Method
    Description
    org.miaixz.bus.core.basic.entity.Message
    download(String fileName)
    从默认存储桶下载文件。
    org.miaixz.bus.core.basic.entity.Message
    download(String fileName, File file)
    从默认存储桶下载文件并保存到本地文件。
    org.miaixz.bus.core.basic.entity.Message
    download(String bucket, String fileName)
    从指定存储桶下载文件。
    org.miaixz.bus.core.basic.entity.Message
    download(String bucket, String fileName, File file)
    从指定存储桶下载文件并保存到本地文件。
    org.miaixz.bus.core.basic.entity.Message
    list()
    列出默认存储桶中的文件。
    org.miaixz.bus.core.basic.entity.Message
    remove(String fileName)
    从默认存储桶删除文件。
    org.miaixz.bus.core.basic.entity.Message
    remove(String path, String fileName)
    从默认存储桶的指定路径删除文件。
    org.miaixz.bus.core.basic.entity.Message
    remove(String bucket, String path, String fileName)
    从指定存储桶和路径删除文件。
    org.miaixz.bus.core.basic.entity.Message
    remove(String bucket, Path path)
    从指定存储桶删除指定路径的文件。
    org.miaixz.bus.core.basic.entity.Message
    rename(String oldName, String newName)
    重命名默认存储桶中的文件。
    org.miaixz.bus.core.basic.entity.Message
    rename(String path, String oldName, String newName)
    在默认存储桶的指定路径中重命名文件。
    org.miaixz.bus.core.basic.entity.Message
    rename(String bucket, String path, String oldName, String newName)
    在指定存储桶和路径中重命名文件。
    org.miaixz.bus.core.basic.entity.Message
    upload(String fileName, byte[] content)
    上传字节数组内容到默认存储桶。
    org.miaixz.bus.core.basic.entity.Message
    upload(String fileName, InputStream content)
    上传输入流内容到默认存储桶。
    org.miaixz.bus.core.basic.entity.Message
    upload(String path, String fileName, byte[] content)
    上传字节数组内容到默认存储桶的指定路径。
    org.miaixz.bus.core.basic.entity.Message
    upload(String path, String fileName, InputStream content)
    上传输入流内容到默认存储桶的指定路径。
    org.miaixz.bus.core.basic.entity.Message
    upload(String bucket, String path, String fileName, byte[] content)
    上传字节数组内容到指定存储桶和路径。
    org.miaixz.bus.core.basic.entity.Message
    upload(String bucket, String path, String fileName, InputStream content)
    上传输入流内容到指定存储桶和路径。

    Methods inherited from class org.miaixz.bus.storage.metric.AbstractProvider

    downloadFile, getFullPath

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.miaixz.bus.storage.Provider

    type

  • Constructor Details

    • FtpFileProvider

      public FtpFileProvider(Context context)
      构造函数，初始化 FTP 客户端。
      Parameters:
      context - 存储上下文，包含端点、存储桶、访问密钥、秘密密钥等配置
      Throws:
      IllegalArgumentException - 如果配置参数无效或初始化失败

  • Method Details

    • download

      public org.miaixz.bus.core.basic.entity.Message download(String fileName)
      从默认存储桶下载文件。
      Parameters:
      fileName - 文件名
      Returns:
      处理结果，包含文件内容流或错误信息

    • download

      public org.miaixz.bus.core.basic.entity.Message download(String bucket, String fileName)
      从指定存储桶下载文件。
      Parameters:
      bucket - 存储桶名称
      fileName - 文件名
      Returns:
      处理结果，包含文件内容流或错误信息

    • download

      public org.miaixz.bus.core.basic.entity.Message download(String fileName, File file)
      从默认存储桶下载文件并保存到本地文件。
      Parameters:
      fileName - 文件名
      file - 本地目标文件
      Returns:
      处理结果，包含成功或错误信息

    • download

      public org.miaixz.bus.core.basic.entity.Message download(String bucket, String fileName, File file)
      从指定存储桶下载文件并保存到本地文件。
      Parameters:
      bucket - 存储桶名称
      fileName - 文件名
      file - 本地目标文件
      Returns:
      处理结果，包含成功或错误信息

    • list

      public org.miaixz.bus.core.basic.entity.Message list()
      列出默认存储桶中的文件。
      Returns:
      处理结果，包含文件列表或错误信息

    • rename

      public org.miaixz.bus.core.basic.entity.Message rename(String oldName, String newName)
      重命名默认存储桶中的文件。
      Parameters:
      oldName - 原文件名
      newName - 新文件名
      Returns:
      处理结果，包含成功或错误信息

    • rename

      public org.miaixz.bus.core.basic.entity.Message rename(String path, String oldName, String newName)
      在默认存储桶的指定路径中重命名文件。
      Parameters:
      path - 路径
      oldName - 原文件名
      newName - 新文件名
      Returns:
      处理结果，包含成功或错误信息

    • rename

      public org.miaixz.bus.core.basic.entity.Message rename(String bucket, String path, String oldName, String newName)
      在指定存储桶和路径中重命名文件。
      Parameters:
      bucket - 存储桶名称
      path - 路径
      oldName - 原文件名
      newName - 新文件名
      Returns:
      处理结果，包含成功或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String fileName, byte[] content)
      上传字节数组内容到默认存储桶。
      Parameters:
      fileName - 文件名
      content - 字节数组内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String path, String fileName, byte[] content)
      上传字节数组内容到默认存储桶的指定路径。
      Parameters:
      path - 路径
      fileName - 文件名
      content - 字节数组内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String bucket, String path, String fileName, byte[] content)
      上传字节数组内容到指定存储桶和路径。
      Parameters:
      bucket - 存储桶名称
      path - 路径
      fileName - 文件名
      content - 字节数组内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String fileName, InputStream content)
      上传输入流内容到默认存储桶。
      Parameters:
      fileName - 文件名
      content - 输入流内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String path, String fileName, InputStream content)
      上传输入流内容到默认存储桶的指定路径。
      Parameters:
      path - 路径
      fileName - 文件名
      content - 输入流内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • upload

      public org.miaixz.bus.core.basic.entity.Message upload(String bucket, String path, String fileName, InputStream content)
      上传输入流内容到指定存储桶和路径。
      Parameters:
      bucket - 存储桶名称
      path - 路径
      fileName - 文件名
      content - 输入流内容
      Returns:
      处理结果，包含上传的文件信息或错误信息

    • remove

      public org.miaixz.bus.core.basic.entity.Message remove(String fileName)
      从默认存储桶删除文件。
      Parameters:
      fileName - 文件名
      Returns:
      处理结果，包含成功或错误信息

    • remove

      public org.miaixz.bus.core.basic.entity.Message remove(String path, String fileName)
      从默认存储桶的指定路径删除文件。
      Parameters:
      path - 路径
      fileName - 文件名
      Returns:
      处理结果，包含成功或错误信息

    • remove

      public org.miaixz.bus.core.basic.entity.Message remove(String bucket, String path, String fileName)
      从指定存储桶和路径删除文件。
      Parameters:
      bucket - 存储桶名称
      path - 路径
      fileName - 文件名
      Returns:
      处理结果，包含成功或错误信息

    • remove

      public org.miaixz.bus.core.basic.entity.Message remove(String bucket, Path path)
      从指定存储桶删除指定路径的文件。
      Parameters:
      bucket - 存储桶名称
      path - 文件路径
      Returns:
      处理结果，包含成功或错误信息