org.springframework.integration.file

Class FileWritingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.file.FileWritingMessageHandler

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

public class FileWritingMessageHandler
extends AbstractReplyProducingMessageHandler

A MessageHandler implementation that writes the Message payload to a file. If the payload is a File object, it will copy the File to the specified destination directory. If the payload is a byte array or String, it will write it directly. Otherwise, the payload type is unsupported, and an Exception will be thrown.

If the 'deleteSourceFiles' flag is set to true, the original Files will be deleted. The default value for that flag is false. See the setDeleteSourceFiles(boolean) method javadoc for more information.

Other transformers may be useful to precede this handler. For example, any Serializable object payload can be converted into a byte array by the PayloadSerializingTransformer. Likewise, any Object can be converted to a String based on its toString() method by the ObjectToStringTransformer.

Author:

Mark Fisher, Iwein Fuld, Alex Peters, Oleg Zhurakousky, Artem Bilan, Gunnar Hillert, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
FileWritingMessageHandler(Expression destinationDirectoryExpression) Constructor which sets the destinationDirectoryExpression.
FileWritingMessageHandler(File destinationDirectory) Constructor which sets the destinationDirectoryExpression using a LiteralExpression.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInit()
protected String	getTemporaryFileSuffix()
protected Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
void	setAutoCreateDirectory(boolean autoCreateDirectory) Specify whether to create the destination directory automatically if it does not yet exist upon initialization.
void	setCharset(String charset) Set the charset name to use when writing a File from a String-based Message payload.
void	setDeleteSourceFiles(boolean deleteSourceFiles) Specify whether to delete source Files after writing to the destination directory.
void	setExpectReply(boolean expectReply) Specify whether a reply Message is expected.
void	setFileExistsMode(FileExistsMode fileExistsMode) Will set the FileExistsMode that specifies what will happen in case the destination exists.
void	setFileNameGenerator(FileNameGenerator fileNameGenerator) Provide the FileNameGenerator strategy to use when generating the destination file's name.
void	setTemporaryFileSuffix(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.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getMessagingTemplate, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setChannelResolver, setOutputChannel, setOutputChannelName, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

FileWritingMessageHandler

public FileWritingMessageHandler(File destinationDirectory)

Constructor which sets the destinationDirectoryExpression using a LiteralExpression.

Parameters:

destinationDirectory - Must not be null

See Also:

FileWritingMessageHandler(Expression)

FileWritingMessageHandler

public FileWritingMessageHandler(Expression destinationDirectoryExpression)

Constructor which sets the destinationDirectoryExpression.

Parameters:

destinationDirectoryExpression - Must not be null

See Also:

FileWritingMessageHandler(File)

Method Detail

setAutoCreateDirectory

public void setAutoCreateDirectory(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.

setTemporaryFileSuffix

public void setTemporaryFileSuffix(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". This can be changed by setting this property.

Parameters:

temporaryFileSuffix - The temporary file suffix.

setFileExistsMode

public void setFileExistsMode(FileExistsMode fileExistsMode)

Will set the FileExistsMode that specifies what will happen in case the destination exists. For example FileExistsMode.APPEND instructs this handler to append data to the existing file rather then creating a new file for each Message. If set to FileExistsMode.APPEND, the adapter will also create a real instance of the LockRegistry to ensure that there is no collisions when multiple threads are writing to the same file. Otherwise the LockRegistry is set to PassThruLockRegistry which has no effect.

Parameters:

fileExistsMode - Must not be null

setExpectReply

public void setExpectReply(boolean expectReply)

Specify whether a reply Message is expected. If not, this handler will simply return null for a successful response or throw an Exception for a non-successful response. The default is true.

Parameters:

expectReply - true if a reply is expected.

getTemporaryFileSuffix

protected String getTemporaryFileSuffix()

setFileNameGenerator

public void setFileNameGenerator(FileNameGenerator fileNameGenerator)

Provide the FileNameGenerator strategy to use when generating the destination file's name.

Parameters:

fileNameGenerator - The file name generator.

setDeleteSourceFiles

public void setDeleteSourceFiles(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.

setCharset

public void setCharset(String charset)

Set the charset name to use when writing a File from a String-based Message payload.

Parameters:

charset - The charset.

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.