Class ErrorMessageFormatter

java.lang.Object
org.frankframework.errormessageformatters.ErrorMessageFormatter
All Implemented Interfaces:
IErrorMessageFormatter, IScopeProvider
Direct Known Subclasses:
DataSonnetErrorMessageFormatter, FixedErrorMessageFormatter, SoapErrorMessageFormatter, XslErrorMessageFormatter

public class ErrorMessageFormatter extends Object implements IErrorMessageFormatter, IScopeProvider
This class wraps an error in an XML string.

Sample xml:


 <errorMessage>
    <message timestamp="Mon Oct 13 12:01:57 CEST 2003"
             originator="NN IOS AdapterFramework(set from 'application.name' and 'application.version')"
             message="message describing the error that occurred">
    <location class="org.frankframework.pipes.XmlSwitch" name="ServiceSwitch"/>
    <details>detailed information of the error</details>
    <originalMessage messageId="..." receivedTime="Mon Oct 27 12:10:18 CET 2003" >
        <![CDATA[contents of message for which the error occurred]]>
    </originalMessage>
 </errorMessage>
 
Author:
Gerrit van Brakel
  • Constructor Details

    • ErrorMessageFormatter

      public ErrorMessageFormatter()
  • Method Details

    • format

      public Message format(String errorMessage, Throwable t, HasName location, Message originalMessage, PipeLineSession session)
      Format the available parameters into a XML-message.
      Override this method in subclasses to obtain the required behaviour.
      Specified by:
      format in interface IErrorMessageFormatter
    • getErrorMessage

      @Nullable protected String getErrorMessage(@Nullable String message, @Nullable Throwable t)
    • setMessageFormat

      public void setMessageFormat(@Nonnull DocumentFormat messageFormat)
      Format the error message as XML or as JSON. ff.default XML