Class IsXmlPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.IsXmlPipe

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")
@EnterpriseIntegrationPattern(ROUTER)
public class IsXmlPipe
extends AbstractPipe

Selects an exitState, based on whether the input is an XML string. The input is an XML string if it, after removing leading white-space characters, starts with '<'. The input message is also the output message.

Since:

4.3

Author:

Peter Leeuwenburgh

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

Method Summary

Modifier and Type	Method	Description
@NonNull PipeRunResult	doPipe(@NonNull Message message, @NonNull PipeLineSession session)	This is where the action takes place.
String	getElseForwardName()
String	getThenForwardName()
boolean	isElseForwardOnEmptyInput()
void	setElseForwardName(String elseForwardName)	Forward returned when 'false'.
void	setElseForwardOnEmptyInput(boolean b)	Returns elseforward when the input is empty (or thenforward).
void	setPreserveInput(boolean preserveInput)	If set true, the result of the pipe is replaced with the original input (i.e. the input before configured replacements of getInputFromSessionKey, getInputFromFixedValue or emptyInputReplacement)
void	setThenForwardName(String thenForwardName)	Forward returned when true.

Methods inherited from class AbstractPipe

addForward, addParameter, configure, createBean, findForward, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, 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

IsXmlPipe

public IsXmlPipe()

Method Details

doPipe

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

Throws:

PipeRunException

setThenForwardName

public void setThenForwardName(String thenForwardName)

Forward returned when true.

Default value

then

getThenForwardName

public String getThenForwardName()

setElseForwardName

public void setElseForwardName(String elseForwardName)

Forward returned when 'false'.

Default value

else

getElseForwardName

public String getElseForwardName()

isElseForwardOnEmptyInput

public boolean isElseForwardOnEmptyInput()

setElseForwardOnEmptyInput

public void setElseForwardOnEmptyInput(boolean b)

Returns elseforward when the input is empty (or thenforward).

Default value

true

setPreserveInput

public void setPreserveInput(boolean preserveInput)

If set true, the result of the pipe is replaced with the original input (i.e. the input before configured replacements of getInputFromSessionKey, getInputFromFixedValue or emptyInputReplacement)

Use this if you want to pass the original input message of this pipe to the branch, but want to select a branch based on a session-key value via IPipe.setGetInputFromSessionKey(String).

Specified by:

setPreserveInput in interface IPipe

Overrides:

setPreserveInput in class AbstractPipe