クラス RemoteFileOutboundGatewaySpec<F, S extends RemoteFileOutboundGatewaySpec<F,S>>

java.lang.ObjectSE
org.springframework.integration.dsl.IntegrationComponentSpec <S、AbstractRemoteFileOutboundGateway <F>>
org.springframework.integration.dsl.MessageHandlerSpec <S、AbstractRemoteFileOutboundGateway <F>>
org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec<F,S>
型パラメーター:
F - ターゲットファイル型。
S - ターゲット RemoteFileOutboundGatewaySpec 実装型。
実装済みのインターフェース一覧:
DisposableBean、FactoryBean<AbstractRemoteFileOutboundGateway<F>>、InitializingBean、Lifecycle、Phased、SmartLifecycle、ComponentsRegistration
既知の直属サブクラス
FtpOutboundGatewaySpec、SftpOutboundGatewaySpec、SmbOutboundGatewaySpec
public abstract class RemoteFileOutboundGatewaySpec<F, S extends RemoteFileOutboundGatewaySpec<F,S>> extends MessageHandlerSpec<S, AbstractRemoteFileOutboundGateway<F>> implements ComponentsRegistration
AbstractRemoteFileOutboundGateway の MessageHandlerSpec。
導入:
5.0
作成者:
Artem Bilan, Gary Russell, Jooyoung Pyoung

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

  • メソッドの詳細

    • options

      public S options(StringSE options)
      さまざまなゲートウェイコマンドのオプションの配列を指定します。
      パラメーター:
      options - 設定するオプション。
      戻り値:
      スペック
      関連事項:

    • options

      public S options(AbstractRemoteFileOutboundGateway.Option... options)
      さまざまなゲートウェイコマンドの AbstractRemoteFileOutboundGateway.Option の配列を指定します。
      パラメーター:
      options - 設定するオプション。
      戻り値:
      スペック

    • remoteFileSeparator

      public S remoteFileSeparator(StringSE remoteFileSeparator)
      リモートファイルを処理するときにファイル区切り文字を設定します。デフォルト '/'。
      パラメーター:
      remoteFileSeparator - セパレータ。
      戻り値:
      スペック

    • localDirectory

      public S localDirectory(FileSE localDirectory)
      リモートファイルの転送先のディレクトリパスを指定します。
      パラメーター:
      localDirectory - 設定する localDirectory
      戻り値:
      スペック

    • localDirectoryExpression

      public S localDirectoryExpression(StringSE localDirectoryExpression)
      SpEL 式を指定して、リモートファイルの転送先のディレクトリパスを評価します。
      パラメーター:
      localDirectoryExpression - ローカルディレクトリを決定する SpEL。
      戻り値:
      スペック

    • localDirectory

      public <P> S localDirectory(FunctionSE<Message<P>, StringSE> localDirectoryFunction)
      FunctionSE を指定して、リモートファイルの転送先のディレクトリパスを評価します。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      localDirectoryFunction - ローカルディレクトリを決定するための FunctionSE。
      戻り値:
      スペック

    • localDirectoryExpression

      public S localDirectoryExpression(Expression localDirectoryExpression)
      SpEL 式を指定して、リモートファイルの転送先のディレクトリパスを評価します。
      パラメーター:
      localDirectoryExpression - ローカルディレクトリを評価するための SpEL 式。
      戻り値:
      スペック

    • autoCreateLocalDirectory

      public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)
      ローカルディレクトリを自動的に作成する必要があるかどうかを識別する boolean フラグ。デフォルトは true です。
      パラメーター:
      autoCreateLocalDirectory - 設定する autoCreateLocalDirectory
      戻り値:
      スペック

    • temporaryFileSuffix

      public S temporaryFileSuffix(StringSE temporaryFileSuffix)
      リモートシステムにファイルを転送するときに使用する一時的なサフィックスを設定します。デフォルト .writing。
      パラメーター:
      temporaryFileSuffix - 設定する temporaryFileSuffix
      戻り値:
      スペック

    • filter

      public S filter(FileListFilter<F> filter)
      リモートファイルをフィルタリングするように FileListFilter を設定します。
      パラメーター:
      filter - 設定するフィルター
      戻り値:
      スペック

    • filterExpression

      public S filterExpression(StringSE expression)
      ExpressionFileListFilter を構成します。
      パラメーター:
      expression - ファイルフィルタリング用の SpEL 式。
      戻り値:
      スペック。
      関連事項:

    • filterFunction

      public S filterFunction(FunctionSE<F,BooleanSE> filterFunction)
      ExpressionFileListFilter を構成します。
      パラメーター:
      filterFunction - ファイルフィルタリング用の FunctionSE。
      戻り値:
      スペック。
      関連事項:

    • mputFilter

      public S mputFilter(FileListFilter<FileSE> filter)
      MPUT コマンドの使用時にローカルファイルシステムビューに対して実行される FileListFilter。
      パラメーター:
      filter - 設定するフィルター
      戻り値:
      スペック

    • patternMputFilter

      public S patternMputFilter(StringSE pattern)
      MPUT コマンドの使用時にローカルファイルシステムビューに対して実行される SimplePatternFileListFilter。
      パラメーター:
      pattern - MPUT コマンドの SimplePatternFileListFilter。
      戻り値:
      スペック

    • regexMputFilter

      public S regexMputFilter(StringSE regex)
      MPUT コマンドの使用時にローカルファイルシステムビューに対して実行される SimplePatternFileListFilter。
      パラメーター:
      regex - MPUT コマンドの SimplePatternFileListFilter。
      戻り値:
      スペック

    • mputFilterExpression

      public S mputFilterExpression(StringSE expression)
      ExpressionFileListFilter を構成します。
      パラメーター:
      expression - ファイルフィルタリング用の SpEL 式。
      戻り値:
      スペック。
      関連事項:

    • mputFilterFunction

      public S mputFilterFunction(FunctionSE<FileSE,BooleanSE> filterFunction)
      ExpressionFileListFilter を構成します。
      パラメーター:
      filterFunction - ファイルフィルタリング用の FunctionSE。
      戻り値:
      スペック。
      関連事項:

    • renameExpression

      public S renameExpression(StringSE expression)
      転送中にファイル名を変更するための SpEL 式を指定します。
      パラメーター:
      expression - SpEL 構文の文字列。
      戻り値:
      スペック

    • renameExpression

      public S renameExpression(Expression expression)
      転送中にファイル名を変更するための SpEL 式を指定します。
      パラメーター:
      expression - SpEL 構文の文字列。
      戻り値:
      スペック

    • renameFunction

      public <P> S renameFunction(FunctionSE<Message<P>, StringSE> renameFunction)
      転送中にファイルの名前を変更する場合は、FunctionSE を指定します。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      renameFunction - 使用する FunctionSE。
      戻り値:
      スペック

    • localFilenameExpression

      public S localFilenameExpression(StringSE localFilenameExpression)
      ダウンロード後にローカルファイルの名前を変更するための SpEL 式を指定します。
      パラメーター:
      localFilenameExpression - 使用する SpEL 式。
      戻り値:
      スペック

    • localFilenameFunction

      public <P> S localFilenameFunction(FunctionSE<Message<P>, StringSE> localFilenameFunction)
      ダウンロード後に名前を変更するローカルファイルには FunctionSE を指定します。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      localFilenameFunction - 使用する FunctionSE。
      戻り値:
      スペック
      導入:
      5.2

    • localFilenameExpression

      public S localFilenameExpression(Expression localFilenameExpression)
      ダウンロード後にローカルファイルの名前を変更するための SpEL 式を指定します。
      パラメーター:
      localFilenameExpression - ローカルファイル名を評価するための SpEL 式。
      戻り値:
      スペック

    • chmod

      public S chmod(int chmod)
      アップロード後にファイルのアクセス許可を設定します。所有者の読み取り / 書き込みの場合は 0600。
      パラメーター:
      chmod - 許可。
      戻り値:
      現在のスペック

    • fileExistsMode

      public S fileExistsMode(FileExistsMode fileExistsMode)
      ファイルがすでにローカルに存在する場合に GET および MGET 操作を使用する場合、またはファイルがリモートシステムに存在する場合に PUT および MPUT を使用する場合に実行するアクションを決定します。
      パラメーター:
      fileExistsMode - fileExistsMode を設定します。
      戻り値:
      現在のスペック

    • fileExistsModeExpression

      public S fileExistsModeExpression(Expression fileExistsModeExpression)
      ファイルがすでに存在する場合に実行するアクションを決定する SpEL 式を指定します。式の評価は FileExistsMode または文字列表現を返す必要があります。ファイルがすでにローカルに存在する場合は GET および MGET 操作に、ファイルがリモートシステムに存在する場合は PUT および MPUT 操作に使用されます。
      パラメーター:
      fileExistsModeExpression - ファイルの存在モードを評価するための SpEL 式
      戻り値:
      スペック
      導入:
      6.5

    • fileExistsModeExpression

      public S fileExistsModeExpression(StringSE fileExistsModeExpression)
      ファイルがすでに存在する場合に実行するアクションを決定する SpEL 式を指定します。式の評価は FileExistsMode または文字列表現を返す必要があります。ファイルがすでにローカルに存在する場合は GET および MGET 操作に、ファイルがリモートシステムに存在する場合は PUT および MPUT 操作に使用されます。
      パラメーター:
      fileExistsModeExpression - SpEL 構文の文字列。
      戻り値:
      スペック
      導入:
      6.5

    • fileExistsModeFunction

      public <P> S fileExistsModeFunction(FunctionSE<Message<P>, ObjectSE> fileExistsModeFunction)
      ファイルがすでに存在する場合のアクションを決定するには、FunctionSE を指定します。式の評価は、FileExistsMode または文字列表現を返す必要があります。ファイルがすでにローカルに存在する場合は GET および MGET 操作に、ファイルが リモートシステムに存在する場合は PUT および MPUT 操作に使用されます。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      fileExistsModeFunction - 使用する FunctionSE。
      戻り値:
      スペック
      導入:
      6.5

    • autoCreateDirectory

      public S autoCreateDirectory(boolean autoCreateDirectory)
      ファイルをリモートシステムに送信するときに、リモートディレクトリを自動的に作成するかどうかを決定します。
      パラメーター:
      autoCreateDirectory - ディレクトリを作成する場合は true。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • remoteDirectoryExpression

      public S remoteDirectoryExpression(StringSE remoteDirectoryExpression)
      ファイルの送信先となるリモートディレクトリの判別に使用されるリモートディレクトリ式を設定します。
      パラメーター:
      remoteDirectoryExpression - リモートディレクトリ式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • remoteDirectoryFunction

      public <P> S remoteDirectoryFunction(FunctionSE<Message<P>, StringSE> remoteDirectoryFunction)
      リモートディレクトリに FunctionSE を指定します。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      remoteDirectoryFunction - 使用する FunctionSE。
      戻り値:
      スペック
      導入:
      5.2
      関連事項:

    • remoteDirectoryExpression

      public S remoteDirectoryExpression(Expression remoteDirectoryExpression)
      ファイルの送信先となるリモートディレクトリの判別に使用されるリモートディレクトリ式を設定します。
      パラメーター:
      remoteDirectoryExpression - リモートディレクトリ式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • temporaryRemoteDirectoryExpression

      public S temporaryRemoteDirectoryExpression(StringSE temporaryRemoteDirectoryExpression)
      一時的なリモートディレクトリ式を設定します。ファイルをリモートシステムに転送するときに使用されます。
      パラメーター:
      temporaryRemoteDirectoryExpression - 一時的なリモートディレクトリ式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • temporaryRemoteDirectoryFunction

      public <P> S temporaryRemoteDirectoryFunction(FunctionSE<Message<P>, StringSE> temporaryRemoteDirectoryFunction)
      一時的なリモートディレクトリ機能を設定します。リモートシステムにファイルを転送するときに使用されます。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      temporaryRemoteDirectoryFunction - ファイル名式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • temporaryRemoteDirectoryExpression

      public S temporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)
      一時的なリモートディレクトリ式を設定します。ファイルをリモートシステムに転送するときに使用されます。
      パラメーター:
      temporaryRemoteDirectoryExpression - 一時的なリモートディレクトリ式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • fileNameExpression

      public S fileNameExpression(StringSE fileNameExpression)
      ファイル名の式を設定して、リモートファイルへの絶対パスを決定します。
      パラメーター:
      fileNameExpression - ファイル名式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • fileNameFunction

      public <P> S fileNameFunction(FunctionSE<Message<P>, StringSE> fileNameFunction)
      ファイル名関数を設定して、リモートファイルへのフルパスを決定します。
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      fileNameFunction - ファイル名式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • fileNameExpression

      public S fileNameExpression(Expression fileNameExpression)
      ファイル名の式を設定して、リモートファイルへの絶対パスを決定します。
      パラメーター:
      fileNameExpression - ファイル名式。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • useTemporaryFileName

      public S useTemporaryFileName(boolean useTemporaryFileName)
      リモートシステムにファイルを送信するときに一時ファイル名を使用するかどうかを設定します。
      パラメーター:
      useTemporaryFileName - 一時ファイル名を使用する場合は true。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • fileNameGenerator

      public S fileNameGenerator(FileNameGenerator fileNameGenerator)
      ファイルをリモートシステムに転送するときに使用されるリモートファイル名の生成に使用されるファイル名ジェネレーターを設定します。
      パラメーター:
      fileNameGenerator - ファイル名ジェネレーター。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • charset

      public S charset(StringSE charset)
      文字列ペイロードをリモートファイルのコンテンツとしてバイトに変換するときに使用する文字セットを設定します。デフォルト UTF-8
      パラメーター:
      charset - 文字セット。
      戻り値:
      現在のスペック
      導入:
      5.2
      関連事項:

    • getComponentsToRegister

      public MapSE<ObjectSE, @Nullable StringSE> getComponentsToRegister()
      次で指定:
      インターフェース ComponentsRegistration の getComponentsToRegister 

    • patternFileNameFilter

      public abstract S patternFileNameFilter(StringSE pattern)
      リモートファイルに一致する単純なパターンを指定します（例: '*.txt' ）。
      パラメーター:
      pattern - パターン。
      戻り値:
      スペック。
      関連事項:

    • regexFileNameFilter

      public abstract S regexFileNameFilter(StringSE regex)
      リモートファイルに一致する単純なパターンを指定します（例: '[0-9].*.txt'）。
      パラメーター:
      regex - 正規表現パターン。
      戻り値:
      スペック。
      関連事項: