Package org.springframework.integration.file.dsl

Class FileWritingMessageHandlerSpec

java.lang.Object

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

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

org.springframework.integration.file.dsl.FileWritingMessageHandlerSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<FileWritingMessageHandler>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class FileWritingMessageHandlerSpec
extends MessageHandlerSpec<FileWritingMessageHandlerSpec,FileWritingMessageHandler>
implements ComponentsRegistration

The MessageHandlerSpec for the FileWritingMessageHandler.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

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

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileWritingMessageHandlerSpec(File destinationDirectory)
protected	FileWritingMessageHandlerSpec(String directoryExpression)
protected	FileWritingMessageHandlerSpec(Function<Message<P>,?> directoryFunction)
protected	FileWritingMessageHandlerSpec(Expression directoryExpression)

Method Summary

Modifier and Type	Method	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(String charset)	Set the charset to use when converting String payloads to bytes as the content of the file.
FileWritingMessageHandlerSpec	chmod(int chmod)	Set the file permissions after uploading, e.g.
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(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.
FileWritingMessageHandlerSpec	flushWhenIdle(boolean flushWhenIdle)	Set the flush when idle flag to false if you wish the interval to apply to when the file was opened rather than when the file was last written.
Map<Object,String>	getComponentsToRegister()
FileWritingMessageHandlerSpec	preserveTimestamp(boolean preserveTimestamp)	Set to true to preserve the destination file timestamp.
FileWritingMessageHandlerSpec	taskScheduler(TaskScheduler taskScheduler)	Specify a TaskScheduler for flush task when the FileExistsMode.APPEND_NO_FLUSH is in use.
FileWritingMessageHandlerSpec	temporaryFileSuffix(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.

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

_this, afterPropertiesSet, destroy, doGet, get, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Constructor Details

FileWritingMessageHandlerSpec

protected FileWritingMessageHandlerSpec(File destinationDirectory)

FileWritingMessageHandlerSpec

protected FileWritingMessageHandlerSpec(String directoryExpression)

FileWritingMessageHandlerSpec

protected FileWritingMessageHandlerSpec(Function<Message<P>,?> directoryFunction)

FileWritingMessageHandlerSpec

protected FileWritingMessageHandlerSpec(Expression directoryExpression)

Method Details

autoCreateDirectory

public FileWritingMessageHandlerSpec autoCreateDirectory(boolean autoCreateDirectory)

Specify whether to create the destination directory automatically if it does not yet exist upon initialization. By default, this value is true. If set to false and the destination directory does not exist, an Exception will be thrown upon initialization.

Parameters:

autoCreateDirectory - true to create the directory if needed.

Returns:

the current Spec

temporaryFileSuffix

public FileWritingMessageHandlerSpec temporaryFileSuffix(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.

Parameters:

temporaryFileSuffix - The temporary file suffix.

Returns:

the current Spec

fileExistsMode

public FileWritingMessageHandlerSpec fileExistsMode(FileExistsMode fileExistsMode)

Set the FileExistsMode that specifies what will happen in case the destination exists.

Parameters:

fileExistsMode - the FileExistsMode to consult.

Returns:

the current Spec

fileNameGenerator

public FileWritingMessageHandlerSpec fileNameGenerator(FileNameGenerator fileNameGenerator)

Set the file name generator used to generate the target file name. Default DefaultFileNameGenerator.

Parameters:

fileNameGenerator - the file name generator.

Returns:

the current Spec

fileNameExpression

public FileWritingMessageHandlerSpec fileNameExpression(String fileNameExpression)

Set the DefaultFileNameGenerator based on the provided SpEL expression.

Parameters:

fileNameExpression - the SpEL expression for file names generation.

Returns:

the current Spec

deleteSourceFiles

public FileWritingMessageHandlerSpec deleteSourceFiles(boolean deleteSourceFiles)

Specify whether to delete source Files after writing to the destination directory. The default is false. When set to true, it will only have an effect if the inbound Message has a File payload or a FileHeaders.ORIGINAL_FILE header value containing either a File instance or a String representing the original file path.

Parameters:

deleteSourceFiles - true to delete the source files.

Returns:

the current Spec

charset

public FileWritingMessageHandlerSpec charset(String charset)

Set the charset to use when converting String payloads to bytes as the content of the file. Default UTF-8.

Parameters:

charset - the charset.

Returns:

the current Spec

appendNewLine

public FileWritingMessageHandlerSpec appendNewLine(boolean appendNewLine)

If true will append a new-line after each write. Defaults to false.

Parameters:

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

Returns:

the spec.

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.

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.

See Also:

• FileWritingMessageHandler.setBufferSize(int)
• flushWhenIdle(boolean)

flushWhenIdle

public FileWritingMessageHandlerSpec flushWhenIdle(boolean flushWhenIdle)

Set the flush when idle flag to false if you wish the interval to apply to when the file was opened rather than when the file was last written.

Parameters:

flushWhenIdle - false to flush if the interval since the file was opened has elapsed.

Returns:

the spec.

See Also:

• FileWritingMessageHandler.setFlushWhenIdle(boolean)
• flushInterval(long)

taskScheduler

public FileWritingMessageHandlerSpec taskScheduler(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.

See Also:

• IntegrationObjectSupport.setTaskScheduler(TaskScheduler)

flushPredicate

public FileWritingMessageHandlerSpec flushPredicate(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.

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.

See Also:

• FileWritingMessageHandler.setPreserveTimestamp(boolean)

chmod

public FileWritingMessageHandlerSpec chmod(int chmod)

Set the file permissions after uploading, e.g. 0600 for owner read/write. Only applies to file systems that support posix file permissions.

Parameters:

chmod - the permissions.

Returns:

the spec.

Throws:

IllegalArgumentException - if the value is higher than 0777.

See Also:

• FileWritingMessageHandler.setChmod(int)

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration