RemoteFileInboundChannelAdapterSpec (Spring Integration API)

java.lang.ObjectSE
- org.springframework.beans.factory.config.AbstractFactoryBean<T>
- - org.springframework.integration.dsl.IntegrationComponentSpec<S,H>
  - - org.springframework.integration.dsl.MessageSourceSpec<S,MS>
    - - org.springframework.integration.file.dsl.RemoteFileInboundChannelAdapterSpec<F,S,MS>

型パラメーター:
F - ターゲットファイル型。
S - ターゲット RemoteFileInboundChannelAdapterSpec 実装型。
MS - ターゲット AbstractInboundFileSynchronizingMessageSource 実装型。
実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<MS>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration
既知の直属サブクラス
FtpInboundChannelAdapterSpec, SftpInboundChannelAdapterSpec
```
public abstract class RemoteFileInboundChannelAdapterSpec<F,S extends RemoteFileInboundChannelAdapterSpec<F,S,MS>,MS extends AbstractInboundFileSynchronizingMessageSource<F>>
extends MessageSourceSpec<S,MS>
implements ComponentsRegistration
```
AbstractInboundFileSynchronizingMessageSource の MessageSourceSpec。
導入:
5.0
作成者:
Artem Bilan, Gary Russell

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected AbstractInboundFileSynchronizer<F> synchronizer
- クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
  PARSER, target
- クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

フィールド
修飾子と型	フィールドと説明
`protected AbstractInboundFileSynchronizer<F>`	`synchronizer`

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected RemoteFileInboundChannelAdapterSpec(AbstractInboundFileSynchronizer<F> synchronizer)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`RemoteFileInboundChannelAdapterSpec(AbstractInboundFileSynchronizer<F> synchronizer)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`S`	`autoCreateLocalDirectory(boolean autoCreateLocalDirectory)` ローカルディレクトリをアダプターで作成するかどうかを設定します。
`S`	`deleteRemoteFiles(boolean deleteRemoteFiles)` 転送に成功した後、リモートファイルの削除を有効にするには、true に設定します。
`S`	`filter(FileListFilter<F> filter)` `FileListFilter` をコピーする前に、リモートファイルに適用するように構成します。
`S`	`filterExpression(StringSE expression)` `ExpressionFileListFilter` を構成します。
`S`	`filterFunction(java.util.function.FunctionSE<F, BooleanSE> filterFunction)` `ExpressionFileListFilter` を構成します。
`MapSE<ObjectSE, StringSE>`	`getComponentsToRegister()`
`S`	`localDirectory(FileSE localDirectory)` ファイルのコピー先のローカルディレクトリを構成します。
`S`	`localFilename(java.util.function.FunctionSE<StringSE, StringSE> localFilenameFunction)` ローカルファイル名を生成するために呼び出されるように `Function`SE を構成します。`apply` メソッドに渡される引数はリモートファイル名です。
`S`	`localFilenameExpression(Expression localFilenameExpression)` ローカルファイル名を生成するように SpEL 式を構成します。評価のルートオブジェクトはリモートファイル名です。
`S`	`localFilenameExpression(StringSE localFilenameExpression)` ローカルファイル名を生成するように SpEL 式を構成します。評価のルートオブジェクトはリモートファイル名です。
`S`	`localFilter(FileListFilter<FileSE> localFileListFilter)` 同期後にメッセージを生成するファイルを決定するために使用される `FileListFilter`。
`S`	`maxFetchSize(int maxFetchSize)` フェッチの試行ごとにフェッチされるリモートファイルの最大数を指定します。
`S`	`metadataStorePrefix(StringSE metadataStorePrefix)` リモートファイルのメタデータキーのプレフィックスを構成します。
`abstract S`	`patternFilter(StringSE pattern)` 単純なパターンフィルターを構成します（例:
`S`	`preserveTimestamp(boolean preserveTimestamp)` true に設定すると、転送時にリモートファイルのタイムスタンプの保存が有効になります。
`abstract S`	`regexFilter(StringSE regex)` 正規表現パターンフィルターを構成します（例:
`S`	`remoteComparator(ComparatorSE<F> remoteComparator)` フィルターと最大フェッチサイズを適用する前に、`F` （リモートファイルを表す型）の取得リストをソートするコンパレーターを設定します。
`S`	`remoteDirectory(StringSE remoteDirectory)` リモートディレクトリへの絶対パスを指定します。
`S`	`remoteDirectoryExpression(Expression remoteDirectoryExpression)` リモートディレクトリへの絶対パスに評価される式を指定します。
`S`	`remoteFileMetadataStore(MetadataStore remoteFileMetadataStore)` リモートファイルのメタデータ用に `MetadataStore` を構成します。
`S`	`remoteFileSeparator(StringSE remoteFileSeparator)` リモートシステムで使用されるファイル名パス区切り文字を構成します。
`S`	`scanner(DirectoryScanner scanner)` 転送後のファイルシステムスキャンに使用するスキャナーを構成します。
`S`	`temporaryFileSuffix(StringSE temporaryFileSuffix)` ローカルファイル名に一時的に適用するサフィックスを構成します。コピーされると、ファイルの名前は最終的な名前に変更されます。

クラス org.springframework.integration.dsl.MessageSourceSpec から継承されたメソッド
messageHeaders

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - synchronizer
```
protected final AbstractInboundFileSynchronizer<F> synchronizer
```
- コンストラクターの詳細
  - RemoteFileInboundChannelAdapterSpec
```
protected RemoteFileInboundChannelAdapterSpec(AbstractInboundFileSynchronizer<F> synchronizer)
```
- メソッドの詳細
  - autoCreateLocalDirectory
```
public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)
```
    ローカルディレクトリをアダプターで作成するかどうかを設定します。
    パラメーター:
    autoCreateLocalDirectory - autoCreateLocalDirectory
    戻り値:
    スペック。
  - localDirectory
```
public S localDirectory(FileSE localDirectory)
```
    ファイルのコピー先のローカルディレクトリを構成します。
    パラメーター:
    localDirectory - localDirectory。
    戻り値:
    スペック。
  - localFilter
```
public S localFilter(FileListFilter<FileSE> localFileListFilter)
```
    同期後にメッセージを生成するファイルを決定するために使用される FileListFilter。
    パラメーター:
    localFileListFilter - localFileListFilter。
    戻り値:
    スペック。
    関連事項:
    AbstractInboundFileSynchronizingMessageSource.setLocalFilter(FileListFilter)
  - remoteFileSeparator
```
public S remoteFileSeparator(StringSE remoteFileSeparator)
```
    リモートシステムで使用されるファイル名パス区切り文字を構成します。デフォルトは "/" です。
    パラメーター:
    remoteFileSeparator - remoteFileSeparator。
    戻り値:
    スペック。
  - localFilenameExpression
```
public S localFilenameExpression(StringSE localFilenameExpression)
```
    ローカルファイル名を生成するように SpEL 式を構成します。評価のルートオブジェクトはリモートファイル名です。
    パラメーター:
    localFilenameExpression - localFilenameExpression。
    戻り値:
    スペック。
  - localFilename
```
public S localFilename(java.util.function.FunctionSE<StringSE,StringSE> localFilenameFunction)
```
    ローカルファイル名を生成するために呼び出されるように FunctionSE を構成します。apply メソッドに渡される引数はリモートファイル名です。
    パラメーター:
    localFilenameFunction - localFilenameFunction。
    戻り値:
    スペック。
    関連事項:
    FunctionExpression
  - localFilenameExpression
```
public S localFilenameExpression(Expression localFilenameExpression)
```
    ローカルファイル名を生成するように SpEL 式を構成します。評価のルートオブジェクトはリモートファイル名です。
    パラメーター:
    localFilenameExpression - localFilenameExpression。
    戻り値:
    スペック。
  - temporaryFileSuffix
```
public S temporaryFileSuffix(StringSE temporaryFileSuffix)
```
    ローカルファイル名に一時的に適用するサフィックスを構成します。コピーされると、ファイルの名前は最終的な名前に変更されます。デフォルト: ".writing"。
    パラメーター:
    temporaryFileSuffix - temporaryFileSuffix。
    戻り値:
    スペック。
  - remoteDirectory
```
public S remoteDirectory(StringSE remoteDirectory)
```
    リモートディレクトリへの絶対パスを指定します。
    パラメーター:
    remoteDirectory - remoteDirectory。
    戻り値:
    スペック。
    関連事項:
    AbstractInboundFileSynchronizer.setRemoteDirectory(String)
  - remoteDirectoryExpression
```
public S remoteDirectoryExpression(Expression remoteDirectoryExpression)
```
    リモートディレクトリへの絶対パスに評価される式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式。
    戻り値:
    スペック。
  - filter
```
public S filter(FileListFilter<F> filter)
```
    FileListFilter をコピーする前に、リモートファイルに適用するように構成します。
    パラメーター:
    filter - フィルター。
    戻り値:
    スペック。
  - filterExpression
```
public S filterExpression(StringSE expression)
```
    ExpressionFileListFilter を構成します。
    パラメーター:
    expression - ファイルフィルタリング用の SpEL 式。
    戻り値:
    スペック。
    関連事項:
    FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter
  - filterFunction
```
public S filterFunction(java.util.function.FunctionSE<F,BooleanSE> filterFunction)
```
    ExpressionFileListFilter を構成します。
    パラメーター:
    filterFunction - ファイルフィルタリング用の FunctionSE。
    戻り値:
    スペック。
    関連事項:
    FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter
  - patternFilter
```
public abstract S patternFilter(StringSE pattern)
```
    単純なパターンフィルターを構成します（例: "*.txt" ）。
    パラメーター:
    pattern - パターン。
    戻り値:
    スペック。
    関連事項:
    filter(FileListFilter)
  - regexFilter
```
public abstract S regexFilter(StringSE regex)
```
    正規表現パターンフィルターを構成します（例: '[0-9].*.txt'）。
    パラメーター:
    regex - 正規表現。
    戻り値:
    スペック。
    関連事項:
    filter(FileListFilter)
  - deleteRemoteFiles
```
public S deleteRemoteFiles(boolean deleteRemoteFiles)
```
    転送に成功した後、リモートファイルの削除を有効にするには、true に設定します。
    パラメーター:
    deleteRemoteFiles - 削除する場合は true。
    戻り値:
    スペック。
  - preserveTimestamp
```
public S preserveTimestamp(boolean preserveTimestamp)
```
    true に設定すると、転送時にリモートファイルのタイムスタンプの保存が有効になります。
    パラメーター:
    preserveTimestamp - 保存するために本当。
    戻り値:
    スペック。
  - maxFetchSize
```
public S maxFetchSize(int maxFetchSize)
```
    フェッチの試行ごとにフェッチされるリモートファイルの最大数を指定します。複数のアプリケーションインスタンスが実行されている場合は、1 つのインスタンスがすべてのファイルを「取得」しないように、少数をお勧めします。
    パラメーター:
    maxFetchSize - 最大フェッチサイズ。
    戻り値:
    スペック。
    関連事項:
    MessageSourceManagement.setMaxFetchSize(int)
  - remoteFileMetadataStore
```
public S remoteFileMetadataStore(MetadataStore remoteFileMetadataStore)
```
    リモートファイルのメタデータ用に MetadataStore を構成します。
    パラメーター:
    remoteFileMetadataStore - 使用する MetadataStore。
    戻り値:
    スペック。
    導入:
    5.2
    関連事項:
    AbstractInboundFileSynchronizer.setRemoteFileMetadataStore(MetadataStore)
  - metadataStorePrefix
```
public S metadataStorePrefix(StringSE metadataStorePrefix)
```
    リモートファイルのメタデータキーのプレフィックスを構成します。
    パラメーター:
    metadataStorePrefix - 使用するメタデータキープレフィックス。
    戻り値:
    スペック。
    導入:
    5.2
    関連事項:
    remoteFileMetadataStore(org.springframework.integration.metadata.MetadataStore)
  - scanner
```
public S scanner(DirectoryScanner scanner)
```
    転送後のファイルシステムスキャンに使用するスキャナーを構成します。
    パラメーター:
    scanner - スキャナー。
    戻り値:
    スペック。
    導入:
    5.2.4
  - remoteComparator
```
public S remoteComparator(ComparatorSE<F> remoteComparator)
```
    フィルターと最大フェッチサイズを適用する前に、F （リモートファイルを表す型）の取得リストをソートするコンパレーターを設定します。
    パラメーター:
    remoteComparator - リモートファイルの場合は ComparatorSE。
    戻り値:
    スペック。
    導入:
    5.2.9
  - getComponentsToRegister
```
public MapSE<ObjectSE,StringSE> getComponentsToRegister()
```
    次で指定:
    インターフェース ComponentsRegistration の getComponentsToRegister

クラス RemoteFileInboundChannelAdapterSpec<F,S extends RemoteFileInboundChannelAdapterSpec<F,S,MS>,MS extends AbstractInboundFileSynchronizingMessageSource<F>>

フィールドのサマリー

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.dsl.MessageSourceSpec から継承されたメソッド

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

synchronizer

コンストラクターの詳細

RemoteFileInboundChannelAdapterSpec

メソッドの詳細

autoCreateLocalDirectory

localDirectory

localFilter

remoteFileSeparator

localFilenameExpression

localFilename

localFilenameExpression

temporaryFileSuffix

remoteDirectory

remoteDirectoryExpression

filter

filterExpression

filterFunction

patternFilter

regexFilter

deleteRemoteFiles

preserveTimestamp

maxFetchSize

remoteFileMetadataStore

metadataStorePrefix

scanner

remoteComparator

getComponentsToRegister