Class Files

java.lang.Object

org.springframework.integration.file.dsl.Files

public abstract class Files
extends Object

The Spring Integration File components Factory.

Since:

5.0

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor	Description
Files()

Method Summary

Modifier and Type	Method	Description
static FileInboundChannelAdapterSpec	inboundAdapter(File directory)	Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.
static FileInboundChannelAdapterSpec	inboundAdapter(File directory, @Nullable Comparator<File> receptionOrderComparator)	Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.
static FileInboundChannelAdapterSpec	inboundAdapter(Supplier<File> directorySupplier)	Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.
static FileInboundChannelAdapterSpec	inboundAdapter(Supplier<File> directorySupplier, @Nullable Comparator<File> receptionOrderComparator)	Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.
static FileWritingMessageHandlerSpec	outboundAdapter(File destinationDirectory)	Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.
static FileWritingMessageHandlerSpec	outboundAdapter(String directoryExpression)	Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.
static <P> FileWritingMessageHandlerSpec	outboundAdapter(Function<Message<P>, ?> directoryFunction)	Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.
static FileWritingMessageHandlerSpec	outboundAdapter(Expression directoryExpression)	Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.
static FileWritingMessageHandlerSpec	outboundGateway(File destinationDirectory)	Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.
static FileWritingMessageHandlerSpec	outboundGateway(String directoryExpression)	Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.
static <P> FileWritingMessageHandlerSpec	outboundGateway(Function<Message<P>, ?> directoryFunction)	Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.
static FileWritingMessageHandlerSpec	outboundGateway(Expression directoryExpression)	Create a FileWritingMessageHandlerSpec based on the provided Expression for directory.
static FileSplitterSpec	splitter()	The FileSplitterSpec builder factory method with default arguments.
static FileSplitterSpec	splitter(boolean iterator)	The FileSplitterSpec builder factory method with iterator flag specified.
static FileSplitterSpec	splitter(boolean iterator, boolean markers)	The FileSplitterSpec builder factory method with iterator and markers flags specified.
static TailAdapterSpec	tailAdapter(File file)	Create a TailAdapterSpec builder for the FileTailingMessageProducerSupport.
static FileToByteArrayTransformer	toByteArrayTransformer()	Create a FileToByteArrayTransformer instance.
static FileToByteArrayTransformer	toByteArrayTransformer(boolean deleteFiles)	Create a FileToByteArrayTransformer instance.
static FileToStringTransformer	toStringTransformer()	Create a FileToStringTransformer instance with default charset and no delete files afterwards.
static FileToStringTransformer	toStringTransformer(boolean deleteFiles)	Create a FileToStringTransformer instance with default charset and with delete files flag.
static FileToStringTransformer	toStringTransformer(@Nullable String charset, boolean deleteFiles)	Create a FileToStringTransformer instance with provided charset and delete files flag.
static FileToStringTransformer	toStringTransformer(String charset)	Create a FileToStringTransformer instance with provided charset and no delete files afterwards.

Methods inherited from class java.lang.Object

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

Constructor Details

Files

public Files()

Method Details

inboundAdapter

public static FileInboundChannelAdapterSpec inboundAdapter(File directory)

Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.

Parameters:

directory - the directory to scan files.

Returns:

the FileInboundChannelAdapterSpec instance.

inboundAdapter

public static FileInboundChannelAdapterSpec inboundAdapter(Supplier<File> directorySupplier)

Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.

Parameters:

directorySupplier - the Supplier for directory to scan files.

Returns:

the FileInboundChannelAdapterSpec instance.

Since:

7.0

inboundAdapter

public static FileInboundChannelAdapterSpec inboundAdapter(File directory,
 @Nullable Comparator<File> receptionOrderComparator)

Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.

Parameters:

directory - the directory to scan files.

receptionOrderComparator - the Comparator for ordering file objects.

Returns:

the FileInboundChannelAdapterSpec instance.

inboundAdapter

public static FileInboundChannelAdapterSpec inboundAdapter(Supplier<File> directorySupplier,
 @Nullable Comparator<File> receptionOrderComparator)

Create a FileInboundChannelAdapterSpec builder for the FileReadingMessageSource.

Parameters:

directorySupplier - the Supplier for directory to scan files.

receptionOrderComparator - the Comparator for ordering file objects.

Returns:

the FileInboundChannelAdapterSpec instance.

Since:

7.0

outboundAdapter

public static FileWritingMessageHandlerSpec outboundAdapter(File destinationDirectory)

Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.

Parameters:

destinationDirectory - the target directory to write files.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundAdapter

public static FileWritingMessageHandlerSpec outboundAdapter(String directoryExpression)

Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.

Parameters:

directoryExpression - the SpEL expression to evaluate target directory for writing files.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundAdapter

public static FileWritingMessageHandlerSpec outboundAdapter(Expression directoryExpression)

Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.

Parameters:

directoryExpression - an expression to evaluate the target directory.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundAdapter

public static <P> FileWritingMessageHandlerSpec outboundAdapter(Function<Message<P>, ?> directoryFunction)

Create a FileWritingMessageHandlerSpec builder for the one-way FileWritingMessageHandler.

Type Parameters:

P - the payload type.

Parameters:

directoryFunction - the Function to evaluate the target directory at runtime.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundGateway

public static FileWritingMessageHandlerSpec outboundGateway(File destinationDirectory)

Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.

Parameters:

destinationDirectory - the target directory to write files.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundGateway

public static FileWritingMessageHandlerSpec outboundGateway(String directoryExpression)

Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.

Parameters:

directoryExpression - the SpEL expression to evaluate target directory for writing files.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundGateway

public static FileWritingMessageHandlerSpec outboundGateway(Expression directoryExpression)

Create a FileWritingMessageHandlerSpec based on the provided Expression for directory.

Parameters:

directoryExpression - an expression to evaluate the target directory.

Returns:

the FileWritingMessageHandlerSpec instance.

outboundGateway

public static <P> FileWritingMessageHandlerSpec outboundGateway(Function<Message<P>, ?> directoryFunction)

Create a FileWritingMessageHandlerSpec builder for the gateway FileWritingMessageHandler.

Type Parameters:

P - the payload type.

Parameters:

directoryFunction - the Function to evaluate the target directory at runtime.

Returns:

the FileWritingMessageHandlerSpec instance.

tailAdapter

public static TailAdapterSpec tailAdapter(File file)

Create a TailAdapterSpec builder for the FileTailingMessageProducerSupport.

Parameters:

file - the file to tail.

Returns:

the TailAdapterSpec instance.

splitter

public static FileSplitterSpec splitter()

The FileSplitterSpec builder factory method with default arguments.

Returns:

the FileSplitterSpec builder.

splitter

public static FileSplitterSpec splitter(boolean iterator)

The FileSplitterSpec builder factory method with iterator flag specified.

Parameters:

iterator - the boolean flag to specify the iterator mode or not.

Returns:

the FileSplitterSpec builder.

splitter

public static FileSplitterSpec splitter(boolean iterator,
 boolean markers)

The FileSplitterSpec builder factory method with iterator and markers flags specified.

Parameters:

iterator - the boolean flag to specify the iterator mode or not.

markers - true to emit start of file/end of file marker messages before/after the data.

Returns:

the FileSplitterSpec builder.

toStringTransformer

public static FileToStringTransformer toStringTransformer()

Create a FileToStringTransformer instance with default charset and no delete files afterwards.

Returns:

the FileToStringTransformer.

toStringTransformer

public static FileToStringTransformer toStringTransformer(boolean deleteFiles)

Create a FileToStringTransformer instance with default charset and with delete files flag.

Parameters:

deleteFiles - true to delete the file.

Returns:

the FileToStringTransformer.

toStringTransformer

public static FileToStringTransformer toStringTransformer(String charset)

Create a FileToStringTransformer instance with provided charset and no delete files afterwards.

Parameters:

charset - The charset.

Returns:

the FileToStringTransformer.

toStringTransformer

public static FileToStringTransformer toStringTransformer(@Nullable String charset,
 boolean deleteFiles)

Create a FileToStringTransformer instance with provided charset and delete files flag.

Parameters:

charset - The charset.

deleteFiles - true to delete the file.

Returns:

the FileToStringTransformer.

toByteArrayTransformer

public static FileToByteArrayTransformer toByteArrayTransformer()

Create a FileToByteArrayTransformer instance.

Returns:

the FileToByteArrayTransformer.

toByteArrayTransformer

public static FileToByteArrayTransformer toByteArrayTransformer(boolean deleteFiles)

Create a FileToByteArrayTransformer instance.

Parameters:

deleteFiles - specify whether to delete the File after transformation. Default is false.

Returns:

the FileToByteArrayTransformer.