Package org.frankframework.pipes

Class XmlFileElementIteratorPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.MessageSendingPipe

org.frankframework.pipes.IteratingPipe<String>

org.frankframework.pipes.XmlFileElementIteratorPipe

All Implemented Interfaces:

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

@Deprecated(forRemoval=true,
            since="7.6.0")
@ConfigurationWarning("Please replace with ForEachChildElementPipe. ElementName and elementChain can be replaced with containerElement and/or targetElement. It is not a 1 to 1 replacement, different values may be required!")
public class XmlFileElementIteratorPipe
extends IteratingPipe<String>

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

Please replace with ForEachChildElementPipe.

Sends a message to a Sender for each element in the XML file that the input message refers to.

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.pipes.IteratingPipe

IteratingPipe.ItemCallback, IteratingPipe.StopReason

Nested classes/interfaces inherited from class org.frankframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Field Summary

Fields inherited from class org.frankframework.pipes.IteratingPipe

MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, STOP_CONDITION_MET_FORWARD

Fields inherited from class org.frankframework.pipes.MessageSendingPipe

configurationMetrics, INPUT_VALIDATOR_NAME_PREFIX, INPUT_VALIDATOR_NAME_SUFFIX, INPUT_WRAPPER_NAME_PREFIX, INPUT_WRAPPER_NAME_SUFFIX, MAX_RETRY_INTERVAL, MESSAGE_LOG_NAME_PREFIX, MESSAGE_LOG_NAME_SUFFIX, MIN_RETRY_INTERVAL, msgLog, OUTPUT_VALIDATOR_NAME_PREFIX, OUTPUT_VALIDATOR_NAME_SUFFIX, OUTPUT_WRAPPER_NAME_PREFIX, OUTPUT_WRAPPER_NAME_SUFFIX, PIPE_CLEAR_TIMEOUT_MONITOR_EVENT, PIPE_EXCEPTION_MONITOR_EVENT, PIPE_TIMEOUT_MONITOR_EVENT

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Deprecated, for removal: This API element is subject to removal in a future version. checks for correct configuration of forward
String	getElementChain()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getElementName()	Deprecated, for removal: This API element is subject to removal in a future version.
protected IteratingPipe.StopReason	iterateOverInput(Message input, PipeLineSession session, Map<String,Object> threadContext, IteratingPipe<String>.ItemCallback callback)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setElementChain(String string)	Deprecated, for removal: This API element is subject to removal in a future version. the name of the element to iterate over, preceded with all ancestor elements and separated by semicolons (e.g. adapter;pipeline;pipe)
void	setElementName(String string)	Deprecated, for removal: This API element is subject to removal in a future version. the name of the element to iterate over (alternatively: elementChain)

Methods inherited from class org.frankframework.pipes.IteratingPipe

createItemCallBack, getBlockSize, getItem, getItemNoSessionKey, getIterator, getMaxChildThreads, getMaxItems, getNamespaceDefs, getOutputType, getStatisticsKeeper, getStopConditionTp, getStopConditionXPathExpression, getStyleSheetName, getTaskExecutor, getXpathExpression, isAddInputToResult, isCloseIteratorOnExit, isCollectResults, isIgnoreExceptions, isOmitXmlDeclaration, isParallel, isRemoveDuplicates, isRemoveXmlDeclarationInResults, itemToMessage, sendMessage, setAddInputToResult, setBlockSize, setCloseIteratorOnExit, setCollectResults, setIgnoreExceptions, setItemNoSessionKey, setMaxChildThreads, setMaxItems, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setParallel, setRemoveDuplicates, setRemoveXmlDeclarationInResults, setSender, setStopConditionXPathExpression, setStyleSheetName, setTaskExecutor, setXpathExpression

Methods inherited from class org.frankframework.pipes.MessageSendingPipe

consumesSessionVariable, doLogToMessageLog, doPipe, getCheckRootTag, getConfigurationMetrics, getExceptionOnResult, getHideMethod, getInputValidator, getInputWrapper, getLinkMethod, getMaxRetries, getMessageLog, getOutputValidator, getOutputWrapper, getPresumedTimeOutInterval, getResultOnTimeOut, getRetryMaxInterval, getRetryMinInterval, getRetryNamespaceDefs, getRetryXPath, getSender, getStubFilename, getTimeoutOnResult, increaseRetryIntervalAndWait, isCheckXmlWellFormed, postSendAction, preserve, propagateName, sendMessageWithRetries, setCheckRootTag, setCheckXmlWellFormed, setConfigurationMetrics, setExceptionOnResult, setHideMethod, setHideRegex, setInputValidator, setInputWrapper, setLinkMethod, setMaxRetries, setMessageLog, setName, setOutputValidator, setOutputWrapper, setPipeProcessor, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStubFilename, setTimeoutOnResult, setTimeOutOnResult, sizeStatisticsEnabled, start, stop, storeMessage

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setLocker, setLogIntermediaryResults, setMaxThreads, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.INamedObject

getName

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Constructor Details

XmlFileElementIteratorPipe

public XmlFileElementIteratorPipe()

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

Method Details

configure

public void configure()
               throws ConfigurationException

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

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class IteratingPipe<String>

Throws:

ConfigurationException

iterateOverInput

protected IteratingPipe.StopReason iterateOverInput(Message input,
 PipeLineSession session,
 Map<String,Object> threadContext,
 IteratingPipe<String>.ItemCallback callback)
                                             throws SenderException,
TimeoutException

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

Overrides:

iterateOverInput in class IteratingPipe<String>

Throws:

SenderException

TimeoutException

setElementName

public void setElementName(String string)

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

the name of the element to iterate over (alternatively: elementChain)

getElementName

public String getElementName()

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

setElementChain

public void setElementChain(String string)

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

the name of the element to iterate over, preceded with all ancestor elements and separated by semicolons (e.g. adapter;pipeline;pipe)

getElementChain

public String getElementChain()

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