パッケージ org.springframework.integration.ftp.gateway

クラス FtpOutboundGateway

java.lang.ObjectSE
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.handler.AbstractMessageProducingHandler
org.springframework.integration.handler.AbstractReplyProducingMessageHandler
org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile>
org.springframework.integration.ftp.gateway.FtpOutboundGateway
実装されたすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>、Aware、BeanClassLoaderAware、BeanFactoryAware、BeanNameAware、DisposableBean、InitializingBean、ApplicationContextAware、Ordered、ExpressionCapable、Orderable、MessageProducer、HeaderPropagationAware、IntegrationPattern、NamedComponent、IntegrationManagement、TrackableComponent、MessageHandler、reactor.core.CoreSubscriber<Message<?>>
public class FtpOutboundGateway extends AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile>
FTP/FTPS 経由でリモートファイル操作を実行するための送信ゲートウェイ。
導入:
2.1
作成者:
Gary Russell, Artem Bilan

  • コンストラクターの詳細

    • FtpOutboundGateway

      public FtpOutboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)
      提供されたセッションファクトリとセッションで操作を実行するためのコールバックを使用してインスタンスを構築します。
      パラメーター:
      sessionFactory - セッションファクトリ。
      messageSessionCallback - コールバック。

    • FtpOutboundGateway

      public FtpOutboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, MessageSessionCallback<org.apache.commons.net.ftp.FTPFile,?> messageSessionCallback)
      提供されたリモートファイルテンプレートと、セッションで操作を実行するためのコールバックを使用してインスタンスを構築します。
      パラメーター:
      remoteFileTemplate - リモートファイルテンプレート。
      messageSessionCallback - コールバック。

    • FtpOutboundGateway

      public FtpOutboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, StringSE command, StringSE expression)
      指定されたセッションファクトリ、コマンド（ "ls"、"get" など）、ファイル名を決定する式を使用してインスタンスを構築します。
      パラメーター:
      sessionFactory - セッションファクトリ。
      command - コマンド。
      expression - ファイル名式。

    • FtpOutboundGateway

      public FtpOutboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, StringSE command, StringSE expression)
      指定されたリモートファイルテンプレート、コマンド（ "ls"、"get" など）、ファイル名を決定する式を使用してインスタンスを構築します。
      パラメーター:
      remoteFileTemplate - リモートファイルテンプレート。
      command - コマンド。
      expression - ファイル名式。

    • FtpOutboundGateway

      public FtpOutboundGateway(SessionFactory<org.apache.commons.net.ftp.FTPFile> sessionFactory, StringSE command)
      提供されたセッションファクトリとコマンド（'ls'、'nlst'、'put' または 'mput' ）を使用してインスタンスを構築します。

      remoteDirectory 式は、null であり、FTP クライアントから workingDirectory を使用することを想定しています。

      パラメーター:
      sessionFactory - セッションファクトリ。
      command - コマンド。
      導入:
      4.3

    • FtpOutboundGateway

      public FtpOutboundGateway(RemoteFileTemplate<org.apache.commons.net.ftp.FTPFile> remoteFileTemplate, StringSE command)
      提供されたリモートファイルテンプレートとコマンド（'ls'、'nlst'、'put' または 'mput' ）を使用してインスタンスを構築します。

      remoteDirectory 式は、null であり、FTP クライアントから workingDirectory を使用することを想定しています。

      パラメーター:
      remoteFileTemplate - リモートファイルテンプレート。
      command - コマンド。
      導入:
      4.3

  • メソッドの詳細

    • setWorkingDirExpression

      public void setWorkingDirExpression(Expression workingDirExpression)
      Expression を指定して、リクエストメッセージに対して FTP クライアントの作業ディレクトリを評価します。
      パラメーター:
      workingDirExpression - 作業ディレクトリを評価する式
      導入:
      5.0

    • setWorkingDirExpressionString

      public void setWorkingDirExpressionString(StringSE workingDirExpression)
      SpEL Expression を指定して、リクエストメッセージに対して FTP クライアントの作業ディレクトリを評価します。
      パラメーター:
      workingDirExpression - 作業ディレクトリを評価する SpEL 式
      導入:
      5.0

    • getComponentType

      public StringSE getComponentType()
      クラスからコピーされた説明: IntegrationObjectSupport
      サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
      次で指定:
      インターフェース NamedComponent の getComponentType 
      オーバーライド:
      クラス MessageHandlerSupport の getComponentType 

    • isDirectory

      protected boolean isDirectory(org.apache.commons.net.ftp.FTPFile file)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の isDirectory 

    • isLink

      protected boolean isLink(org.apache.commons.net.ftp.FTPFile file)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の isLink 

    • getFilename

      protected StringSE getFilename(org.apache.commons.net.ftp.FTPFile file)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の getFilename 

    • getFilename

      protected StringSE getFilename(AbstractFileInfo<org.apache.commons.net.ftp.FTPFile> file)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の getFilename 

    • getModified

      protected long getModified(org.apache.commons.net.ftp.FTPFile file)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の getModified 

    • asFileInfoList

      protected ListSE<AbstractFileInfo<org.apache.commons.net.ftp.FTPFile>> asFileInfoList(CollectionSE<org.apache.commons.net.ftp.FTPFile> files)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の asFileInfoList 

    • doInit

      protected void doInit()
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の doInit 

    • enhanceNameWithSubDirectory

      protected org.apache.commons.net.ftp.FTPFile enhanceNameWithSubDirectory(org.apache.commons.net.ftp.FTPFile file, StringSE directory)
      次で指定:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の enhanceNameWithSubDirectory 

    • ls

      protected ListSE<?> ls(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE dir) throws IOExceptionSE
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      リモートファイルをローカル表現にリストします。現在のリクエストのコンテキストについては、メッセージを参照できます。デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の ls 
      パラメーター:
      message - リストリクエストに関連するメッセージ
      session - list コマンドを実行するセッション
      dir - コンテンツをリストするリモートディレクトリ
      戻り値:
      リモートファイルのリスト
      例外:
      IOExceptionSE - リモートコマンドの実行中の IO 例外

    • nlst

      protected ListSE<StringSE> nlst(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE dir) throws IOExceptionSE
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      指定されたディレクトリのリモートファイル名を一覧表示します。メッセージは、現在のリクエストに関連するいくつかのコンテキストについて調べることができます。デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の nlst 
      パラメーター:
      message - 現在のリクエストに関連するメッセージ
      session - list file names コマンドを実行するセッション
      dir - ファイル名をリストするリモートディレクトリ
      戻り値:
      指定されたディレクトリ内のファイル / ディレクトリ名のリスト
      例外:
      IOExceptionSE - リモートコマンドの実行中の IO 例外

    • get

      protected FileSE get(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE remoteDir, StringSE remoteFilePath, StringSE remoteFilename, org.apache.commons.net.ftp.FTPFile fileInfoParam) throws IOExceptionSE
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      リモートファイルを構成済みのローカルディレクトリにコピーします。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の get 
      パラメーター:
      message - メッセージ。
      session - セッション。
      remoteDir - リモートディレクトリ。
      remoteFilePath - リモートファイルのパス。
      remoteFilename - リモートファイル名。
      fileInfoParam - リモートファイル情報。null の場合、最初に "ls" コマンドを実行します。
      戻り値:
      ファイル。
      例外:
      IOExceptionSE - IOException。

    • mGet

      protected ListSE<FileSE> mGet(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE remoteDirectory, StringSE remoteFilename) throws IOExceptionSE
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の mGet 
      例外:
      IOExceptionSE

    • rm

      protected boolean rm(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE remoteFilePath) throws IOExceptionSE
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      指定されたパスに対してリモート削除を実行します。メッセージを参照して、コンテキストを判別できます。デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の rm 
      パラメーター:
      message - 削除するパスに関連するリクエストメッセージ
      session - 削除コマンドを実行するためのリモートプロトコルセッション
      remoteFilePath - 削除するリモートパス
      戻り値:
      リモート削除の結果として true または false
      例外:
      IOExceptionSE - リモートコマンドの実行中の IO 例外

    • mv

      protected boolean mv(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE remoteFilePath, StringSE remoteFileNewPath) throws IOExceptionSE
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      リモートパスを別のパスに移動します。メッセージを参照して、コンテキストを判別できます。デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の mv 
      パラメーター:
      message - この移動コマンドに関連するリクエストメッセージ
      session - 移動コマンドを実行するためのリモートプロトコルセッション
      remoteFilePath - ソースリモートパス
      remoteFileNewPath - ターゲットリモートパス
      戻り値:
      操作の結果として true または false
      例外:
      IOExceptionSE - リモートコマンドの実行中の IO 例外

    • put

      protected StringSE put(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, StringSE subDirectory)
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      メッセージに基づいてファイルをリモートサーバーに書き込みます。メッセージを参照して、コンテキストを判別できます。セッション引数は、デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の put 
      パラメーター:
      message - この put コマンドに関連するリクエストメッセージ
      session - この呼び出しコンテキストに関連するリモートプロトコルセッション
      subDirectory - 配置するターゲットのサブディレクトリ
      戻り値:
      リモートパス。ローカルファイルが見つからなかった場合は null。

    • mPut

      protected ListSE<StringSE> mPut(Message<?> message, Session<org.apache.commons.net.ftp.FTPFile> session, FileSE localDir)
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      提供されたディレクトリからリモートサーバーにファイルを再帰的に配置します。メッセージを参照して、コンテキストを判別できます。セッション引数は、デフォルトの実装では使用されません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の mPut 
      パラメーター:
      message - この mPut コマンドに関連するリクエストメッセージ
      session - この呼び出しコンテキストのリモートプロトコルセッション
      localDir - サーバーに出力するローカルディレクトリ
      戻り値:
      送信されたファイルのリモートパスのリスト

    • isChmodCapable

      public boolean isChmodCapable()
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の isChmodCapable 

    • doChmod

      protected void doChmod(RemoteFileOperations<org.apache.commons.net.ftp.FTPFile> remoteFileOperations, StringSE path, int chmod)
      クラスからコピーされた説明: AbstractRemoteFileOutboundGateway
      転送後にリモートファイルでモードを設定します。デフォルトの実装は何もしません。
      オーバーライド:
      クラス AbstractRemoteFileOutboundGateway<org.apache.commons.net.ftp.FTPFile> の doChmod 
      パラメーター:
      remoteFileOperations - リモートファイルテンプレート。
      path - パス。
      chmod - 設定する chmod。