AbstractRemoteFileStreamingMessageSource (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.util.AbstractExpressionEvaluator
- - org.springframework.integration.endpoint.AbstractMessageSource<T>
  - - org.springframework.integration.endpoint.AbstractFetchLimitingMessageSource<InputStreamSE>
    - - org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource<F>

実装されたすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, Lifecycle, MessageSource<InputStreamSE>, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, MessageSourceManagement
既知の直属サブクラス
FtpStreamingMessageSource, SftpStreamingMessageSource
```
public abstract class AbstractRemoteFileStreamingMessageSource<F>
extends AbstractFetchLimitingMessageSource<InputStreamSE>
implements ManageableLifecycle
```
リモートファイルを参照する InputStreamSE ペイロードを含むメッセージを生成するメッセージソース。
導入:
4.3
作成者:
Gary Russell, Artem Bilan, Lukas Gemela

ネストされたクラスのサマリー
- インターフェース 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

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> template, ComparatorSE<F> comparator)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> template, ComparatorSE<F> comparator)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected abstract ListSE<AbstractFileInfo<F>>`	`asFileInfoList(CollectionSE<F> files)`
`protected void`	`doInit()` サブクラスは、`InitializingBean.afterPropertiesSet()` から呼び出される初期化を実行するためにオーバーライドできます。
`protected ObjectSE`	`doReceive(int maxFetchSize)` サブクラスはこのメソッドを実装する必要があります。
`protected void`	`doSetFilter(FileListFilter<F> filterToSet)`
`protected RemoteFileTemplate<F>`	`getRemoteFileTemplate()`
`protected abstract boolean`	`isDirectory(F file)`
`boolean`	`isRunning()`
`void`	`onInit()`
`protected AbstractFileInfo<F>`	`poll()`
`protected StringSE`	`remotePath(AbstractFileInfo<F> file)`
`protected void`	`rollbackFromFileToListEnd(ListSE<F> filteredFiles, F file)`
`void`	`setFileInfoJson(boolean fileInfoJson)` `FileHeaders.REMOTE_FILE_INFO` ヘッダーを未加工の `FileInfo` に追加するには、false に設定します。
`void`	`setFilter(FileListFilter<F> filter)` 転送する前に、リモートファイルに適用されるフィルターを設定します。
`void`	`setRemoteDirectory(StringSE remoteDirectory)` リモートディレクトリへの絶対パスを指定します。
`void`	`setRemoteDirectoryExpression(Expression remoteDirectoryExpression)` リモートディレクトリへの絶対パスに評価される式を指定します。
`void`	`setRemoteFileSeparator(StringSE remoteFileSeparator)` リモートファイル区切りを設定します。デフォルト '/'
`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

- コンストラクターの詳細
  - AbstractRemoteFileStreamingMessageSource
```
protected AbstractRemoteFileStreamingMessageSource(RemoteFileTemplate<F> template,
                                                   @Nullable
                                                   ComparatorSE<F> comparator)
```
- メソッドの詳細
  - setRemoteDirectory
```
public void setRemoteDirectory(StringSE remoteDirectory)
```
    リモートディレクトリへの絶対パスを指定します。
    パラメーター:
    remoteDirectory - リモートディレクトリ。
  - setRemoteDirectoryExpression
```
public void setRemoteDirectoryExpression(Expression remoteDirectoryExpression)
```
    リモートディレクトリへの絶対パスに評価される式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式。
  - setRemoteFileSeparator
```
public void setRemoteFileSeparator(StringSE remoteFileSeparator)
```
    リモートファイル区切りを設定します。デフォルト '/'
    パラメーター:
    remoteFileSeparator - リモートファイル区切り。
  - setFilter
```
public void setFilter(FileListFilter<F> filter)
```
    転送する前に、リモートファイルに適用されるフィルターを設定します。
    パラメーター:
    filter - ファイルリストフィルター。
  - doSetFilter
```
protected final void doSetFilter(FileListFilter<F> filterToSet)
```
  - setFileInfoJson
```
public void setFileInfoJson(boolean fileInfoJson)
```
    FileHeaders.REMOTE_FILE_INFO ヘッダーを未加工の FileInfo に追加するには、false に設定します。デフォルトは true です。これは、共通のファイル情報プロパティが JSON としてそのヘッダーで提供されることを意味します。
    パラメーター:
    fileInfoJson - 生オブジェクトを設定する場合は false。
    導入:
    5.0
  - getRemoteFileTemplate
```
protected RemoteFileTemplate<F> getRemoteFileTemplate()
```
  - onInit
```
public final void onInit()
```
    オーバーライド:
    クラス AbstractExpressionEvaluator の onInit
  - doInit
```
protected void doInit()
```
    サブクラスは、InitializingBean.afterPropertiesSet() から呼び出される初期化を実行するためにオーバーライドできます。
  - 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
```
protected ObjectSE doReceive(int maxFetchSize)
```
    クラスからコピーされた説明: AbstractFetchLimitingMessageSource
    サブクラスはこのメソッドを実装する必要があります。通常、戻り値は型 T のペイロードですが、戻り値はペイロードが型 T のメッセージインスタンスでもかまいません。
    次で指定:
    クラス AbstractFetchLimitingMessageSource<InputStreamSE> の doReceive
    パラメーター:
    maxFetchSize - フェッチが必要な場合にフェッチするメッセージの最大数。
    戻り値:
    返された値。
  - poll
```
protected AbstractFileInfo<F> poll()
```
  - remotePath
```
protected StringSE remotePath(AbstractFileInfo<F> file)
```
  - rollbackFromFileToListEnd
```
protected void rollbackFromFileToListEnd(ListSE<F> filteredFiles,
                                         F file)
```
  - asFileInfoList
```
protected abstract ListSE<AbstractFileInfo<F>> asFileInfoList(CollectionSE<F> files)
```
  - isDirectory
```
protected abstract boolean isDirectory(F file)
```

クラス AbstractRemoteFileStreamingMessageSource<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 から継承されたメソッド

コンストラクターの詳細

AbstractRemoteFileStreamingMessageSource

メソッドの詳細

setRemoteDirectory

setRemoteDirectoryExpression

setRemoteFileSeparator

setFilter

doSetFilter

setFileInfoJson

getRemoteFileTemplate

onInit

doInit

start

stop

isRunning

doReceive

poll

remotePath

rollbackFromFileToListEnd

asFileInfoList

isDirectory