Package org.frankframework.senders

Class JsonXsltSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.senders.XsltSender

org.frankframework.senders.JsonXsltSender

All Implemented Interfaces:

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

public class JsonXsltSender
extends XsltSender

Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, yielding JSON, XML or text. JSON input is transformed into XML map, array, string, integer and boolean elements, in the namespace http://www.w3.org/2013/XSL/json. The XSLT stylesheet or XPathExpression operates on these element.

Author:

Gerrit van Brakel

See Also:

• https://www.xml.com/articles/2017/02/14/why-you-should-be-using-xslt-30/

Field Summary

Fields inherited from class org.frankframework.senders.XsltSender

DEFAULT_INDENT, DEFAULT_OMIT_XML_DECLARATION, DEFAULT_OUTPUT_METHOD, DEFAULT_XPATH_OUTPUT_METHOD, threadLifeCycleEventListener, txManager

Fields inherited from class org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
JsonXsltSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	The configure() method instantiates a transformer for the specified XSL.
protected ContentHandler	createHandler(Message input, ThreadConnector threadConnector, PipeLineSession session, TransformerPool poolToUse, ContentHandler handler, MessageBuilder messageBuilder)
IXmlDebugger	getXmlDebugger()
protected XMLReader	getXmlReader(PipeLineSession session, ContentHandler handler)
boolean	isJsonResult()
void	setJsonResult(boolean jsonResult)	When true, the xml result of the transformation is converted back to json
void	setNamespaceDefs(String namespaceDefs)	Namespace definitions for xpathExpression.
void	setXmlDebugger(IXmlDebugger xmlDebugger)

Methods inherited from class org.frankframework.senders.XsltSender

filterInput, getDisableOutputEscaping, getIndentXml, getNamespaceDefs, getOmitXmlDeclaration, getOutputType, getStreamingXslt, getStyleSheetName, getStyleSheetNameSessionKey, getTransformerPoolToUse, getXpathExpression, getXsltVersion, isDebugInput, isDisableOutputEscaping, isHandleLexicalEvents, isRemoveNamespaces, isSkipEmptyTags, sendMessage, setDebugInput, setDisableOutputEscaping, setHandleLexicalEvents, setIndentXml, setOmitXmlDeclaration, setOutputType, setRemoveNamespaces, setSkipEmptyTags, setStreamingXslt, setStyleSheetCacheSize, setStyleSheetName, setStyleSheetNameSessionKey, setThreadLifeCycleEventListener, setTxManager, setXpathExpression, setXsltVersion, start, stop

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

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

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getApplicationContext, getConfigurationClassLoader, 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.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

Constructor Details

JsonXsltSender

public JsonXsltSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: XsltSender

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 XsltSender

Throws:

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

createHandler

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

Overrides:

createHandler in class XsltSender

Throws:

TransformerException

getXmlReader

protected XMLReader getXmlReader(PipeLineSession session,
 ContentHandler handler)

Overrides:

getXmlReader in class XsltSender

setJsonResult

public void setJsonResult(boolean jsonResult)

When true, the xml result of the transformation is converted back to json

Default value

true

isJsonResult

public boolean isJsonResult()

setNamespaceDefs

public void setNamespaceDefs(String namespaceDefs)

Namespace definitions for xpathExpression. Must be in the form of a comma or space separated list of prefix=namespaceuri definitions

Overrides:

setNamespaceDefs in class XsltSender

Default value

j=http://www.w3.org/2013/XSL/json

getXmlDebugger

public IXmlDebugger getXmlDebugger()

setXmlDebugger

public void setXmlDebugger(IXmlDebugger xmlDebugger)