com.adaptris.core.services.aggregator

Class XmlDocumentAggregator

java.lang.Object

com.adaptris.core.services.aggregator.MessageAggregatorImpl

com.adaptris.core.services.aggregator.XmlDocumentAggregator

All Implemented Interfaces:

MessageAggregator

Direct Known Subclasses:

IgnoreOriginalXmlDocumentAggregator

public class XmlDocumentAggregator
extends MessageAggregatorImpl

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

The original pre-split document forms the basis of the resulting document; each of the split documents is merged into the main document using the configured DocumentMerge function.

Use 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 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

filterCondition, log, retainFilterExceptionsMessages

Constructor Summary

Constructors

Constructor and Description
XmlDocumentAggregator()
XmlDocumentAggregator(DocumentMerge merge)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocumentEncoding()
DocumentMerge	getMergeImplementation()
DocumentBuilderFactoryBuilder	getXmlDocumentFactoryConfig()
void	joinMessage(AdaptrisMessage original, java.util.Collection<AdaptrisMessage> messages) Joins multiple AdaptrisMessages into a single AdaptrisMessage objects.
void	setDocumentEncoding(java.lang.String s) Set the XML encoding for the resulting document.
void	setMergeImplementation(DocumentMerge dm) Set how to merge the split documents into the main XML document.
void	setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDocumentAggregator

public XmlDocumentAggregator()

XmlDocumentAggregator

public XmlDocumentAggregator(DocumentMerge merge)

Method Detail

joinMessage

public void joinMessage(AdaptrisMessage original,
                        java.util.Collection<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.

Parameters:

original - the msg to insert all the messages into

messages - the list of messages to join.

Throws:

CoreException - wrapping any other exception

getDocumentEncoding

public java.lang.String getDocumentEncoding()

Returns:

the documentEncoding

setDocumentEncoding

public void setDocumentEncoding(java.lang.String s)

Set the XML encoding for the resulting document.

Parameters:

s - the documentEncoding to set (defaults to UTF-8).

getMergeImplementation

public DocumentMerge getMergeImplementation()

Returns:

the mergeImplementation

setMergeImplementation

public void setMergeImplementation(DocumentMerge dm)

Set how to merge the split documents into the main XML document.

Parameters:

dm - the mergeImplementation to set

getXmlDocumentFactoryConfig

public DocumentBuilderFactoryBuilder getXmlDocumentFactoryConfig()

setXmlDocumentFactoryConfig

public void setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)