インターフェース RemoteFileOperations<F>

型パラメーター:
F - ファイル型。
すべての既知の実装クラス:
FtpRemoteFileTemplate、RemoteFileTemplate、SftpRemoteFileTemplate、SmbRemoteFileTemplate
public interface RemoteFileOperations<F>
リモートファイルに対して操作を実行するための戦略。
導入:
3.0
作成者:
Gary Russell, Artem Bilan

  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    RemoteFileOperations.OperationsCallback<F,T>
    複数の RemoteFileTemplate 操作に同じセッションを使用するためのコールバック。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    @Nullable StringSE
    append(Message<?> message)
    メッセージの情報に基づいて、ファイルをリモートサーバーに追加します。
    @Nullable StringSE
    append(Message<?> message, @Nullable StringSE subDirectory)
    メッセージの情報に基づいて、ファイルをリモートサーバーに追加します。
    <T> @Nullable T
    execute(SessionCallback<F,T> callback)
    セッションを取得した後、コールバックの doInSession メソッドを実行します。
    <T,C> @Nullable T
    executeWithClient(ClientCallback<C,T> callback)
    セッションのクライアントを取得した後、コールバックの doWithClient メソッドを実行し、低レベルメソッドへのアクセスを提供します。
    boolean
    exists(StringSE path)
    リモートサーバーにファイルが存在するかどうかを確認します。
    boolean
    get(StringSE remotePath, InputStreamCallback callback)
    リモートファイルを InputStream として取得します。
    boolean
    get(Message<?> message, InputStreamCallback callback)
    メッセージ内の情報に基づいて、リモートファイルを InputStream として取得します。
    Session<F>
    getSession()
    生の Session オブジェクトを取得します。
    <T> @Nullable T
    invoke(RemoteFileOperations.OperationsCallback<F,T> action)
    コールバックを呼び出して、専用のスレッドバインドセッションでテンプレート引数に対するすべての操作を実行し、その後確実に閉じます。
    F[]
    list(StringSE path)
    リモートパスのファイルをリストします。
    boolean
    remove(StringSE path)
    リモートファイルを削除します。
    void
    rename(StringSE fromPath, StringSE toPath)
    リモートファイルの名前を変更し、必要に応じてディレクトリを作成します。
    @Nullable StringSE
    send(Message<?> message, @Nullable StringSE subDirectory, FileExistsMode... mode)
    メッセージ内の情報に基づいて、リモートサーバーにファイルを送信します。
    @Nullable StringSE
    send(Message<?> message, FileExistsMode... mode)
    メッセージ内の情報に基づいて、リモートサーバーにファイルを送信します。

  • メソッドの詳細

    • send

      @Nullable StringSE send(Message<?> message, FileExistsMode... mode)
      メッセージ内の情報に基づいて、リモートサーバーにファイルを送信します。
      パラメーター:
      message - メッセージ。
      mode - FileExistsMode（オプション ; デフォルト REPLACE）を参照してください。引数をオプションにするために可変引数が使用されます。複数が提供されている場合は、最初のもののみが使用されます。
      戻り値:
      リモートパス。ローカルファイルが見つからなかった場合は null。

    • send

      @Nullable StringSE send(Message<?> message, @Nullable StringSE subDirectory, FileExistsMode... mode)
      メッセージの情報に基づいて、ファイルを リモートサーバーに送信します。subDirectory は、メッセージから評価された リモートディレクトリに追加されます。
      パラメーター:
      message - メッセージ。
      subDirectory - サブディレクトリ。
      mode - FileExistsMode（オプション ; デフォルト REPLACE）を参照してください。引数をオプションにするために可変引数が使用されます。複数が提供されている場合は、最初のもののみが使用されます。
      戻り値:
      リモートパス。ローカルファイルが見つからなかった場合は null。

    • append

      @Nullable StringSE append(Message<?> message)
      メッセージの情報に基づいて、ファイルをリモートサーバーに追加します。
      パラメーター:
      message - メッセージ。
      戻り値:
      リモートパス。ローカルファイルが見つからなかった場合は null。
      導入:
      4.1

    • append

      @Nullable StringSE append(Message<?> message, @Nullable StringSE subDirectory)
      メッセージ内の情報に基づいて、ファイルを リモートサーバーに送信し、追加します。subDirectory は、メッセージから評価された リモートディレクトリに追加されます。
      パラメーター:
      message - メッセージ。
      subDirectory - サブディレクトリ。
      戻り値:
      リモートパス。ローカルファイルが見つからなかった場合は null。
      導入:
      4.1

    • get

      boolean get(StringSE remotePath, InputStreamCallback callback)
      リモートファイルを InputStream として取得します。
      パラメーター:
      remotePath - ファイルへのリモートパス。
      callback - コールバック。
      戻り値:
      操作が成功した場合は true。

    • get

      boolean get(Message<?> message, InputStreamCallback callback)
      メッセージ内の情報に基づいて、リモートファイルを InputStream として取得します。
      パラメーター:
      message - リモートパスを生成するために評価されるメッセージ。
      callback - コールバック。
      戻り値:
      操作が成功した場合は true。

    • exists

      boolean exists(StringSE path)
      リモートサーバーにファイルが存在するかどうかを確認します。
      パラメーター:
      path - ファイルへのフルパス。
      戻り値:
      ファイルが存在する場合は true。
      導入:
      4.1

    • remove

      boolean remove(StringSE path)
      リモートファイルを削除します。
      パラメーター:
      path - ファイルへのフルパス。
      戻り値:
      成功した場合は true。

    • rename

      void rename(StringSE fromPath, StringSE toPath)
      リモートファイルの名前を変更し、必要に応じてディレクトリを作成します。
      パラメーター:
      fromPath - 現在のパス。
      toPath - 新しいパス。

    • list

      F[] list(StringSE path)
      リモートパスのファイルをリストします。
      パラメーター:
      path - パス。
      戻り値:
      リスト。

    • execute

      <T> @Nullable T execute(SessionCallback<F,T> callback)
      セッションを取得した後、コールバックの doInSession メソッドを実行します。メソッドの終了時に確実にセッションを閉じます。
      型パラメーター:
      T - SessionCallback.doInSession(org.springframework.integration.file.remote.session.Session) によって返される型。
      パラメーター:
      callback - SessionCallback。
      戻り値:
      コールバックメソッドの結果。

    • invoke

      <T> @Nullable T invoke(RemoteFileOperations.OperationsCallback<F,T> action)
      コールバックを呼び出して、専用のスレッドバインドセッションでテンプレート引数に対するすべての操作を実行し、その後確実に閉じます。
      型パラメーター:
      T - 戻り値の型。
      パラメーター:
      action - コールバック。
      戻り値:
      RemoteFileOperations.OperationsCallback.doInOperations(RemoteFileOperations) からの結果
      導入:
      5.0

    • executeWithClient

      <T,C> @Nullable T executeWithClient(ClientCallback<C,T> callback)
      セッションのクライアントを取得した後、コールバックの doWithClient メソッドを実行し、低レベルのメソッドへのアクセスを提供します。メソッドが終了すると、セッションを確実に閉じます。
      型パラメーター:
      T - ClientCallback.doWithClient(Object) によって返される型。
      C - 基礎となるクライアントオブジェクトの型。
      パラメーター:
      callback - ClientCallback。
      戻り値:
      コールバックメソッドの結果。
      導入:
      4.1

    • getSession

      Session<F> getSession()
      生の Session オブジェクトを取得します。ユーザーは、不要になったセッションを閉じる必要があります。
      戻り値:
      セッション。
      導入:
      4.3