クラス FileWritingMessageHandlerSpec
java.lang.ObjectSE
org.springframework.integration.dsl.IntegrationComponentSpec<FileWritingMessageHandlerSpec,FileWritingMessageHandler>
org.springframework.integration.dsl.MessageHandlerSpec<FileWritingMessageHandlerSpec,FileWritingMessageHandler>
org.springframework.integration.file.dsl.FileWritingMessageHandlerSpec
- 実装されたすべてのインターフェース:
DisposableBean
、FactoryBean<FileWritingMessageHandler>
、InitializingBean
、Lifecycle
、Phased
、SmartLifecycle
、ComponentsRegistration
public class FileWritingMessageHandlerSpec
extends MessageHandlerSpec<FileWritingMessageHandlerSpec,FileWritingMessageHandler>
implements ComponentsRegistration
- 導入:
- 5.0
- 作成者:
- Artem Bilan, Gary Russell
フィールドのサマリー
クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
logger, PARSER, target
インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTE
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターの概要
コンストラクター修飾子コンストラクター説明protected
FileWritingMessageHandlerSpec
(FileSE destinationDirectory) protected
FileWritingMessageHandlerSpec
(StringSE directoryExpression) protected
FileWritingMessageHandlerSpec
(FunctionSE<Message<P>, ?> directoryFunction) protected
FileWritingMessageHandlerSpec
(Expression directoryExpression) メソッドのサマリー
修飾子と型メソッド説明appendNewLine
(boolean appendNewLine) true
が各書き込みの後に改行を追加する場合。autoCreateDirectory
(boolean autoCreateDirectory) 初期化時に宛先ディレクトリが存在しない場合に、それを自動的に作成するかどうかを指定します。bufferSize
(int bufferSize) ファイルへの書き込み中に使用するバッファサイズを設定します。デフォルトは 8192 です。文字列ペイロードをファイルのコンテンツとしてバイトに変換するときに使用する文字セットを設定します。chmod
(int chmod) アップロード後にファイルのアクセス許可を設定します。deleteSourceFiles
(boolean deleteSourceFiles) 宛先ディレクトリへの書き込み後にソースファイルを削除するかどうかを指定します。fileExistsMode
(FileExistsMode fileExistsMode) 宛先が存在する場合にどうなるかを指定するFileExistsMode
を設定します。fileNameExpression
(StringSE fileNameExpression) 提供された SpEL 式に基づいてDefaultFileNameGenerator
を設定します。fileNameGenerator
(FileNameGenerator fileNameGenerator) ターゲットファイル名の生成に使用するファイル名ジェネレーターを設定します。flushInterval
(long flushInterval) FileExistsMode.APPEND_NO_FLUSH
が使用されているときにバッファをフラッシュする頻度を設定します。flushPredicate
(FileWritingMessageHandler.MessageFlushPredicate flushPredicate) FileExistsMode.APPEND_NO_FLUSH
が使用中の場合、フラッシュタスクにFileWritingMessageHandler.MessageFlushPredicate
を指定します。flushWhenIdle
(boolean flushWhenIdle) ファイルが最後に書き込まれたときではなく、ファイルが開かれたときに間隔を適用する場合は、アイドル時のフラッシュフラグを false に設定します。preserveTimestamp
(boolean preserveTimestamp) 宛先ファイルのタイムスタンプを保持するには、true に設定します。taskScheduler
(TaskScheduler taskScheduler) FileExistsMode.APPEND_NO_FLUSH
が使用中の場合、フラッシュタスクにTaskScheduler
を指定します。temporaryFileSuffix
(StringSE temporaryFileSuffix) デフォルトでは、転送中のすべてのファイルは、追加のサフィックス(デフォルトでは.writing
)とともにファイルシステムに表示されます。クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.beans.factory.FactoryBean から継承されたメソッド
isSingleton
コンストラクターの詳細
FileWritingMessageHandlerSpec
FileWritingMessageHandlerSpec
FileWritingMessageHandlerSpec
FileWritingMessageHandlerSpec
メソッドの詳細
autoCreateDirectory
初期化時に宛先ディレクトリが存在しない場合に、それを自動的に作成するかどうかを指定します。デフォルトでは、この値は true です。false に設定し、宛先ディレクトリが存在しない場合、初期化時に例外がスローされます。- パラメーター:
autoCreateDirectory
- 必要に応じてディレクトリを作成する場合は true。- 戻り値:
- 現在のスペック
temporaryFileSuffix
デフォルトでは、転送中のすべてのファイルは、追加のサフィックス(デフォルトでは.writing
)とともにファイルシステムに表示されます。- パラメーター:
temporaryFileSuffix
- 一時ファイルのサフィックス。- 戻り値:
- 現在のスペック
fileExistsMode
宛先が存在する場合にどうなるかを指定するFileExistsMode
を設定します。- パラメーター:
fileExistsMode
- 相談するFileExistsMode
- 戻り値:
- 現在のスペック
fileNameGenerator
ターゲットファイル名の生成に使用するファイル名ジェネレーターを設定します。デフォルトDefaultFileNameGenerator
。- パラメーター:
fileNameGenerator
- ファイル名ジェネレーター。- 戻り値:
- 現在のスペック
fileNameExpression
提供された SpEL 式に基づいてDefaultFileNameGenerator
を設定します。- パラメーター:
fileNameExpression
- ファイル名生成のための SpEL 式。- 戻り値:
- 現在のスペック
deleteSourceFiles
宛先ディレクトリへの書き込み後にソースファイルを削除するかどうかを指定します。デフォルトは false です。true に設定すると、受信メッセージにファイルペイロード、またはファイルインスタンスまたは元のファイルパスを表す文字列のいずれかを含むFileHeaders.ORIGINAL_FILE
ヘッダー値がある場合にのみ効果があります。- パラメーター:
deleteSourceFiles
- true の場合、ソースファイルを削除します。- 戻り値:
- 現在のスペック
charset
文字列ペイロードをファイルのコンテンツとしてバイトに変換するときに使用する文字セットを設定します。デフォルトのUTF-8
.- パラメーター:
charset
- 文字セット。- 戻り値:
- 現在のスペック
appendNewLine
true
が各書き込みの後に改行を追加する場合。デフォルトはfalse
です。- パラメーター:
appendNewLine
- ペイロードが書き込まれた後に新しい行をファイルに書き込む必要がある場合は true。- 戻り値:
- スペック。
- 関連事項:
bufferSize
ファイルへの書き込み中に使用するバッファサイズを設定します。デフォルトは 8192 です。- パラメーター:
bufferSize
- バッファサイズ。- 戻り値:
- スペック。
- 関連事項:
flushInterval
FileExistsMode.APPEND_NO_FLUSH
が使用されているときにバッファをフラッシュする頻度を設定します。- パラメーター:
flushInterval
- 間隔。- 戻り値:
- スペック。
- 関連事項:
flushWhenIdle
ファイルが最後に書き込まれたときではなく、ファイルが開かれたときに間隔を適用する場合は、アイドル時のフラッシュフラグを false に設定します。- パラメーター:
flushWhenIdle
- ファイルが開かれてからの間隔が経過した場合にフラッシュする場合は false。- 戻り値:
- スペック。
- 関連事項:
taskScheduler
FileExistsMode.APPEND_NO_FLUSH
が使用中の場合、フラッシュタスクにTaskScheduler
を指定します。- パラメーター:
taskScheduler
- 使用するTaskScheduler
。- 戻り値:
- スペック。
- 関連事項:
flushPredicate
public FileWritingMessageHandlerSpec flushPredicate(FileWritingMessageHandler.MessageFlushPredicate flushPredicate) FileExistsMode.APPEND_NO_FLUSH
が使用中の場合、フラッシュタスクにFileWritingMessageHandler.MessageFlushPredicate
を指定します。- パラメーター:
flushPredicate
- 使用するFileWritingMessageHandler.MessageFlushPredicate
。- 戻り値:
- スペック。
- 関連事項:
preserveTimestamp
宛先ファイルのタイムスタンプを保持するには、true に設定します。true で、ペイロードがFile
SE の場合、ペイロードのlastModified
時刻が宛先ファイルに転送されます。- パラメーター:
preserveTimestamp
- 使用するboolean
フラグ。- 戻り値:
- スペック。
- 関連事項:
chmod
アップロード後にファイルの権限を設定します。例: 所有者の読み取り / 書き込みの場合は 0600。posix ファイルのアクセス許可をサポートするファイルシステムにのみ適用されます。- パラメーター:
chmod
- 許可。- 戻り値:
- スペック。
- 例外:
IllegalArgumentExceptionSE
- 値が 0777 より大きい場合。- 関連事項:
getComponentsToRegister
- 次で指定:
- インターフェース
ComponentsRegistration
のgetComponentsToRegister