AbstractInboundFileSynchronizer (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer<F>

型パラメーター:
F - リモートファイルを表す Type。
実装されているすべてのインターフェース:
CloseableSE, AutoCloseableSE, Aware, BeanFactoryAware, BeanNameAware, InitializingBean, InboundFileSynchronizer
既知の直属サブクラス
FtpInboundFileSynchronizer, SftpInboundFileSynchronizer
```
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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected static ExpressionParser EXPRESSION_PARSER
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected static ExpressionParser`	`EXPRESSION_PARSER`
`protected Log`	`logger`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`AbstractInboundFileSynchronizer(SessionFactory<F> sessionFactory)` `Session` インスタンスの取得に使用される `SessionFactory` でシンクロナイザーを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`void`	`close()`
`protected boolean`	`copyFileToLocalDirectory(StringSE remoteDirectoryPath, F remoteFile, FileSE localDirectory, Session<F> session)`
`protected void`	`doInit()` サブクラスは、`InitializingBean.afterPropertiesSet()` から呼び出される初期化を実行するためにオーバーライドできます。
`protected void`	`doSetFilter(FileListFilter<F> filterToSet)`
`protected void`	`doSetRemoteDirectoryExpression(Expression expression)`
`protected void`	`evaluateRemoteDirectory()`
`protected ListSE<F>`	`filterFiles(F[] files)`
`protected ComparatorSE<F>`	`getComparator()`
`protected abstract StringSE`	`getFilename(F file)`
`protected abstract long`	`getModified(F file)`
`StringSE`	`getRemoteFileMetadata(FileSE localFile)` 指定されたローカルファイルに関連付けられたリモートファイルのメタデータを取得します。
`protected StringSE`	`getTemporaryFileSuffix()`
`protected abstract boolean`	`isFile(F file)`
`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<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 のファイルをローカルディレクトリに同期します。

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

- フィールドの詳細
  - EXPRESSION_PARSER
```
protected static final ExpressionParser EXPRESSION_PARSER
```
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractInboundFileSynchronizer
```
public AbstractInboundFileSynchronizer(SessionFactory<F> sessionFactory)
```
    Session インスタンスの取得に使用される SessionFactory でシンクロナイザーを作成します。
    パラメーター:
    sessionFactory - セッションファクトリ。
- メソッドの詳細
  - getComparator
```
@Nullable
protected ComparatorSE<F> getComparator()
```
  - setComparator
```
public void setComparator(@Nullable
                          ComparatorSE<F> comparator)
```
    フィルターと最大フェッチサイズを適用する前に、F （リモートファイルを表す型）の取得リストをソートするコンパレーターを設定します。
    パラメーター:
    comparator - コンパレータ。
    導入:
    5.1
  - setRemoteFileSeparator
```
public void setRemoteFileSeparator(StringSE remoteFileSeparator)
```
    パラメーター:
    remoteFileSeparator - リモートファイル区切り。
    関連事項:
    RemoteFileTemplate.setRemoteFileSeparator(String)
  - setLocalFilenameGeneratorExpression
```
public void setLocalFilenameGeneratorExpression(Expression localFilenameGeneratorExpression)
```
    ローカルファイル名を決定するために使用される式を設定します。
    パラメーター:
    localFilenameGeneratorExpression - 表現。
  - setLocalFilenameGeneratorExpressionString
```
public void setLocalFilenameGeneratorExpressionString(StringSE localFilenameGeneratorExpression)
```
    ローカルファイル名を決定するために使用される式を設定します。
    パラメーター:
    localFilenameGeneratorExpression - 表現。
    導入:
    4.3.13
    関連事項:
    setRemoteDirectoryExpression(Expression)
  - setTemporaryFileSuffix
```
public void setTemporaryFileSuffix(StringSE temporaryFileSuffix)
```
    ファイルの転送中に使用する一時ファイルのサフィックスを設定します。デフォルトは ".writing"。
    パラメーター:
    temporaryFileSuffix - ファイルのサフィックス。
  - setRemoteDirectory
```
public void setRemoteDirectory(StringSE remoteDirectory)
```
    リモートディレクトリへの絶対パスを指定します。
    パラメーター:
    remoteDirectory - リモートディレクトリ。
  - setRemoteDirectoryExpression
```
public void setRemoteDirectoryExpression(Expression remoteDirectoryExpression)
```
    リモートディレクトリへの絶対パスに評価される式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式。
    導入:
    4.2
  - setRemoteDirectoryExpressionString
```
public void setRemoteDirectoryExpressionString(StringSE remoteDirectoryExpression)
```
    リモートディレクトリへの絶対パスに評価される式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式。
    導入:
    4.3.13
    関連事項:
    setRemoteDirectoryExpression(Expression)
  - doSetRemoteDirectoryExpression
```
protected final void doSetRemoteDirectoryExpression(Expression expression)
```
  - setFilter
```
public void setFilter(@Nullable
                      FileListFilter<F> filter)
```
    転送する前に、リモートファイルに適用されるフィルターを設定します。
    パラメーター:
    filter - ファイルリストフィルター。
  - doSetFilter
```
protected final void doSetFilter(@Nullable
                                 FileListFilter<F> filterToSet)
```
  - setDeleteRemoteFiles
```
public void setDeleteRemoteFiles(boolean deleteRemoteFiles)
```
    転送に成功した後、リモートファイルの削除を有効にするには、true に設定します。
    パラメーター:
    deleteRemoteFiles - 削除する場合は true。
  - setPreserveTimestamp
```
public void setPreserveTimestamp(boolean preserveTimestamp)
```
    true に設定すると、転送時にリモートファイルのタイムスタンプの保存が有効になります。
    パラメーター:
    preserveTimestamp - 保存するために本当。
  - setRemoteFileMetadataStore
```
public void setRemoteFileMetadataStore(MetadataStore remoteFileMetadataStore)
```
    MetadataStore がリモートファイル情報（ホスト、ポート、リモートディレクトリ）を保持するように構成し、ローカルファイルがプルされたときにメッセージヘッダーでダウンストリームを転送します。
    パラメーター:
    remoteFileMetadataStore - 使用する MetadataStore。
    導入:
    5.2
  - setMetadataStorePrefix
```
public void setMetadataStorePrefix(StringSE metadataStorePrefix)
```
    共有ストア内の他のキーと衝突しないメタデータストア内のキーのプレフィックスを指定します。
    パラメーター:
    metadataStorePrefix - 使用する接頭辞。
    導入:
    5.2
    関連事項:
    setRemoteFileMetadataStore(MetadataStore)
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException
```
    次で指定:
    インターフェース BeanFactoryAware の setBeanFactory
    例外:
    BeansException
  - setBeanName
```
public void setBeanName(StringSE name)
```
    次で指定:
    インターフェース BeanNameAware の setBeanName
  - afterPropertiesSet
```
public final void afterPropertiesSet()
```
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
  - doInit
```
protected void doInit()
```
    サブクラスは、InitializingBean.afterPropertiesSet() から呼び出される初期化を実行するためにオーバーライドできます。
  - filterFiles
```
protected final ListSE<F> filterFiles(F[] files)
```
  - getTemporaryFileSuffix
```
protected StringSE getTemporaryFileSuffix()
```
  - close
```
public void close()
           throws IOExceptionSE
```
    次で指定:
    インターフェース CloseableSE の closeSE
    次で指定:
    インターフェース AutoCloseableSE の closeSE
    例外:
    IOExceptionSE
  - synchronizeToLocalDirectory
```
public void synchronizeToLocalDirectory(FileSE localDirectory)
```
    インターフェースからコピーされた説明: InboundFileSynchronizer
    利用可能なすべてのファイルをローカルディレクトリに同期します。
    次で指定:
    インターフェース InboundFileSynchronizer の synchronizeToLocalDirectory
    パラメーター:
    localDirectory - ディレクトリ。
  - synchronizeToLocalDirectory
```
public void synchronizeToLocalDirectory(FileSE localDirectory,
                                        int maxFetchSize)
```
    インターフェースからコピーされた説明: InboundFileSynchronizer
    最大 maxFetchSize のファイルをローカルディレクトリに同期します。
    次で指定:
    インターフェース InboundFileSynchronizer の synchronizeToLocalDirectory
    パラメーター:
    localDirectory - ディレクトリ。
    maxFetchSize - 取得するファイルの最大数
  - rollbackFromFileToListEnd
```
protected void rollbackFromFileToListEnd(ListSE<F> filteredFiles,
                                         F file)
```
  - copyFileToLocalDirectory
```
protected boolean copyFileToLocalDirectory(StringSE remoteDirectoryPath,
                                           F remoteFile,
                                           FileSE localDirectory,
                                           Session<F> session)
                                    throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - evaluateRemoteDirectory
```
protected void evaluateRemoteDirectory()
```
  - getRemoteFileMetadata
```
@Nullable
public StringSE getRemoteFileMetadata(FileSE localFile)
```
    指定されたローカルファイルに関連付けられたリモートファイルのメタデータを取得します。
    パラメーター:
    localFile - メタデータを取得するローカルファイル。
    戻り値:
    URI スタイルの削除ファイルのメタデータ: protocol://host:port/remoteDirectory#remoteFileName
    導入:
    5.2
  - removeRemoteFileMetadata
```
public void removeRemoteFileMetadata(FileSE localFile)
```
    指定されたローカルファイルに関連付けられているリモートファイルのメタデータを削除します。
    パラメーター:
    localFile - メタデータを削除するローカルファイル。
    導入:
    5.2
  - isFile
```
protected abstract boolean isFile(F file)
```
  - getFilename
```
protected abstract StringSE getFilename(F file)
```
  - getModified
```
protected abstract long getModified(F file)
```
  - protocol
```
protected abstract StringSE protocol()
```
    このシンクロナイザーが動作するプロトコルを返します。
    戻り値:
    このシンクロナイザが使用するプロトコル。
    導入:
    5.2

クラス AbstractInboundFileSynchronizer<F>

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

フィールドの詳細

EXPRESSION_PARSER

logger

コンストラクターの詳細

AbstractInboundFileSynchronizer

メソッドの詳細

getComparator

setComparator

setRemoteFileSeparator

setLocalFilenameGeneratorExpression

setLocalFilenameGeneratorExpressionString

setTemporaryFileSuffix

setRemoteDirectory

setRemoteDirectoryExpression

setRemoteDirectoryExpressionString

doSetRemoteDirectoryExpression

setFilter

doSetFilter

setDeleteRemoteFiles

setPreserveTimestamp

setRemoteFileMetadataStore

setMetadataStorePrefix

setBeanFactory

setBeanName

afterPropertiesSet

doInit

filterFiles

getTemporaryFileSuffix

close

synchronizeToLocalDirectory

synchronizeToLocalDirectory

rollbackFromFileToListEnd

copyFileToLocalDirectory

evaluateRemoteDirectory

getRemoteFileMetadata

removeRemoteFileMetadata

isFile

getFilename

getModified

protocol