Package com.adaptris.core.services.aggregator

Interface MessageAggregator

All Known Implementing Classes:

AppendingMessageAggregator, IgnoreOriginalMimeAggregator, IgnoreOriginalXmlDocumentAggregator, MessageAggregatorImpl, MimeAggregator, MultiPayloadMessageAggregator, NullMessageAggregator, ReplaceWithFirstMessage, XmlDocumentAggregator, ZipAggregator

public interface MessageAggregator

Interface for creating a single AdaptrisMessage instance from multiple Messages.

See Also:

PooledSplitJoinService

Method Summary

Modifier and Type	Method	Description
default void	aggregate(AdaptrisMessage original, java.lang.Iterable<AdaptrisMessage> msgs)	Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.
static java.util.Collection<AdaptrisMessage>	collect(java.lang.Iterable<AdaptrisMessage> iter)
default void	joinMessage(AdaptrisMessage msg, java.util.Collection<AdaptrisMessage> msgs)	Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.

Method Detail

joinMessage

default void joinMessage(AdaptrisMessage msg,
                         java.util.Collection<AdaptrisMessage> msgs)
                  throws CoreException

Joins multiple AdaptrisMessages into a single AdaptrisMessage objects. Preservation of metadata is down to the implementation.

Parameters:

msg - the msg to insert all the messages into

msgs - the list of messages to join.

Throws:

CoreException - wrapping any other exception

Implementation Note:

the default operation throws a UnsupportedOperationException.

aggregate

default void aggregate(AdaptrisMessage original,
                       java.lang.Iterable<AdaptrisMessage> msgs)
                throws CoreException,
                       java.io.IOException

Joins multiple AdaptrisMessages into a single AdaptrisMessage objects. Preservation of metadata is down to the implementation.

Parameters:

original - the original message

msgs - the list of messages to join.

Throws:

CoreException

java.io.IOException

Implementation Note:

The default implementation turns the Iterable into a collection and invokes joinMessage(AdaptrisMessage, Collection) for backwards compatibility reasons.

collect

static java.util.Collection<AdaptrisMessage> collect(java.lang.Iterable<AdaptrisMessage> iter)
                                              throws java.io.IOException,
                                                     CoreException

Throws:

java.io.IOException

CoreException