クラス AbstractInboundFileSynchronizer<F>
java.lang.ObjectSE
org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer<F>
- 型パラメーター:
F
- リモートファイルを表す Type。
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、Aware
、BeanFactoryAware
、BeanNameAware
、InitializingBean
、InboundFileSynchronizer
public abstract class AbstractInboundFileSynchronizer<F>
extends ObjectSE
implements InboundFileSynchronizer, BeanFactoryAware, BeanNameAware, InitializingBean, CloseableSE
リモートファイルシステムへの接続方法、新しいファイルのスキャン方法、ファイルのダウンロード方法を知ることを担当する基本クラス。
実装は、構成された FileListFilter
を実行して、ファイルエントリが受け入れられることを確認する必要があります。
- 導入:
- 2.0
- 作成者:
- Josh Long, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Ngoc Nhan
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターコンストラクター説明AbstractInboundFileSynchronizer
(SessionFactory<F> sessionFactory) Session
インスタンスの取得に使用されるSessionFactory
でシンクロナイザーを作成します。メソッドのサマリー
修飾子と型メソッド説明final void
void
close()
protected boolean
copyFileToLocalDirectory
(StringSE remoteDirectoryPath, EvaluationContext localFileEvaluationContext, F remoteFile, FileSE localDirectory, Session<F> session) protected void
doInit()
サブクラスは、InitializingBean.afterPropertiesSet()
から呼び出される初期化を実行するためにオーバーライドできます。protected final void
doSetFilter
(FileListFilter<F> filterToSet) protected final void
doSetRemoteDirectoryExpression
(Expression expression) filterFiles
(F[] files) protected ComparatorSE
<? extends F> protected abstract StringSE
getFilename
(F file) protected abstract long
getModified
(F file) getRemoteFileMetadata
(FileSE localFile) 指定されたローカルファイルに関連付けられたリモートファイルのメタデータを取得します。protected StringSE
protected abstract boolean
protected abstract StringSE
protocol()
このシンクロナイザーが動作するプロトコルを返します。void
removeRemoteFileMetadata
(FileSE localFile) 指定されたローカルファイルに関連付けられているリモートファイルのメタデータを削除します。protected void
rollbackFromFileToListEnd
(ListSE<F> filteredFiles, F file) void
setBeanFactory
(BeanFactory beanFactory) void
setBeanName
(StringSE name) void
setComparator
(ComparatorSE<? extends F> comparator) フィルターと最大フェッチサイズを適用する前に、F
(リモートファイルを表す型)の取得リストをソートするコンパレーターを設定します。void
setDeleteRemoteFiles
(boolean deleteRemoteFiles) 転送に成功した後、リモートファイルの削除を有効にするには、true に設定します。void
setFilter
(FileListFilter<F> filter) 転送する前に、リモートファイルに適用されるフィルターを設定します。void
setLocalFilenameGeneratorExpression
(Expression localFilenameGeneratorExpression) ローカルファイル名を決定するために使用される式を設定します。void
setLocalFilenameGeneratorExpressionString
(StringSE localFilenameGeneratorExpression) ローカルファイル名を決定するために使用される式を設定します。void
setMetadataStorePrefix
(StringSE metadataStorePrefix) 共有ストア内の他のキーと衝突しないメタデータストア内のキーのプレフィックスを指定します。void
setPreserveTimestamp
(boolean preserveTimestamp) true に設定すると、転送時にリモートファイルのタイムスタンプの保存が有効になります。void
setRemoteDirectory
(StringSE remoteDirectory) リモートディレクトリへの絶対パスを指定します。void
setRemoteDirectoryExpression
(Expression remoteDirectoryExpression) リモートディレクトリへの絶対パスに評価される式を指定します。void
setRemoteDirectoryExpressionString
(StringSE remoteDirectoryExpression) リモートディレクトリへの絶対パスに評価される式を指定します。void
setRemoteFileMetadataStore
(MetadataStore remoteFileMetadataStore) MetadataStore
がリモートファイル情報(ホスト、ポート、リモートディレクトリ)を保持するように構成し、ローカルファイルがプルされたときにメッセージヘッダーでダウンストリームを転送します。void
setRemoteFileSeparator
(StringSE remoteFileSeparator) void
setTemporaryFileSuffix
(StringSE temporaryFileSuffix) ファイルの転送中に使用される一時ファイルのサフィックスを設定します。void
synchronizeToLocalDirectory
(FileSE localDirectory) 使用可能なすべてのファイルをローカルディレクトリに同期します。void
synchronizeToLocalDirectory
(FileSE localDirectory, int maxFetchSize) 最大 maxFetchSize のファイルをローカルディレクトリに同期します。
フィールドの詳細
EXPRESSION_PARSER
logger
コンストラクターの詳細
AbstractInboundFileSynchronizer
Session
インスタンスの取得に使用されるSessionFactory
でシンクロナイザーを作成します。- パラメーター:
sessionFactory
- セッションファクトリ。
メソッドの詳細
getComparator
setComparator
フィルターと最大フェッチサイズを適用する前に、F
(リモートファイルを表す型)の取得リストをソートするコンパレーターを設定します。- パラメーター:
comparator
- コンパレータ。- 導入:
- 5.1
setRemoteFileSeparator
- パラメーター:
remoteFileSeparator
- リモートファイル区切り。- 関連事項:
setLocalFilenameGeneratorExpression
ローカルファイル名を決定するために使用される式を設定します。- パラメーター:
localFilenameGeneratorExpression
- 表現。
setLocalFilenameGeneratorExpressionString
ローカルファイル名を決定するために使用される式を設定します。- パラメーター:
localFilenameGeneratorExpression
- 表現。- 導入:
- 4.3.13
- 関連事項:
setTemporaryFileSuffix
ファイルの転送中に使用する一時ファイルのサフィックスを設定します。デフォルトは ".writing"。- パラメーター:
temporaryFileSuffix
- ファイルのサフィックス。
setRemoteDirectory
リモートディレクトリへの絶対パスを指定します。- パラメーター:
remoteDirectory
- リモートディレクトリ。
setRemoteDirectoryExpression
リモートディレクトリへの絶対パスに評価される式を指定します。- パラメーター:
remoteDirectoryExpression
- リモートディレクトリ式。- 導入:
- 4.2
setRemoteDirectoryExpressionString
リモートディレクトリへの絶対パスに評価される式を指定します。- パラメーター:
remoteDirectoryExpression
- リモートディレクトリ式。- 導入:
- 4.3.13
- 関連事項:
doSetRemoteDirectoryExpression
setFilter
転送する前に、リモートファイルに適用されるフィルターを設定します。- パラメーター:
filter
- ファイルリストフィルター。
doSetFilter
setDeleteRemoteFiles
public void setDeleteRemoteFiles(boolean deleteRemoteFiles) 転送に成功した後、リモートファイルの削除を有効にするには、true に設定します。- パラメーター:
deleteRemoteFiles
- 削除する場合は true。
setPreserveTimestamp
public void setPreserveTimestamp(boolean preserveTimestamp) true に設定すると、転送時にリモートファイルのタイムスタンプの保存が有効になります。- パラメーター:
preserveTimestamp
- 保存するために本当。
setRemoteFileMetadataStore
MetadataStore
がリモートファイル情報(ホスト、ポート、リモートディレクトリ)を保持するように構成し、ローカルファイルがプルされたときにメッセージヘッダーでダウンストリームを転送します。- パラメーター:
remoteFileMetadataStore
- 使用するMetadataStore
。- 導入:
- 5.2
setMetadataStorePrefix
共有ストア内の他のキーと衝突しないメタデータストア内のキーのプレフィックスを指定します。- パラメーター:
metadataStorePrefix
- 使用する接頭辞。- 導入:
- 5.2
- 関連事項:
setBeanFactory
- 次で指定:
- インターフェース
BeanFactoryAware
のsetBeanFactory
- 例外:
BeansException
setBeanName
- 次で指定:
- インターフェース
BeanNameAware
のsetBeanName
afterPropertiesSet
public final void afterPropertiesSet()- 次で指定:
- インターフェース
InitializingBean
のafterPropertiesSet
doInit
protected void doInit()サブクラスは、InitializingBean.afterPropertiesSet()
から呼び出される初期化を実行するためにオーバーライドできます。filterFiles
getTemporaryFileSuffix
close
- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 例外:
IOExceptionSE
synchronizeToLocalDirectory
インターフェースからコピーされた説明:InboundFileSynchronizer
使用可能なすべてのファイルをローカルディレクトリに同期します。- 次で指定:
- インターフェース
InboundFileSynchronizer
のsynchronizeToLocalDirectory
- パラメーター:
localDirectory
- ディレクトリ。
synchronizeToLocalDirectory
インターフェースからコピーされた説明:InboundFileSynchronizer
最大 maxFetchSize のファイルをローカルディレクトリに同期します。- 次で指定:
- インターフェース
InboundFileSynchronizer
のsynchronizeToLocalDirectory
- パラメーター:
localDirectory
- ディレクトリ。maxFetchSize
- 取得するファイルの最大数
rollbackFromFileToListEnd
copyFileToLocalDirectory
protected boolean copyFileToLocalDirectory(@Nullable StringSE remoteDirectoryPath, @Nullable EvaluationContext localFileEvaluationContext, F remoteFile, FileSE localDirectory, Session<F> session) throws IOExceptionSE getRemoteFileMetadata
removeRemoteFileMetadata
指定されたローカルファイルに関連付けられているリモートファイルのメタデータを削除します。- パラメーター:
localFile
- メタデータを削除するローカルファイル。- 導入:
- 5.2
isFile
getFilename
getModified
protocol