Class XmlIf

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.IfPipe

org.frankframework.pipes.XmlIf

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Forward(name="*",description="when {@literal thenForwardName} or {@literal elseForwardName} are used") @Forward(name="then",description="the configured condition is met") @Forward(name="else",description="the configured condition is not met")
@EnterpriseIntegrationPattern(ROUTER)
@Deprecated(since="9.0.0",
            forRemoval=true)
public class XmlIf
extends IfPipe

Deprecated, for removal: This API element is subject to removal in a future version.

please use the IfPipe for if (else/then) behaviour. If you need regular expressions, see the RegExPipe as well.

Selects a forward, based on XPath evaluation

Since:

4.3

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested classes/interfaces inherited from class IfPipe

IfPipe.SupportedMediaType

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
XmlIf()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
@NonNull PipeRunResult	doPipe(Message message, PipeLineSession session)	Deprecated, for removal: This API element is subject to removal in a future version. This is where the action takes place.
void	setJsonPathExpression(String jsonPathExpression)	Deprecated, for removal: This API element is subject to removal in a future version. Hide this method since it should not be able to set this from within this Pipe
void	setRegex(String regex)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class IfPipe

configure, setDefaultMediaType, setElseForwardName, setExpressionValue, setNamespaceAware, setNamespaceDefs, setThenForwardName, setXpathExpression, setXsltVersion

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

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

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

XmlIf

public XmlIf()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

doPipe

public @NonNull PipeRunResult doPipe(Message message,
 PipeLineSession session)
                              throws PipeRunException

Deprecated, for removal: This API element is subject to removal in a future version.

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.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class IfPipe

Throws:

PipeRunException

setRegex

@Deprecated(forRemoval=true,
            since="9.0")
@ConfigurationWarning("Please use the RegExPipe instead")
public void setRegex(String regex)

Deprecated, for removal: This API element is subject to removal in a future version.

Regular expression to be applied to the input-message (ignored if either xpathExpression or jsonPathExpression is specified). The input-message fully matching the given regular expression leads to the 'then'-forward

setJsonPathExpression

@Protected
public void setJsonPathExpression(String jsonPathExpression)

Deprecated, for removal: This API element is subject to removal in a future version.

Hide this method since it should not be able to set this from within this Pipe

Overrides:

setJsonPathExpression in class IfPipe