com.adaptris.core.services.exception

Class ExceptionAsXml

java.lang.Object

com.adaptris.core.services.exception.ExceptionAsXml

All Implemented Interfaces:

ExceptionSerializer

public class ExceptionAsXml
extends java.lang.Object
implements ExceptionSerializer

Use with ExceptionReportService to write the exception as part of an xml document.

In the adapter configuration file this class is aliased as exception-as-xml which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ExceptionAsXml()

Method Summary

Modifier and Type	Method and Description
DocumentMerge	getDocumentMerge()
ExceptionReportGenerator	getExceptionGenerator()
java.lang.Boolean	getIgnoreXmlParseExceptions()
DocumentBuilderFactoryBuilder	getXmlDocumentFactoryConfig()
java.lang.String	getXmlEncoding()
void	serialize(java.lang.Exception exception, AdaptrisMessage msg) Serialize the exception into the adaptris message.
void	setDocumentMerge(DocumentMerge m) Specify how to merge the exception into the AdaptrisMessage.
void	setExceptionGenerator(ExceptionReportGenerator generator) Specify how to create the XML document from the exception.
void	setIgnoreXmlParseExceptions(java.lang.Boolean b) Whether or not to ignore exceptions parsing the AdaptrisMessage.
void	setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)
void	setXmlEncoding(java.lang.String encoding) Set the encoding for the resulting XML document.
ExceptionAsXml	withDocumentFactoryConfig(DocumentBuilderFactoryBuilder e)
ExceptionAsXml	withDocumentMerge(DocumentMerge docMerge)
ExceptionAsXml	withExceptionGenerator(ExceptionReportGenerator e)
ExceptionAsXml	withIgnoreXmlParseExceptions(java.lang.Boolean b)
ExceptionAsXml	withXmlEncoding(java.lang.String e)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

ExceptionAsXml

public ExceptionAsXml()

Method Detail

withDocumentMerge

public ExceptionAsXml withDocumentMerge(DocumentMerge docMerge)

withExceptionGenerator

public ExceptionAsXml withExceptionGenerator(ExceptionReportGenerator e)

withXmlEncoding

public ExceptionAsXml withXmlEncoding(java.lang.String e)

withDocumentFactoryConfig

public ExceptionAsXml withDocumentFactoryConfig(DocumentBuilderFactoryBuilder e)

withIgnoreXmlParseExceptions

public ExceptionAsXml withIgnoreXmlParseExceptions(java.lang.Boolean b)

serialize

public void serialize(java.lang.Exception exception,
                      AdaptrisMessage msg)
               throws CoreException

Description copied from interface: ExceptionSerializer

Serialize the exception into the adaptris message.

Specified by:

serialize in interface ExceptionSerializer

Parameters:

exception - the exception

msg - the message

Throws:

CoreException - wrapping other exceptions.

getDocumentMerge

public DocumentMerge getDocumentMerge()

setDocumentMerge

public void setDocumentMerge(DocumentMerge m)

Specify how to merge the exception into the AdaptrisMessage.

Parameters:

m - the merge implementation, if not specified defaults to ReplaceOriginal

getExceptionGenerator

public ExceptionReportGenerator getExceptionGenerator()

setExceptionGenerator

public void setExceptionGenerator(ExceptionReportGenerator generator)

Specify how to create the XML document from the exception.

Parameters:

generator - the generator, if not specified defaults to SimpleExceptionReport.

getXmlEncoding

public java.lang.String getXmlEncoding()

setXmlEncoding

public void setXmlEncoding(java.lang.String encoding)

Set the encoding for the resulting XML document.

Parameters:

encoding - the encoding, default is UTF-8

getXmlDocumentFactoryConfig

public DocumentBuilderFactoryBuilder getXmlDocumentFactoryConfig()

setXmlDocumentFactoryConfig

public void setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)

getIgnoreXmlParseExceptions

public java.lang.Boolean getIgnoreXmlParseExceptions()

setIgnoreXmlParseExceptions

public void setIgnoreXmlParseExceptions(java.lang.Boolean b)

Whether or not to ignore exceptions parsing the AdaptrisMessage.

In some situations you might have an empty payload (such as when the workflow is fired by an HTTP GET request); but you want to report the exception as XML using ReplaceOriginal as the DocumentMerge implementation. If that is the case, then you should set this value to be true. It defaults to false to preserve backwards compatibility.

Parameters:

b - true to ignore parse exceptions (default is false if not specified.