Package org.frankframework.senders

Class XsltSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.senders.XsltSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

JsonXsltSender

public class XsltSender
extends AbstractSenderWithParameters

Perform an XSLT transformation with a specified stylesheet or XPath-expression.

Since:

4.9

Author:

Gerrit van Brakel

Parameters

any parameters defined on the sender will be applied to the created transformer

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_INDENT
static final boolean	DEFAULT_OMIT_XML_DECLARATION
final TransformerPool.OutputType	DEFAULT_OUTPUT_METHOD
final TransformerPool.OutputType	DEFAULT_XPATH_OUTPUT_METHOD

Fields inherited from class org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
XsltSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	The configure() method instantiates a transformer for the specified XSL.
protected ContentHandler	createHandler(Message input, PipeLineSession session, TransformerPool poolToUse, ContentHandler handler, MessageBuilder messageBuilder)
protected ContentHandler	filterInput(ContentHandler input, PipeLineSession session)
protected TransformerPool	getTransformerPoolToUse(PipeLineSession session)
protected XMLReader	getXmlReader(PipeLineSession session, ContentHandler handler)
protected boolean	isDisableOutputEscaping(TransformerPool poolToUse)
SenderResult	sendMessage(Message message, PipeLineSession session)	alternative implementation of send message, that should do the same as the original, but reuses the streaming content handler
void	setDebugInput(boolean debugInput)	If true the input is written to the log file, at DEBUG level
void	setDisableOutputEscaping(Boolean b)	If true, any output is reparsed before being handled as XML again.
void	setHandleLexicalEvents(boolean b)	If true, the transformer is enabled to handle lexical events, allowing it for example to process comments and to distinghuish CDATA from escaped text.
void	setIndentXml(Boolean b)	If true, result is pretty-printed.
void	setNamespaceDefs(String namespaceDefs)	Namespace defintions for xpathExpression.
void	setOmitXmlDeclaration(Boolean b)	Omit the XML declaration on top of the output.
void	setOutputType(TransformerPool.OutputType string)	For xpathExpression only
void	setRemoveNamespaces(boolean b)	If true namespaces (and prefixes) in the input message are removed before transformation
void	setSkipEmptyTags(boolean b)	If true empty tags in the output are removed after transformation
void	setStyleSheetCacheSize(int size)	Size of cache of stylesheets retrieved from styleSheetNameSessionKey
void	setStyleSheetName(String stylesheetName)	Location of stylesheet to apply to the input message
void	setStyleSheetNameSessionKey(String newSessionKey)	Session key to retrieve stylesheet location.
void	setXpathExpression(String string)	Alternatively: XPath-expression to create stylesheet from
void	setXsltVersion(int xsltVersion)	If set to 2 or 3 a Saxon (net.sf.saxon) xslt processor 2.0 or 3.0 respectively will be used, otherwise xslt processor 1.0 (org.apache.xalan).
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.NameAware

setName

Field Details

DEFAULT_OUTPUT_METHOD

public final TransformerPool.OutputType DEFAULT_OUTPUT_METHOD

DEFAULT_XPATH_OUTPUT_METHOD

public final TransformerPool.OutputType DEFAULT_XPATH_OUTPUT_METHOD

DEFAULT_INDENT

public static final boolean DEFAULT_INDENT

See Also:

• Constant Field Values

DEFAULT_OMIT_XML_DECLARATION

public static final boolean DEFAULT_OMIT_XML_DECLARATION

See Also:

• Constant Field Values

Constructor Details

XsltSender

public XsltSender()

Method Details

configure

public void configure()
               throws ConfigurationException

The configure() method instantiates a transformer for the specified XSL. If the stylesheetName cannot be accessed, a ConfigurationException is thrown.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractSenderWithParameters

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractSender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractSender

filterInput

protected ContentHandler filterInput(ContentHandler input,
 PipeLineSession session)

isDisableOutputEscaping

protected boolean isDisableOutputEscaping(TransformerPool poolToUse)
                                   throws TransformerException,
IOException

Throws:

TransformerException

IOException

getTransformerPoolToUse

protected TransformerPool getTransformerPoolToUse(PipeLineSession session)
                                           throws SenderException,
ConfigurationException

Throws:

SenderException

ConfigurationException

createHandler

protected ContentHandler createHandler(Message input,
 PipeLineSession session,
 TransformerPool poolToUse,
 ContentHandler handler,
 MessageBuilder messageBuilder)
                                throws TransformerException

Throws:

TransformerException

getXmlReader

protected XMLReader getXmlReader(PipeLineSession session,
 ContentHandler handler)
                          throws ParserConfigurationException,
SAXException

Throws:

ParserConfigurationException

SAXException

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 PipeLineSession session)
                         throws SenderException

alternative implementation of send message, that should do the same as the original, but reuses the streaming content handler

Throws:

SenderException

setStyleSheetName

public void setStyleSheetName(String stylesheetName)

Location of stylesheet to apply to the input message

setStyleSheetNameSessionKey

public void setStyleSheetNameSessionKey(String newSessionKey)

Session key to retrieve stylesheet location. Overrides stylesheetName or xpathExpression attribute

setStyleSheetCacheSize

public void setStyleSheetCacheSize(int size)

Size of cache of stylesheets retrieved from styleSheetNameSessionKey

Default value

100

setXpathExpression

public void setXpathExpression(String string)

Alternatively: XPath-expression to create stylesheet from

setOmitXmlDeclaration

public void setOmitXmlDeclaration(Boolean b)

Omit the XML declaration on top of the output. If not set, the value specified in the stylesheet is followed

Default value

false, if not set in stylesheet

setDisableOutputEscaping

public void setDisableOutputEscaping(Boolean b)

If true, any output is reparsed before being handled as XML again. If not set, the stylesheet is searched for @disable-output-escaping='yes' and the value is set accordingly

Default value

false, if not set in stylesheet

setNamespaceDefs

public void setNamespaceDefs(String namespaceDefs)

Namespace defintions for xpathExpression. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions. For some other use cases (NOT xpathExpression), one entry can be without a prefix, that will define the default namespace. If left empty, the xpathExpression will match any namespace

setOutputType

public void setOutputType(TransformerPool.OutputType string)

For xpathExpression only

Default value

text

setIndentXml

public void setIndentXml(Boolean b)

If true, result is pretty-printed. If not set, the value specified in the stylesheet is followed

Default value

false, if not set in stylesheet

setRemoveNamespaces

public void setRemoveNamespaces(boolean b)

If true namespaces (and prefixes) in the input message are removed before transformation

Default value

false

setHandleLexicalEvents

public void setHandleLexicalEvents(boolean b)

If true, the transformer is enabled to handle lexical events, allowing it for example to process comments and to distinghuish CDATA from escaped text. Beware that this option can cause spurious NullPointerExceptions due to a race condition in streaming XSLT 1.0 processing in Xalan 2.7.2

Default value

false

setSkipEmptyTags

public void setSkipEmptyTags(boolean b)

If true empty tags in the output are removed after transformation

Default value

false

setXsltVersion

public void setXsltVersion(int xsltVersion)

If set to 2 or 3 a Saxon (net.sf.saxon) xslt processor 2.0 or 3.0 respectively will be used, otherwise xslt processor 1.0 (org.apache.xalan). 0 will auto-detect

Default value

0

setDebugInput

public void setDebugInput(boolean debugInput)

If true the input is written to the log file, at DEBUG level

Default value

false