Class Files
java.lang.Object
org.springframework.integration.file.dsl.Files
public abstract class Files
extends java.lang.Object
The Spring Integration File components Factory.
- Since:
- 5.0
-
Constructor Summary
Constructors Constructor Description Files() -
Method Summary
Modifier and Type Method Description static FileInboundChannelAdapterSpecinboundAdapter(java.io.File directory)Create aFileInboundChannelAdapterSpecbuilder for theFileReadingMessageSource.static FileInboundChannelAdapterSpecinboundAdapter(java.io.File directory, java.util.Comparator<java.io.File> receptionOrderComparator)Create aFileInboundChannelAdapterSpecbuilder for theFileReadingMessageSource.static FileWritingMessageHandlerSpecoutboundAdapter(java.io.File destinationDirectory)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.static FileWritingMessageHandlerSpecoutboundAdapter(java.lang.String directoryExpression)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.static <P> FileWritingMessageHandlerSpecoutboundAdapter(java.util.function.Function<org.springframework.messaging.Message<P>,?> directoryFunction)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.static FileWritingMessageHandlerSpecoutboundAdapter(org.springframework.expression.Expression directoryExpression)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.static FileWritingMessageHandlerSpecoutboundGateway(java.io.File destinationDirectory)Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.static FileWritingMessageHandlerSpecoutboundGateway(java.lang.String directoryExpression)Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.static <P> FileWritingMessageHandlerSpecoutboundGateway(java.util.function.Function<org.springframework.messaging.Message<P>,?> directoryFunction)Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.static FileWritingMessageHandlerSpecoutboundGateway(org.springframework.expression.Expression directoryExpression)Create aFileWritingMessageHandlerSpecbased on the providedExpressionfor directory.static FileSplitterSpecsplitter()TheFileSplitterSpecbuilder factory method with default arguments.static FileSplitterSpecsplitter(boolean iterator)TheFileSplitterSpecbuilder factory method withiteratorflag specified.static FileSplitterSpecsplitter(boolean iterator, boolean markers)static TailAdapterSpectailAdapter(java.io.File file)Create aTailAdapterSpecbuilder for theFileTailingMessageProducerSupport.static FileToByteArrayTransformertoByteArrayTransformer()Create aFileToByteArrayTransformerinstance.static FileToByteArrayTransformertoByteArrayTransformer(boolean deleteFiles)Create aFileToByteArrayTransformerinstance.static FileToStringTransformertoStringTransformer()Create aFileToStringTransformerinstance with defaultcharsetand no delete files afterwards.static FileToStringTransformertoStringTransformer(boolean deleteFiles)Create aFileToStringTransformerinstance with defaultcharsetand with delete files flag.static FileToStringTransformertoStringTransformer(java.lang.String charset)Create aFileToStringTransformerinstance with providedcharsetand no delete files afterwards.static FileToStringTransformertoStringTransformer(java.lang.String charset, boolean deleteFiles)Create aFileToStringTransformerinstance with providedcharsetand delete files flag.
-
Constructor Details
-
Files
public Files()
-
-
Method Details
-
inboundAdapter
Create aFileInboundChannelAdapterSpecbuilder for theFileReadingMessageSource.- Parameters:
directory- the directory to scan files.- Returns:
- the
FileInboundChannelAdapterSpecinstance.
-
inboundAdapter
public static FileInboundChannelAdapterSpec inboundAdapter(java.io.File directory, java.util.Comparator<java.io.File> receptionOrderComparator)Create aFileInboundChannelAdapterSpecbuilder for theFileReadingMessageSource.- Parameters:
directory- the directory to scan files.receptionOrderComparator- theComparatorfor ordering file objects.- Returns:
- the
FileInboundChannelAdapterSpecinstance.
-
outboundAdapter
Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.- Parameters:
destinationDirectory- the target directory to write files.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundAdapter
Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.- Parameters:
directoryExpression- the SpEL expression to evaluate target directory for writing files.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundAdapter
public static FileWritingMessageHandlerSpec outboundAdapter(org.springframework.expression.Expression directoryExpression)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.- Parameters:
directoryExpression- an expression to evaluate the target directory.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundAdapter
public static <P> FileWritingMessageHandlerSpec outboundAdapter(java.util.function.Function<org.springframework.messaging.Message<P>,?> directoryFunction)Create aFileWritingMessageHandlerSpecbuilder for the one-wayFileWritingMessageHandler.- Type Parameters:
P- the payload type.- Parameters:
directoryFunction- theFunctionto evaluate the target directory at runtime.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundGateway
Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.- Parameters:
destinationDirectory- the target directory to write files.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundGateway
Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.- Parameters:
directoryExpression- the SpEL expression to evaluate target directory for writing files.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
outboundGateway
public static FileWritingMessageHandlerSpec outboundGateway(org.springframework.expression.Expression directoryExpression)Create aFileWritingMessageHandlerSpecbased on the providedExpressionfor directory.- Parameters:
directoryExpression- an expression to evaluate the target directory.- Returns:
- the FileWritingMessageHandlerSpec instance.
-
outboundGateway
public static <P> FileWritingMessageHandlerSpec outboundGateway(java.util.function.Function<org.springframework.messaging.Message<P>,?> directoryFunction)Create aFileWritingMessageHandlerSpecbuilder for the gatewayFileWritingMessageHandler.- Type Parameters:
P- the payload type.- Parameters:
directoryFunction- theFunctionto evaluate the target directory at runtime.- Returns:
- the
FileWritingMessageHandlerSpecinstance.
-
tailAdapter
Create aTailAdapterSpecbuilder for theFileTailingMessageProducerSupport.- Parameters:
file- the file to tail.- Returns:
- the
TailAdapterSpecinstance.
-
splitter
TheFileSplitterSpecbuilder factory method with default arguments.- Returns:
- the
FileSplitterSpecbuilder.
-
splitter
TheFileSplitterSpecbuilder factory method withiteratorflag specified.- Parameters:
iterator- thebooleanflag to specify theiteratormode or not.- Returns:
- the
FileSplitterSpecbuilder.
-
splitter
- Parameters:
iterator- thebooleanflag to specify theiteratormode or not.markers- true to emit start of file/end of file marker messages before/after the data.- Returns:
- the
FileSplitterSpecbuilder.
-
toStringTransformer
Create aFileToStringTransformerinstance with defaultcharsetand no delete files afterwards.- Returns:
- the
FileToStringTransformer.
-
toStringTransformer
Create aFileToStringTransformerinstance with defaultcharsetand with delete files flag.- Parameters:
deleteFiles- true to delete the file.- Returns:
- the
FileToStringTransformer.
-
toStringTransformer
Create aFileToStringTransformerinstance with providedcharsetand no delete files afterwards.- Parameters:
charset- The charset.- Returns:
- the
FileToStringTransformer.
-
toStringTransformer
public static FileToStringTransformer toStringTransformer(java.lang.String charset, boolean deleteFiles)Create aFileToStringTransformerinstance with providedcharsetand delete files flag.- Parameters:
charset- The charset.deleteFiles- true to delete the file.- Returns:
- the
FileToStringTransformer.
-
toByteArrayTransformer
Create aFileToByteArrayTransformerinstance.- Returns:
- the
FileToByteArrayTransformer.
-
toByteArrayTransformer
Create aFileToByteArrayTransformerinstance.- Parameters:
deleteFiles- specify whether to delete the File after transformation. Default is false.- Returns:
- the
FileToByteArrayTransformer.
-