com.adaptris.core.services.aggregator

Class IgnoreOriginalXmlDocumentAggregator

java.lang.Object

com.adaptris.core.services.aggregator.MessageAggregatorImpl

com.adaptris.core.services.aggregator.XmlDocumentAggregator

com.adaptris.core.services.aggregator.IgnoreOriginalXmlDocumentAggregator

All Implemented Interfaces:

MessageAggregator

public class IgnoreOriginalXmlDocumentAggregator
extends XmlDocumentAggregator

MessageAggregator implementation that creates single XML using each message that needs to be joined up.

The original pre-split document is completely ignored; you should specify in the template the XML document that will be used to merge split documents.

Use XmlDocumentAggregator.setDocumentEncoding(String) to force the encoding of the resulting XML document to the required value; if not set, then either the original AdaptrisMessage.getCharEncoding() (if set) or UTF-8 will be used in that order.

In the adapter configuration file this class is aliased as ignore-original-xml-document-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
IgnoreOriginalXmlDocumentAggregator()
IgnoreOriginalXmlDocumentAggregator(java.lang.String template)
IgnoreOriginalXmlDocumentAggregator(java.lang.String template, DocumentMerge merge)

Method Summary

Modifier and Type	Method and Description
void	aggregate(AdaptrisMessage original, java.lang.Iterable<AdaptrisMessage> messages) Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.
java.lang.String	getTemplate()
void	setTemplate(java.lang.String s) Set the template for the resulting XML document

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

documentFactoryBuilder, getDocumentEncoding, getMergeImplementation, getXmlDocumentFactoryConfig, joinMessage, setDocumentEncoding, setMergeImplementation, setXmlDocumentFactoryConfig

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

IgnoreOriginalXmlDocumentAggregator

public IgnoreOriginalXmlDocumentAggregator()

IgnoreOriginalXmlDocumentAggregator

public IgnoreOriginalXmlDocumentAggregator(java.lang.String template)

IgnoreOriginalXmlDocumentAggregator

public IgnoreOriginalXmlDocumentAggregator(java.lang.String template,
                                           DocumentMerge merge)

Method Detail

aggregate

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

Description copied from interface: MessageAggregator

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

Specified by:

aggregate in interface MessageAggregator

Overrides:

aggregate in class XmlDocumentAggregator

Parameters:

original - the original message

messages - the list of messages to join.

Throws:

CoreException

getTemplate

public java.lang.String getTemplate()

Returns:

the template

setTemplate

public void setTemplate(java.lang.String s)

Set the template for the resulting XML document

Parameters:

s - the template to set; wrapped in CDATA tags as appropriate.