nl.nn.adapterframework.pipes

Class XsltPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.XsltPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

CreateRestViewPipe, JsonXsltPipe

@Category(value="Basic")
 @SupportsOutputStreaming
 @ElementType(value=TRANSLATOR)
public class XsltPipe
extends StreamingPipe
implements org.springframework.beans.factory.InitializingBean

Perform an XSLT transformation with a specified stylesheet.

Author:

Johan Verrips

Parameters

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

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
XsltPipe()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter rhs) Add a parameter to the list of parameters
void	afterPropertiesSet()
protected boolean	canProvideOutputStream() returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
boolean	canStreamToNextPipe() called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method.
void	configure() The configure() method instantiates a transformer for the specified XSL.
protected XsltSender	createXsltSender()
PipeRunResult	doPipe(Message input, PipeLineSession session) This is where the action takes place.
String	getNamespaceDefs()
ParameterList	getParameterList() return the Parameters
String	getSessionKey() Deprecated.
String	getXpathExpression()
protected MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
void	setDisableOutputEscaping(boolean b)
void	setHandleLexicalEvents(boolean b)
void	setIndentXml(boolean b)
void	setName(String name) The functional name of this pipe.
void	setNamespaceAware(boolean b) Deprecated.
void	setNamespaceDefs(String namespaceDefs)
void	setOmitXmlDeclaration(boolean b)
void	setOutputType(TransformerPool.OutputType outputType)
void	setRemoveNamespaces(boolean b)
void	setSessionKey(String newSessionKey) Deprecated.
void	setSkipEmptyTags(boolean b)
void	setStreamingXslt(boolean streamingActive) If true, then this pipe will process the XSLT while streaming in a different thread.
void	setStyleSheetCacheSize(int size)
void	setStyleSheetName(String stylesheetName)
void	setStyleSheetNameSessionKey(String newSessionKey)
void	setXpathExpression(String string)
void	setXslt2(boolean b) Deprecated.
void	setXsltVersion(int xsltVersion)
void	start() Perform necessary action to start the pipe.
void	stop() Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.
boolean	supportsOutputStreamPassThrough() Implementations should return true when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.

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

getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

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.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

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

getMaxThreads

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

getName

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 nl.nn.adapterframework.core.IForwardTarget

getName

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

XsltPipe

public XsltPipe()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

createXsltSender

protected XsltSender createXsltSender()

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 IPipe

Overrides:

configure in class StreamingPipe

Throws:

ConfigurationException

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Overrides:

start in class AbstractPipe

Throws:

PipeStartException

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Overrides:

stop in class AbstractPipe

canStreamToNextPipe

public boolean canStreamToNextPipe()

Description copied from class: StreamingPipe

called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method. All side effects that are handled by PipeProcessors (storeResultInSessionKey, preserveInput) and move and chop actions (restoreMovedElements, elementToMove, chompCharSize, ElementToMoveChain) inhibit streaming to the next pipe.

Overrides:

canStreamToNextPipe in class StreamingPipe

canProvideOutputStream

protected boolean canProvideOutputStream()

Description copied from class: StreamingPipe

returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)

Overrides:

canProvideOutputStream in class StreamingPipe

doPipe

public PipeRunResult doPipe(Message input,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Throws:

PipeRunException

supportsOutputStreamPassThrough

public boolean supportsOutputStreamPassThrough()

Description copied from interface: IOutputStreamingSupport

Implementations should return true when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.

Specified by:

supportsOutputStreamPassThrough in interface IOutputStreamingSupport

Overrides:

supportsOutputStreamPassThrough in class StreamingPipe

setStreamingXslt

public void setStreamingXslt(boolean streamingActive)

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

Default value

set by appconstant xslt.streaming.default

provideOutputStream

protected MessageOutputStream provideOutputStream(PipeLineSession session)
                                           throws StreamingException

Description copied from class: StreamingPipe

provide the outputstream, or null if a stream cannot be provided. Implementations should provide a forward target by calling StreamingPipe.getNextPipe().

Overrides:

provideOutputStream in class StreamingPipe

Throws:

StreamingException

getParameterList

public ParameterList getParameterList()

Description copied from class: AbstractPipe

return the Parameters

Overrides:

getParameterList in class AbstractPipe

addParameter

public void addParameter(Parameter rhs)

Description copied from class: AbstractPipe

Add a parameter to the list of parameters

Overrides:

addParameter in class AbstractPipe

setStyleSheetName

@ReferTo(value=XsltSender.class)
public void setStyleSheetName(String stylesheetName)

setStyleSheetNameSessionKey

@ReferTo(value=XsltSender.class)
public void setStyleSheetNameSessionKey(String newSessionKey)

setStyleSheetCacheSize

@ReferTo(value=XsltSender.class)
public void setStyleSheetCacheSize(int size)

setXpathExpression

@ReferTo(value=XsltSender.class)
public void setXpathExpression(String string)

getXpathExpression

public String getXpathExpression()

setOmitXmlDeclaration

@ReferTo(value=XsltSender.class)
public void setOmitXmlDeclaration(boolean b)

setDisableOutputEscaping

@ReferTo(value=XsltSender.class)
public void setDisableOutputEscaping(boolean b)

setNamespaceDefs

@ReferTo(value=XsltSender.class)
public void setNamespaceDefs(String namespaceDefs)

getNamespaceDefs

public String getNamespaceDefs()

setOutputType

@ReferTo(value=XsltSender.class)
public void setOutputType(TransformerPool.OutputType outputType)

setIndentXml

@ReferTo(value=XsltSender.class)
public void setIndentXml(boolean b)

setRemoveNamespaces

@ReferTo(value=XsltSender.class)
public void setRemoveNamespaces(boolean b)

setHandleLexicalEvents

@ReferTo(value=XsltSender.class)
public void setHandleLexicalEvents(boolean b)

setSkipEmptyTags

@ReferTo(value=XsltSender.class)
public void setSkipEmptyTags(boolean b)

setXsltVersion

@ReferTo(value=XsltSender.class)
public void setXsltVersion(int xsltVersion)

setXslt2

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

Deprecated.

setNamespaceAware

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

Deprecated.

setSessionKey

@Deprecated
 @ConfigurationWarning(value="Please use \'storeResultInSessionKey\' with preserveInput=true")
public void setSessionKey(String newSessionKey)

Deprecated.

getSessionKey

@Deprecated
public String getSessionKey()

Deprecated.

setName

public void setName(String name)

Description copied from class: AbstractPipe

The functional name of this pipe. Can be referenced by the path attribute of a PipeForward.

Specified by:

setName in interface INamedObject

Overrides:

setName in class AbstractPipe