Class FileAggregator

java.lang.Object

org.springframework.integration.file.aggregator.FileAggregator

All Implemented Interfaces:

Aware, BeanFactoryAware, CorrelationStrategy, GroupConditionProvider, MessageGroupProcessor, ReleaseStrategy

public class FileAggregator
extends Object
implements CorrelationStrategy, ReleaseStrategy, GroupConditionProvider, MessageGroupProcessor, BeanFactoryAware

A convenient component to utilize a FileSplitter.FileMarker-based aggregation logic. Implements all three CorrelationStrategy, ReleaseStrategy and MessageGroupProcessor for runtime optimization. Delegates to HeaderAttributeCorrelationStrategy with FileHeaders.FILENAME attribute, FileMarkerReleaseStrategy and FileAggregatingMessageGroupProcessor, respectively.

The default FileSplitter behavior with markers enabled is about do not provide a sequence details headers, therefore correlation in this aggregator implementation is done by the FileHeaders.FILENAME header which is still populated by the FileSplitter for each line emitted, including FileSplitter.FileMarker messages.

If default behavior of this component does not satisfy the target logic, it is recommended to configure an aggregator with individual strategies.

Since:

5.5

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor	Description
FileAggregator()

Method Summary

Modifier and Type	Method	Description
boolean	canRelease(MessageGroup group)
Object	getCorrelationKey(Message<?> message)	Find the correlation key for the given message.
BiFunction<Message<?>, String, String>	getGroupConditionSupplier()
Object	processMessageGroup(MessageGroup group)	Process the given MessageGroup.
void	setBeanFactory(BeanFactory beanFactory)

Methods inherited from class java.lang.Object

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

Constructor Details

FileAggregator

public FileAggregator()

Method Details

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getCorrelationKey

public Object getCorrelationKey(Message<?> message)

Description copied from interface: CorrelationStrategy

Find the correlation key for the given message. If no key can be determined the strategy should not return null, but throw an exception.

Specified by:

getCorrelationKey in interface CorrelationStrategy

Parameters:

message - The message.

Returns:

The correlation key.

canRelease

public boolean canRelease(MessageGroup group)

Specified by:

canRelease in interface ReleaseStrategy

getGroupConditionSupplier

public BiFunction<Message<?>, String, String> getGroupConditionSupplier()

Specified by:

getGroupConditionSupplier in interface GroupConditionProvider

processMessageGroup

public Object processMessageGroup(MessageGroup group)

Description copied from interface: MessageGroupProcessor

Process the given MessageGroup. Implementations are free to return as few or as many messages based on the invocation as needed. For example an aggregating processor will return only a single message representing the group, while a resequencing processor will return all messages whose preceding sequence has been satisfied.

If a multiple messages are returned the return value must be a Collection<Message>.

Specified by:

processMessageGroup in interface MessageGroupProcessor

Parameters:

group - The message group.

Returns:

The result of processing the group.