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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Configure this component.format
(String errorMessage, Throwable t, HasName location, Message originalMessage, PipeLineSession session) Format the available parameters into a XML-message.void
setComputeMimeType
(boolean computeMimeType) Computes the mimetype when it is unknown.void
setMessageFormat
(DocumentFormat messageFormat) Format the error message as XML or as JSON.void
setOutputType
(DataSonnetOutputType outputType) Output file format.void
setStyleSheetName
(String styleSheetName) Set a DataSonnet stylesheet to transform the default JSON error message to a custom format.Methods inherited from class org.frankframework.errormessageformatters.ErrorMessageFormatter
getErrorMessage
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.frankframework.core.IScopeProvider
getConfigurationClassLoader
-
Constructor Details
-
DataSonnetErrorMessageFormatter
public DataSonnetErrorMessageFormatter()
-
-
Method Details
-
configure
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 thisIConfigurable
. 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 theconfigure()
, to improve performance.In the case of a container, this will propagate the configure signal to all components that apply.
- Specified by:
configure
in interfaceIConfigurable
- 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 interfaceIErrorMessageFormatter
- Overrides:
format
in classErrorMessageFormatter
-
setStyleSheetName
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
Output file format. DataSonnet is semi-capable of converting the converted JSON to a different format.- Default value
- JSON
-
setMessageFormat
Description copied from class:ErrorMessageFormatter
Format the error message as XML or as JSON. ff.default XML- Overrides:
setMessageFormat
in classErrorMessageFormatter
-
addParameter
- Specified by:
addParameter
in interfaceIWithParameters
-
getParameterList
- Specified by:
getParameterList
in interfaceIWithParameters
-