nl.nn.adapterframework.pipes

Class XmlIf

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.XmlIf

All Implemented Interfaces:

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

@ElementType(value=ROUTER)
public class XmlIf
extends AbstractPipe

Selects an forward, based on XPath evaluation

Since:

4.3

Author:

Peter Leeuwenburgh

Field Summary

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
XmlIf()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called after the Pipeline is registered at the Adapter.
boolean	consumesSessionVariable(String sessionKey) returns true if the pipe or one of its children use the named session variable.
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
protected String	makeStylesheet(String xpathExpression, String resultVal)
void	setElseForwardName(String elseForwardName) forward returned when 'false'
void	setExpressionValue(String expressionValue) a string to compare the result of the xpathexpression (or the input-message itself) to.
void	setNamespaceAware(boolean b) controls namespace-awareness of XSLT transformation
void	setNamespaceDefs(String namespaceDefs) namespace defintions for xpathExpression.
void	setRegex(String regex) regular expression to be applied to the input-message (ignored if xpathexpression is specified).
void	setSessionKey(String sessionKey) Deprecated.
void	setThenForwardName(String thenForwardName) forward returned when 'true'
void	setXpathExpression(String string) xpath expression to be applied to the input-message.
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.pipes.AbstractPipe

addParameter, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, 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

XmlIf

public XmlIf()

Method Detail

makeStylesheet

protected String makeStylesheet(String xpathExpression,
                                String resultVal)

configure

public void configure()
               throws ConfigurationException

Description copied from class: AbstractPipe

configure() is called after the Pipeline is registered at the Adapter. Purpose of this method is to reduce creating connections to databases etc. in the doPipe() method. As much as possible class-instantiating should take place in the configure() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class AbstractPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message message,
                            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.

Throws:

PipeRunException

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: IPipe

returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface IPipe

Overrides:

consumesSessionVariable in class AbstractPipe

setSessionKey

@Deprecated
 @ConfigurationWarning(value="Please use getInputFromSessionKey instead.")
public void setSessionKey(String sessionKey)

Deprecated.

setExpressionValue

public void setExpressionValue(String expressionValue)

a string to compare the result of the xpathexpression (or the input-message itself) to. if not specified, a non-empty result leads to the 'then'-forward, an empty result to 'else'-forward

setThenForwardName

public void setThenForwardName(String thenForwardName)

forward returned when 'true'

Default value

then

setElseForwardName

public void setElseForwardName(String elseForwardName)

forward returned when 'false'

Default value

else

setXpathExpression

public void setXpathExpression(String string)

xpath expression to be applied to the input-message. if not set, no transformation is done

setRegex

public void setRegex(String regex)

regular expression to be applied to the input-message (ignored if xpathexpression is specified). the input-message matching the given regular expression leads to the 'then'-forward

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)

Default value

2

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.

setNamespaceAware

public void setNamespaceAware(boolean b)

controls namespace-awareness of XSLT transformation

Default value

true