MessageAggregator (Interlok Core/Base)

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, Iterable<AdaptrisMessage> msgs)

Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.

static Collection<AdaptrisMessage>

collect(Iterable<AdaptrisMessage> iter)

default void

joinMessage(AdaptrisMessage msg, Collection<AdaptrisMessage> msgs)

Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.

Method Details
- joinMessage
  
  default void joinMessage(AdaptrisMessage msg, 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, Iterable<AdaptrisMessage> msgs) throws CoreException, 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
  
  IOException
  
  Implementation Note:
  
  The default implementation turns the Iterable into a collection and invokes joinMessage(AdaptrisMessage, Collection) for backwards compatibility reasons.
- collect
  
  static Collection<AdaptrisMessage> collect(Iterable<AdaptrisMessage> iter) throws IOException, CoreException
  
  Throws:
  
  IOException
  
  CoreException