public class FileWritingMessageHandlerSpec extends org.springframework.integration.dsl.MessageHandlerSpec<FileWritingMessageHandlerSpec,FileWritingMessageHandler> implements org.springframework.integration.dsl.ComponentsRegistration
MessageHandlerSpec for the FileWritingMessageHandler.| Modifier and Type | Method and Description |
|---|---|
FileWritingMessageHandlerSpec |
appendNewLine(boolean appendNewLine)
If
true will append a new-line after each write. |
FileWritingMessageHandlerSpec |
autoCreateDirectory(boolean autoCreateDirectory)
Specify whether to create the destination directory automatically if it
does not yet exist upon initialization.
|
FileWritingMessageHandlerSpec |
bufferSize(int bufferSize)
Set the buffer size to use while writing to files; default 8192.
|
FileWritingMessageHandlerSpec |
charset(java.lang.String charset)
Set the charset to use when converting String payloads to bytes as the content of the file.
|
FileWritingMessageHandlerSpec |
deleteSourceFiles(boolean deleteSourceFiles)
Specify whether to delete source Files after writing to the destination
directory.
|
FileWritingMessageHandlerSpec |
fileExistsMode(FileExistsMode fileExistsMode)
Set the
FileExistsMode that specifies what will happen in
case the destination exists. |
FileWritingMessageHandlerSpec |
fileNameExpression(java.lang.String fileNameExpression)
Set the
DefaultFileNameGenerator based on the provided SpEL expression. |
FileWritingMessageHandlerSpec |
fileNameGenerator(FileNameGenerator fileNameGenerator)
Set the file name generator used to generate the target file name.
|
FileWritingMessageHandlerSpec |
flushInterval(long flushInterval)
Set the frequency to flush buffers when
FileExistsMode.APPEND_NO_FLUSH is
being used. |
FileWritingMessageHandlerSpec |
flushPredicate(FileWritingMessageHandler.MessageFlushPredicate flushPredicate)
Specify a
FileWritingMessageHandler.MessageFlushPredicate for flush task
when the FileExistsMode.APPEND_NO_FLUSH is in use. |
java.util.Collection<java.lang.Object> |
getComponentsToRegister() |
FileWritingMessageHandlerSpec |
preserveTimestamp(boolean preserveTimestamp)
Set to true to preserve the destination file timestamp.
|
FileWritingMessageHandlerSpec |
taskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)
Specify a
TaskScheduler for flush task when the FileExistsMode.APPEND_NO_FLUSH is in use. |
FileWritingMessageHandlerSpec |
temporaryFileSuffix(java.lang.String temporaryFileSuffix)
By default, every file that is in the process of being transferred will
appear in the file system with an additional suffix, which by default is
.writing. |
public FileWritingMessageHandlerSpec autoCreateDirectory(boolean autoCreateDirectory)
autoCreateDirectory - true to create the directory if needed.public FileWritingMessageHandlerSpec temporaryFileSuffix(java.lang.String temporaryFileSuffix)
.writing.temporaryFileSuffix - The temporary file suffix.public FileWritingMessageHandlerSpec fileExistsMode(FileExistsMode fileExistsMode)
FileExistsMode that specifies what will happen in
case the destination exists.fileExistsMode - the FileExistsMode to consult.public FileWritingMessageHandlerSpec fileNameGenerator(FileNameGenerator fileNameGenerator)
DefaultFileNameGenerator.fileNameGenerator - the file name generator.public FileWritingMessageHandlerSpec fileNameExpression(java.lang.String fileNameExpression)
DefaultFileNameGenerator based on the provided SpEL expression.fileNameExpression - the SpEL expression for file names generation.public FileWritingMessageHandlerSpec deleteSourceFiles(boolean deleteSourceFiles)
FileHeaders.ORIGINAL_FILE header value containing either a
File instance or a String representing the original file path.deleteSourceFiles - true to delete the source files.public FileWritingMessageHandlerSpec charset(java.lang.String charset)
UTF-8.charset - the charset.public FileWritingMessageHandlerSpec appendNewLine(boolean appendNewLine)
true will append a new-line after each write.
Defaults to false.appendNewLine - true if a new-line should be written to the file after payload is written.FileWritingMessageHandler.setAppendNewLine(boolean)public FileWritingMessageHandlerSpec bufferSize(int bufferSize)
bufferSize - the buffer size.FileWritingMessageHandler.setBufferSize(int)public FileWritingMessageHandlerSpec flushInterval(long flushInterval)
FileExistsMode.APPEND_NO_FLUSH is
being used.flushInterval - the interval.FileWritingMessageHandler.setBufferSize(int)public FileWritingMessageHandlerSpec taskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)
TaskScheduler for flush task when the FileExistsMode.APPEND_NO_FLUSH is in use.taskScheduler - the TaskScheduler to use.FileWritingMessageHandler.setTaskScheduler(TaskScheduler)public FileWritingMessageHandlerSpec flushPredicate(FileWritingMessageHandler.MessageFlushPredicate flushPredicate)
FileWritingMessageHandler.MessageFlushPredicate for flush task
when the FileExistsMode.APPEND_NO_FLUSH is in use.flushPredicate - the FileWritingMessageHandler.MessageFlushPredicate to use.FileWritingMessageHandler.setFlushPredicate(FileWritingMessageHandler.MessageFlushPredicate)public FileWritingMessageHandlerSpec preserveTimestamp(boolean preserveTimestamp)
File, the payload's lastModified time will be
transferred to the destination file.preserveTimestamp - the boolean flag to use.FileWritingMessageHandler.setPreserveTimestamp(boolean)public java.util.Collection<java.lang.Object> getComponentsToRegister()
getComponentsToRegister in interface org.springframework.integration.dsl.ComponentsRegistration