AbstractInboundFileSynchronizingMessageSource (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.util.AbstractExpressionEvaluator
- - org.springframework.integration.endpoint.AbstractMessageSource<T>
  - - org.springframework.integration.endpoint.AbstractFetchLimitingMessageSource<FileSE>
    - - org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource<F>

実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, Lifecycle, MessageSource<FileSE>, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, MessageSourceManagement
既知の直属サブクラス
FtpInboundFileSynchronizingMessageSource, SftpInboundFileSynchronizingMessageSource
```
public abstract class AbstractInboundFileSynchronizingMessageSource<F>
extends AbstractFetchLimitingMessageSource<FileSE>
implements ManageableLifecycle
```
FTP アダプターと SFTP アダプター間の共通ロジックを分解します。リモートファイルシステムをローカルファイルシステムと同期するタスクのアダプターを処理するように拡張できるように設計されています（注: これは、ローカルファイルシステムに一意に存在するリモートファイルシステムへのプッシュファイルを処理しません。リモートファイルシステムからのプル -「受信」アダプターから予想されるとおり）。
基本クラスは、リモートファイルシステムとローカルファイルシステムのディレクトリを起動時に作成するかどうかの構成をサポートします（特定のアダプターに対して「ディレクトリを作成する」とは、当然実装固有です）。
このクラスは、AbstractInboundFileSynchronizer の実装とペアで使用されます。シンクロナイザは、リモートファイルシステムに実際に接続し、新しい FileSE を配信する作業を処理する必要があります。
作成者:
Josh Long, Oleg Zhurakousky, Gary Russell, Artem Bilan, Venil Noronha

ネストされたクラスの要約
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.util.AbstractExpressionEvaluator から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要

コンストラクター
コンストラクターと説明
`AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer)`
`AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer, ComparatorSE<FileSE> comparator)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`AbstractIntegrationMessageBuilder<FileSE>`	`doReceive(int maxFetchSize)` ファイルソースからポーリングします。
`AbstractInboundFileSynchronizer<F>`	`getSynchronizer()` 基になるシンクロナイザを返します。
`boolean`	`isRunning()`
`protected void`	`onInit()`
`void`	`setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)`
`void`	`setLocalDirectory(FileSE localDirectory)`
`void`	`setLocalFilter(FileListFilter<FileSE> localFileListFilter)` 同期後にメッセージを生成するファイルを決定するために使用される `FileListFilter`。
`void`	`setScanner(DirectoryScanner scanner)` ローカル `FileReadingMessageSource` を切り替えて、カスタム `DirectoryScanner` を使用します。
`void`	`setUseWatchService(boolean useWatchService)` ローカル `FileReadingMessageSource` を内部 `FileReadingMessageSource.WatchServiceDirectoryScanner` を使用するように切り替えます。
`void`	`start()`
`void`	`stop()`

クラス org.springframework.integration.endpoint.AbstractFetchLimitingMessageSource から継承されたメソッド
doReceive, getMaxFetchSize, setMaxFetchSize

クラス org.springframework.integration.endpoint.AbstractMessageSource から継承されたメソッド
buildMessage, destroy, getBeanName, getComponentName, getManagedName, getManagedType, getOverrides, isLoggingEnabled, receive, registerMetricsCaptor, setBeanName, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

クラス org.springframework.integration.util.AbstractExpressionEvaluator から継承されたメソッド
afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, setBeanFactory, setConversionService

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

インターフェース org.springframework.integration.core.MessageSource から継承されたメソッド
getIntegrationPatternType

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getComponentType

- コンストラクターの詳細
  - AbstractInboundFileSynchronizingMessageSource
```
public AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer)
```
  - AbstractInboundFileSynchronizingMessageSource
```
public AbstractInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<F> synchronizer,
                                                     ComparatorSE<FileSE> comparator)
```
- メソッドの詳細
  - setAutoCreateLocalDirectory
```
public void setAutoCreateLocalDirectory(boolean autoCreateLocalDirectory)
```
  - setLocalDirectory
```
public void setLocalDirectory(FileSE localDirectory)
```
  - setLocalFilter
```
public void setLocalFilter(FileListFilter<FileSE> localFileListFilter)
```
    同期後にメッセージを生成するファイルを決定するために使用される FileListFilter。これは、同期処理中のファイル（AbstractInboundFileSynchronizer.getTemporaryFileSuffix() を持つファイル）へのアクセスを防止するフィルターと組み合わされます。
    デフォルトは、FileSystemPersistentAcceptOnceFileListFilter で、重複したファイル名（現在の実行中に処理される）をフィルタリングします。
    パラメーター:
    localFileListFilter - ローカルファイルリストフィルター。
  - setUseWatchService
```
public void setUseWatchService(boolean useWatchService)
```
    ローカル FileReadingMessageSource を内部 FileReadingMessageSource.WatchServiceDirectoryScanner を使用するように切り替えます。
    パラメーター:
    useWatchService - true で FileReadingMessageSource.WatchServiceDirectoryScanner に切り替える boolean フラグ。
    導入:
    5.0
  - setScanner
```
public void setScanner(DirectoryScanner scanner)
```
    ローカル FileReadingMessageSource を切り替えて、カスタム DirectoryScanner を使用します。
    パラメーター:
    scanner - 使用する DirectoryScanner。
    導入:
    5.0
  - getSynchronizer
```
public AbstractInboundFileSynchronizer<F> getSynchronizer()
```
    基になるシンクロナイザを返します。
    戻り値:
    シンクロナイザー。
    導入:
    5.0.7
  - onInit
```
protected void onInit()
```
    オーバーライド:
    クラス AbstractExpressionEvaluator の onInit
  - start
```
public void start()
```
    次で指定:
    インターフェース Lifecycle の start
    次で指定:
    インターフェース ManageableLifecycle の start
  - stop
```
public void stop()
```
    次で指定:
    インターフェース Lifecycle の stop
    次で指定:
    インターフェース ManageableLifecycle の stop
  - isRunning
```
public boolean isRunning()
```
    次で指定:
    インターフェース Lifecycle の isRunning
    次で指定:
    インターフェース ManageableLifecycle の isRunning
  - doReceive
```
public final AbstractIntegrationMessageBuilder<FileSE> doReceive(int maxFetchSize)
```
    ファイルソースからポーリングします。結果が null でない場合は、それが返されます。結果が null の場合は、リモートディレクトリと同期してファイルソースにデータを取り込みます。最大で、maxFetchSize ファイルが取得されます。次に、ファイルソースを再度ポーリングし、null かどうかに関係なく結果を返します。
    次で指定:
    クラス AbstractFetchLimitingMessageSource<FileSE> の doReceive
    パラメーター:
    maxFetchSize - 取得するファイルの最大数
    戻り値:
    返された値。

クラス AbstractInboundFileSynchronizingMessageSource<F>

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

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

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

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

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

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

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

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

インターフェース org.springframework.integration.core.MessageSource から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

AbstractInboundFileSynchronizingMessageSource

AbstractInboundFileSynchronizingMessageSource

メソッドの詳細

setAutoCreateLocalDirectory

setLocalDirectory

setLocalFilter

setUseWatchService

setScanner

getSynchronizer

onInit

start

stop

isRunning

doReceive