org.springframework.integration.dsl.file

Class FileWritingMessageHandlerSpec

java.lang.Object

org.springframework.integration.dsl.core.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.core.MessageHandlerSpec<FileWritingMessageHandlerSpec,org.springframework.integration.file.FileWritingMessageHandler>

org.springframework.integration.dsl.file.FileWritingMessageHandlerSpec

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<org.springframework.integration.file.FileWritingMessageHandler>, ComponentsRegistration

public class FileWritingMessageHandlerSpec
extends MessageHandlerSpec<FileWritingMessageHandlerSpec,org.springframework.integration.file.FileWritingMessageHandler>
implements ComponentsRegistration

Author:

Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
FileWritingMessageHandlerSpec	appendNewLine(boolean appendNewLine)
FileWritingMessageHandlerSpec	autoCreateDirectory(boolean autoCreateDirectory)
FileWritingMessageHandlerSpec	bufferSize(int bufferSize) Set the buffer size to use while writing to files; default 8192.
FileWritingMessageHandlerSpec	charset(java.lang.String charset)
FileWritingMessageHandlerSpec	deleteSourceFiles(boolean deleteSourceFiles)
FileWritingMessageHandlerSpec	fileExistsMode(org.springframework.integration.file.support.FileExistsMode fileExistsMode)
FileWritingMessageHandlerSpec	fileNameExpression(java.lang.String fileNameExpression)
FileWritingMessageHandlerSpec	fileNameGenerator(org.springframework.integration.file.FileNameGenerator fileNameGenerator)
FileWritingMessageHandlerSpec	flushInterval(long flushInterval) Set the frequency to flush buffers when FileExistsMode.APPEND_NO_FLUSH is being used.
FileWritingMessageHandlerSpec	flushPredicate(org.springframework.integration.file.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)

Methods inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

_this, doGet, get, getId, getObject, getObjectType, id, isSingleton

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

autoCreateDirectory

public FileWritingMessageHandlerSpec autoCreateDirectory(boolean autoCreateDirectory)

temporaryFileSuffix

public FileWritingMessageHandlerSpec temporaryFileSuffix(java.lang.String temporaryFileSuffix)

fileExistsMode

public FileWritingMessageHandlerSpec fileExistsMode(org.springframework.integration.file.support.FileExistsMode fileExistsMode)

fileNameGenerator

public FileWritingMessageHandlerSpec fileNameGenerator(org.springframework.integration.file.FileNameGenerator fileNameGenerator)

fileNameExpression

public FileWritingMessageHandlerSpec fileNameExpression(java.lang.String fileNameExpression)

deleteSourceFiles

public FileWritingMessageHandlerSpec deleteSourceFiles(boolean deleteSourceFiles)

charset

public FileWritingMessageHandlerSpec charset(java.lang.String charset)

appendNewLine

public FileWritingMessageHandlerSpec appendNewLine(boolean appendNewLine)

Parameters:

appendNewLine - true if a new-line should be written to the file after payload is written.

Returns:

the spec.

Since:

1.1.1

See Also:

FileWritingMessageHandler.setAppendNewLine(boolean)

bufferSize

public FileWritingMessageHandlerSpec bufferSize(int bufferSize)

Set the buffer size to use while writing to files; default 8192.

Parameters:

bufferSize - the buffer size.

Returns:

the spec.

Since:

1.2

See Also:

FileWritingMessageHandler.setBufferSize(int)

flushInterval

public FileWritingMessageHandlerSpec flushInterval(long flushInterval)

Set the frequency to flush buffers when FileExistsMode.APPEND_NO_FLUSH is being used.

Parameters:

flushInterval - the interval.

Returns:

the spec.

Since:

1.2

See Also:

FileWritingMessageHandler.setBufferSize(int)

taskScheduler

public FileWritingMessageHandlerSpec taskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)

Specify a TaskScheduler for flush task when the FileExistsMode.APPEND_NO_FLUSH is in use.

Parameters:

taskScheduler - the TaskScheduler to use.

Returns:

the spec.

Since:

1.2

See Also:

FileWritingMessageHandler.setTaskScheduler(TaskScheduler)

flushPredicate

public FileWritingMessageHandlerSpec flushPredicate(org.springframework.integration.file.FileWritingMessageHandler.MessageFlushPredicate flushPredicate)

Specify a FileWritingMessageHandler.MessageFlushPredicate for flush task when the FileExistsMode.APPEND_NO_FLUSH is in use.

Parameters:

flushPredicate - the FileWritingMessageHandler.MessageFlushPredicate to use.

Returns:

the spec.

Since:

1.2

See Also:

FileWritingMessageHandler.setFlushPredicate(FileWritingMessageHandler.MessageFlushPredicate)

preserveTimestamp

public FileWritingMessageHandlerSpec preserveTimestamp(boolean preserveTimestamp)

Set to true to preserve the destination file timestamp. If true and the payload is a File, the payload's lastModified time will be transferred to the destination file.

Parameters:

preserveTimestamp - the boolean flag to use.

Returns:

the spec.

Since:

1.2

See Also:

FileWritingMessageHandler.setPreserveTimestamp(boolean)

getComponentsToRegister

public java.util.Collection<java.lang.Object> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration