Package org.frankframework.errormessageformatters

Class XslErrorMessageFormatter

java.lang.Object

org.frankframework.errormessageformatters.ErrorMessageFormatter

org.frankframework.errormessageformatters.XslErrorMessageFormatter

All Implemented Interfaces:

IConfigurable, IErrorMessageFormatter, IScopeProvider, IWithParameters

public class XslErrorMessageFormatter
extends ErrorMessageFormatter
implements IWithParameters, IConfigurable

Applies an XSLT stylesheet to the standard error message generated by the ErrorMessageFormatter.

If the transformation does not succeed, this 'standard' error message is returned and an exception is logged.

Author:

Johan Verrips IOS

See Also:

• for general information on error message formatters.

Parameters

All parameters are added to the XSLT stylesheet. Parameter names must be unique.

Field Summary

Fields

Modifier and Type	Field	Description
protected ParameterList	paramList

Constructor Summary

Constructors

Constructor	Description
XslErrorMessageFormatter()

Method Summary

Modifier and Type	Method	Description
void	addParameter(IParameter p)
void	configure()	Configure this component.
Message	format(String errorMessage, Throwable t, HasName location, Message originalMessage, PipeLineSession session)	Format the available parameters into an XML or JSON message.
ParameterList	getParameterList()
void	setMessageFormat(DocumentFormat messageFormat)	Format the error message as XML or as JSON.
void	setStyleSheet(String newStyleSheet)	Deprecated. Use setStyleSheetName(String) instead
void	setStyleSheetName(String styleSheetName)	URL to the stylesheet used to transform the output of the standard ErrorMessageFormatter
void	setXpathExpression(String string)	xPathExpression to use for transformation

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

Field Details

paramList

@Nonnull
protected ParameterList paramList

Constructor Details

XslErrorMessageFormatter

public XslErrorMessageFormatter()

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

@Nonnull
public Message format(@Nullable
 String errorMessage,
 @Nullable
 Throwable t,
 @Nullable
 HasName location,
 @Nullable
 Message originalMessage,
 @Nonnull
 PipeLineSession session)

Description copied from class: ErrorMessageFormatter

Format the available parameters into an XML or JSON message.
Override this method in subclasses to obtain the required behaviour.

Specified by:

format in interface IErrorMessageFormatter

Overrides:

format 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

setStyleSheet

@Deprecated
@ConfigurationWarning("Use attribute [styleSheetName] instead")
public void setStyleSheet(String newStyleSheet)

Deprecated.

Use setStyleSheetName(String) instead

URL to the stylesheet used to transform the output of the standard ErrorMessageFormatter

setStyleSheetName

public void setStyleSheetName(String styleSheetName)

URL to the stylesheet used to transform the output of the standard ErrorMessageFormatter

setXpathExpression

public void setXpathExpression(String string)

xPathExpression to use for transformation

setMessageFormat

@Protected
public void setMessageFormat(@Nonnull
 DocumentFormat messageFormat)

Description copied from class: ErrorMessageFormatter

Format the error message as XML or as JSON.

Overrides:

setMessageFormat in class ErrorMessageFormatter