nl.nn.adapterframework.pipes

Class IteratingPipe<I>

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.MessageSendingPipe

nl.nn.adapterframework.pipes.IteratingPipe<I>

All Implemented Interfaces:

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

Direct Known Subclasses:

ForEachAttachmentPipe, StringIteratorPipe, XmlFileElementIteratorPipe, ZipIteratorPipe

@ElementType(value=ITERATOR)
public abstract class IteratingPipe<I>
extends MessageSendingPipe

Abstract base class to sends a message to a Sender for each item returned by a configurable iterator.
The output of each of the processing of each of the elements is returned in XML as follows:

  <results count="num_of_elements">
    <result>result of processing of first item</result>
    <result>result of processing of second item</result>
       ...
  </results>
 

For more configuration options, see MessageSendingPipe.
use parameters like:

        <param name="element-name-of-current-item"  xpathExpression="name(/*)" />
        <param name="value-of-current-item"         xpathExpression="/*" />
 

Since:

4.7

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IteratingPipe.ItemCallback
protected static class	IteratingPipe.StopReason

Nested classes/interfaces inherited from class nl.nn.adapterframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MAX_ITEMS_REACHED_FORWARD
protected TransformerPool	msgTransformerPool
protected static String	STOP_CONDITION_MET_FORWARD

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

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

Method Summary

Modifier and Type	Method and Description
protected 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() checks for correct configuration of forward
protected IteratingPipe.ItemCallback	createItemCallBack(PipeLineSession session, ISender sender, Writer out)
protected I	getItem(IDataIterator<I> it)
protected IDataIterator<I>	getIterator(Message input, PipeLineSession session, Map<String,Object> threadContext)
protected TransformerPool	getStopConditionTp()
protected Message	itemToMessage(I item)
protected IteratingPipe.StopReason	iterateOverInput(Message input, PipeLineSession session, Map<String,Object> threadContext, IteratingPipe.ItemCallback callback)
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
protected MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
protected PipeRunResult	sendMessage(Message input, PipeLineSession session, ISender sender, Map<String,Object> threadContext)
void	setAddInputToResult(boolean b) When true the input is added to the result in an input element
void	setBlockSize(int i) Controls multiline behaviour.
protected void	setCloseIteratorOnExit(boolean b)
void	setCollectResults(boolean b) Controls whether all the results of each iteration will be collected in one result message.
void	setIgnoreExceptions(boolean b) When true ignore any exception thrown by executing sender
void	setItemNoSessionKey(String string) Key of session variable to store number of items processed, i.e.
void	setMaxChildThreads(int maxChildThreads) Maximum number of child threads that may run in parallel simultaneously (combined total of all threads calling this pipe).
void	setMaxItems(int maxItems) The maximum number of items returned.
void	setNamespaceDefs(String namespaceDefs) Namespace defintions for xpathExpression.
void	setOmitXmlDeclaration(boolean b) Force the transformer generated from the xpath-expression to omit the xml declaration
void	setOutputType(TransformerPool.OutputType outputType) Only valid for xpathexpression
void	setParallel(boolean parallel) When set true, the calls for all items are done in parallel (a new thread is started for each call).
void	setRemoveDuplicates(boolean b) When true duplicate input elements are removed, i.e.
void	setRemoveXmlDeclarationInResults(boolean b) Postprocess each partial result, to remove the xml-declaration, as this is not allowed inside an xml-document
void	setSender(ISender sender) The sender that should send the message
void	setStopConditionXPathExpression(String string) Expression evaluated on each result and forwards to ["stopConditionMet"] forward if configured.
void	setStyleSheetName(String stylesheetName) Stylesheet to apply to each message, before sending it
void	setXpathExpression(String string) Alternatively: xpath-expression to create stylesheet from

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

canProvideOutputStream, consumesSessionVariable, doPipe, hasSizeStatistics, increaseRetryIntervalAndWait, preserve, propagateName, setAuditTrailNamespaceDefs, setAuditTrailSessionKey, setAuditTrailXPath, setCheckRootTag, setCheckXmlWellFormed, setCorrelationIDNamespaceDefs, setCorrelationIDSessionKey, setCorrelationIDStyleSheet, setCorrelationIDXPath, setExceptionOnResult, setHideMethod, setHideRegex, setInputValidator, setInputWrapper, setLabelNamespaceDefs, setLabelStyleSheet, setLabelXPath, setLinkMethod, setListener, setMaxRetries, setMessageLog, setName, setOutputValidator, setOutputWrapper, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStreamResultToServlet, setStubFilename, setStubFileName, setTimeOutOnResult, setUseInputForExtract, start, stop, supportsOutputStreamPassThrough

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

addParameter, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, 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.HasSender

getSender

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

getName

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

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

getMaxThreads

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

Field Detail

MAX_ITEMS_REACHED_FORWARD

protected static final String MAX_ITEMS_REACHED_FORWARD

See Also:

Constant Field Values

STOP_CONDITION_MET_FORWARD

protected static final String STOP_CONDITION_MET_FORWARD

See Also:

Constant Field Values

msgTransformerPool

protected TransformerPool msgTransformerPool

Constructor Detail

IteratingPipe

public IteratingPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

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 MessageSendingPipe

Throws:

ConfigurationException

getIterator

protected IDataIterator<I> getIterator(Message input,
                                       PipeLineSession session,
                                       Map<String,Object> threadContext)
                                throws SenderException

Throws:

SenderException

createItemCallBack

protected IteratingPipe.ItemCallback createItemCallBack(PipeLineSession session,
                                                        ISender sender,
                                                        Writer out)

itemToMessage

protected Message itemToMessage(I item)
                         throws SenderException

Throws:

SenderException

iterateOverInput

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

Throws:

SenderException

TimeoutException

IOException

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 MessageSendingPipe

Throws:

StreamingException

canStreamToNextPipe

protected 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 MessageSendingPipe

sendMessage

protected PipeRunResult sendMessage(Message input,
                                    PipeLineSession session,
                                    ISender sender,
                                    Map<String,Object> threadContext)
                             throws SenderException,
                                    TimeoutException,
                                    IOException

Overrides:

sendMessage in class MessageSendingPipe

Throws:

SenderException

TimeoutException

IOException

getItem

protected I getItem(IDataIterator<I> it)
             throws SenderException

Throws:

SenderException

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Overrides:

iterateOverStatistics in class MessageSendingPipe

Throws:

SenderException

setSender

public void setSender(ISender sender)

Description copied from class: MessageSendingPipe

The sender that should send the message

Overrides:

setSender in class MessageSendingPipe

getStopConditionTp

protected TransformerPool getStopConditionTp()

setStyleSheetName

public void setStyleSheetName(String stylesheetName)

Stylesheet to apply to each message, before sending it

setXpathExpression

public void setXpathExpression(String string)

Alternatively: xpath-expression to create stylesheet from

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. For some use other cases (NOT xpathExpression), one entry can be without a prefix, that will define the default namespace.

setOutputType

public void setOutputType(TransformerPool.OutputType outputType)

Only valid for xpathexpression

Default value

text

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean b)

Force the transformer generated from the xpath-expression to omit the xml declaration

Default value

true

setItemNoSessionKey

public void setItemNoSessionKey(String string)

Key of session variable to store number of items processed, i.e. the position or index in the set of items to be processed. When handling the first item, the value will be 1.

setMaxItems

public void setMaxItems(int maxItems)

The maximum number of items returned. The (default) value of 0 means unlimited, all available items will be returned. Special forward "maxItemsReached" can be configured to follow

Default value

0

setStopConditionXPathExpression

public void setStopConditionXPathExpression(String string)

Expression evaluated on each result and forwards to ["stopConditionMet"] forward if configured. Iteration stops if condition returns anything other than an empty result. To test for the root element to have an attribute 'finished' with the value 'yes', the expression *[@finished='yes'] can be used. This can be used if the condition to stop can be derived from the item result. To stop after a maximum number of items has been processed, use maxItems. Previous versions documented that position()=2 could be used. This is not working as expected; Use maxItems instead

setIgnoreExceptions

public void setIgnoreExceptions(boolean b)

When true ignore any exception thrown by executing sender

Default value

false

setCollectResults

public void setCollectResults(boolean b)

Controls whether all the results of each iteration will be collected in one result message. If set false, only a small summary is returned. Setting this attributes to false is often required to enable processing of very large files. N.B. Remember in such a case that setting transactionAttribute to NotSupported might be necessary too

Default value

true

setRemoveXmlDeclarationInResults

public void setRemoveXmlDeclarationInResults(boolean b)

Postprocess each partial result, to remove the xml-declaration, as this is not allowed inside an xml-document

Default value

false

setAddInputToResult

public void setAddInputToResult(boolean b)

When true the input is added to the result in an input element

Default value

false

setRemoveDuplicates

public void setRemoveDuplicates(boolean b)

When true duplicate input elements are removed, i.e. they are handled only once

Default value

false

setCloseIteratorOnExit

protected void setCloseIteratorOnExit(boolean b)

setParallel

public void setParallel(boolean parallel)

When set true, the calls for all items are done in parallel (a new thread is started for each call). when collectresults set true, this pipe will wait for all calls to finish before results are collected and pipe result is returned

Default value

false

setMaxChildThreads

public void setMaxChildThreads(int maxChildThreads)

Maximum number of child threads that may run in parallel simultaneously (combined total of all threads calling this pipe). Use 0 for unlimited threads

Default value

0

setBlockSize

public void setBlockSize(int i)

Controls multiline behaviour. When set to a value greater than 0, it specifies the number of rows send, in a one block, to the sender.

Default value

0