com.adaptris.core.services.aggregator

Class ReplaceWithFirstMessage

java.lang.Object

com.adaptris.core.services.aggregator.MessageAggregatorImpl

com.adaptris.core.services.aggregator.ReplaceWithFirstMessage

All Implemented Interfaces:

MessageAggregator

public class ReplaceWithFirstMessage
extends MessageAggregatorImpl

Special implementation of MessageAggregator that replaces the original payload with the first aggregated message.

This is primarily designed to be used where there is a one to one relationship between the original and aggregated message. No parsing is done of the first message, it is simply used as is; all other messages that are passed in as part of the collection to be aggregated are ignored.

In the adapter configuration file this class is aliased as replace-with-first-message-aggregator which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.services.aggregator.MessageAggregatorImpl

log

Constructor Summary

Constructors

Constructor and Description
ReplaceWithFirstMessage()

Method Summary

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

Methods inherited from class com.adaptris.core.services.aggregator.MessageAggregatorImpl

filter, filter, getFilterCondition, getOverwriteMetadata, getRetainFilterExceptionsMessages, overwriteMetadata, overwriteMetadata, setFilterCondition, setOverwriteMetadata, setRetainFilterExceptionsMessages, withOverwriteMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.services.aggregator.MessageAggregator

collect

Constructor Detail

ReplaceWithFirstMessage

public ReplaceWithFirstMessage()

Method Detail

joinMessage

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

Description copied from interface: MessageAggregator

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

aggregate

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

Description copied from interface: MessageAggregator

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