nl.nn.adapterframework.senders

Class XsltSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.stream.StreamingSenderBase

nl.nn.adapterframework.senders.XsltSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IOutputStreamingSupport, IStreamingSender, IThreadCreator, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JsonXsltSender

@SupportsOutputStreaming
public class XsltSender
extends StreamingSenderBase
implements IThreadCreator

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 and Description
boolean	DEFAULT_INDENT
boolean	DEFAULT_OMIT_XML_DECLARATION
TransformerPool.OutputType	DEFAULT_OUTPUT_METHOD
TransformerPool.OutputType	DEFAULT_XPATH_OUTPUT_METHOD
protected ThreadLifeCycleEventListener<Object>	threadLifeCycleEventListener
protected IThreadConnectableTransactionManager	txManager

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
XsltSender()

Method Summary

Modifier and Type	Method and Description
void	close() Stop/close the sender and deallocate resources.
void	configure() The configure() method instantiates a transformer for the specified XSL.
protected ContentHandler	createHandler(Message input, ThreadConnector threadConnector, PipeLineSession session, TransformerPool poolToUse, MessageOutputStream target)
protected ContentHandler	filterInput(ContentHandler input, PipeLineSession session)
protected TransformerPool	getTransformerPoolToUse(PipeLineSession session)
protected XMLReader	getXmlReader(PipeLineSession session, ContentHandler handler, BiConsumer<AutoCloseable,String> closeOnCloseRegister)
protected boolean	isDisableOutputEscaping(TransformerPool poolToUse)
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
void	open() This method will be called to start the sender.
MessageOutputStream	provideOutputStream(PipeLineSession session, IForwardTarget next) return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way.
PipeRunResult	sendMessage(Message message, PipeLineSession session, IForwardTarget next)
void	setDebugInput(boolean debugInput) If set true the input is written to the log file, at DEBUG level
void	setDisableOutputEscaping(Boolean b) If set true, any output is reparsed before being handled as XML again.
void	setHandleLexicalEvents(boolean b) If set 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 set true, result is pretty-printed.
void	setNamespaceAware(boolean b) Deprecated.
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 set true namespaces (and prefixes) in the input message are removed before transformation
void	setSkipEmptyTags(boolean b) If set true empty tags in the output are removed after transformation
void	setStreamingXslt(Boolean streamingActive) If true, then this sender will process the XSLT while streaming in a different thread.
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	setXslt2(boolean b) Deprecated. Please remove setting of xslt2, it will be auto detected. Or use xsltVersion.
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).

Methods inherited from class nl.nn.adapterframework.stream.StreamingSenderBase

canProvideOutputStream, sendMessage, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

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

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

createBean, getLogPrefix, getName, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.stream.IThreadCreator

setThreadLifeCycleEventListener

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IWithParameters

addParameter, getParameterList

Field Detail

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 final boolean DEFAULT_INDENT

See Also:

Constant Field Values

DEFAULT_OMIT_XML_DECLARATION

public final boolean DEFAULT_OMIT_XML_DECLARATION

See Also:

Constant Field Values

threadLifeCycleEventListener

protected ThreadLifeCycleEventListener<Object> threadLifeCycleEventListener

txManager

protected IThreadConnectableTransactionManager txManager

Constructor Detail

XsltSender

public XsltSender()

Method Detail

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

Specified by:

configure in interface ISender

Overrides:

configure in class StreamingSenderBase

Throws:

ConfigurationException

open

public void open()
          throws SenderException

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:

open in interface ISender

Overrides:

open in class SenderBase

Throws:

SenderException

close

public void close()
           throws SenderException

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderBase

Throws:

SenderException

filterInput

protected ContentHandler filterInput(ContentHandler input,
                                     PipeLineSession session)

provideOutputStream

public MessageOutputStream provideOutputStream(PipeLineSession session,
                                               IForwardTarget next)
                                        throws StreamingException

Description copied from interface: IOutputStreamingSupport

return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way. If a target MessageOutputStream is required to stream output to, this can be obtained from next, if specified. If the implementor of this method is a pipe, and it is the last one in the chain of streaming pipes, it must provide the appropriate forward in the provide MessageOutputStream. If the class cannot provide an outputstream, it must return null. If the provider of an outputstream is a pipe itself, it must provide a proper pipeforward in the provided outputstream

Specified by:

provideOutputStream in interface IOutputStreamingSupport

Throws:

StreamingException

isDisableOutputEscaping

protected boolean isDisableOutputEscaping(TransformerPool poolToUse)
                                   throws TransformerException,
                                          IOException,
                                          SAXException

Throws:

TransformerException

IOException

SAXException

getTransformerPoolToUse

protected TransformerPool getTransformerPoolToUse(PipeLineSession session)
                                           throws SenderException,
                                                  IOException,
                                                  ConfigurationException

Throws:

SenderException

IOException

ConfigurationException

createHandler

protected ContentHandler createHandler(Message input,
                                       ThreadConnector threadConnector,
                                       PipeLineSession session,
                                       TransformerPool poolToUse,
                                       MessageOutputStream target)
                                throws StreamingException

Throws:

StreamingException

getXmlReader

protected XMLReader getXmlReader(PipeLineSession session,
                                 ContentHandler handler,
                                 BiConsumer<AutoCloseable,String> closeOnCloseRegister)
                          throws ParserConfigurationException,
                                 SAXException

Throws:

ParserConfigurationException

SAXException

sendMessage

public PipeRunResult sendMessage(Message message,
                                 PipeLineSession session,
                                 IForwardTarget next)
                          throws SenderException

Specified by:

sendMessage in interface IStreamingSender

Throws:

SenderException

setStreamingXslt

public void setStreamingXslt(Boolean streamingActive)

If true, then this sender will process the XSLT while streaming in a different thread. Can be used to switch streaming off for debugging purposes

Default value

set by appconstant xslt.streaming.default

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

Overrides:

isSynchronous in class SenderBase

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 set 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, an 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 set true, result is pretty-printed. If not set, the value specified in the stylesheet is followed

Default value

false, if not set in stylesheet

setNamespaceAware

@Deprecated
 @ConfigurationWarning(value="please use attribute \'removeNamespaces\' instead")
public void setNamespaceAware(boolean b)

Deprecated.

setRemoveNamespaces

public void setRemoveNamespaces(boolean b)

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

Default value

false

setHandleLexicalEvents

public void setHandleLexicalEvents(boolean b)

If set 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 set 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 set true the input is written to the log file, at DEBUG level

Default value

false

setXslt2

@Deprecated
 @ConfigurationWarning(value="It\'s value is now auto detected. If necessary, replace with a setting of xsltVersion")
public void setXslt2(boolean b)

Deprecated. Please remove setting of xslt2, it will be auto detected. Or use xsltVersion.