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.
Constructor and Description |
---|
XmlDocumentAggregator() |
XmlDocumentAggregator(DocumentMerge merge) |
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
AdaptrisMessage s 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) |
getOverwriteMetadata, overwriteMetadata, overwriteMetadata, setOverwriteMetadata
public XmlDocumentAggregator()
public XmlDocumentAggregator(DocumentMerge merge)
public void joinMessage(AdaptrisMessage original, java.util.Collection<AdaptrisMessage> messages) throws CoreException
MessageAggregator
Joins multiple AdaptrisMessage
s into a single AdaptrisMessage objects. Preservation of metadata is down to the
implementation.
original
- the msg to insert all the messages intomessages
- the list of messages to join.CoreException
- wrapping any other exceptionpublic java.lang.String getDocumentEncoding()
public void setDocumentEncoding(java.lang.String s)
s
- the documentEncoding to set (defaults to UTF-8).public DocumentMerge getMergeImplementation()
public void setMergeImplementation(DocumentMerge dm)
dm
- the mergeImplementation to setpublic DocumentBuilderFactoryBuilder getXmlDocumentFactoryConfig()
public void setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)