Class DataSonnetErrorMessageFormatter

java.lang.Object
org.frankframework.errormessageformatters.ErrorMessageFormatter
org.frankframework.errormessageformatters.DataSonnetErrorMessageFormatter
All Implemented Interfaces:
IConfigurable, IErrorMessageFormatter, IScopeProvider, IWithParameters

public class DataSonnetErrorMessageFormatter extends ErrorMessageFormatter implements IErrorMessageFormatter, IConfigurable, IScopeProvider, IWithParameters
Create an error message in JSON format.

  • Constructor Details

    • DataSonnetErrorMessageFormatter

      public DataSonnetErrorMessageFormatter()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • format

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

      public void setStyleSheetName(String styleSheetName)
      Set a DataSonnet stylesheet to transform the default JSON error message to a custom format.
    • setComputeMimeType

      public void setComputeMimeType(boolean computeMimeType)
      Computes the mimetype when it is unknown. It requires more computation but improves mapping results.
      Default value
      true
    • setOutputType

      public void setOutputType(DataSonnetOutputType outputType)
      Output file format. DataSonnet is semi-capable of converting the converted JSON to a different format.
      Default value
      JSON
    • setMessageFormat

      @Protected public void setMessageFormat(@Nonnull DocumentFormat messageFormat)
      Description copied from class: ErrorMessageFormatter
      Format the error message as XML or as JSON. ff.default XML
      Overrides:
      setMessageFormat in class ErrorMessageFormatter
    • addParameter

      public void addParameter(IParameter p)
      Specified by:
      addParameter in interface IWithParameters
    • getParameterList

      @Nonnull public ParameterList getParameterList()
      Specified by:
      getParameterList in interface IWithParameters