nl.nn.adapterframework.pipes

Class StreamLineIteratorPipe

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<String>

nl.nn.adapterframework.pipes.StringIteratorPipe

nl.nn.adapterframework.pipes.StreamLineIteratorPipe

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:

FileLineIteratorPipe

public class StreamLineIteratorPipe
extends StringIteratorPipe

Sends a message to a Sender for each line of its input, that must be an InputStream.

Since:

4.7

Author:

Gerrit van Brakel

Nested Class Summary

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

IteratingPipe.ItemCallback, 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 inherited from class nl.nn.adapterframework.pipes.IteratingPipe

MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, 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
StreamLineIteratorPipe()

Method Summary

Modifier and Type	Method and Description
protected String	getItem(IDataIterator<String> it)
protected IDataIterator<String>	getIterator(Message input, PipeLineSession session, Map<String,Object> threadContext)
protected Reader	getReader(Message input, PipeLineSession session, Map<String,Object> threadContext)
void	setCloseInputstreamOnExit(boolean b) If set to false, the inputstream is not closed after it has been used
void	setEndOfLineString(String string) If set, each record has to end with this string.
void	setStartOfLineString(String string) Marks the start of a new record.

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

configure, createItemCallBack, getKey, setBlockPrefix, setBlockSize, setBlockSuffix, setCombineBlocks, setEndPosition, setEscapeXml, setLinePrefix, setLineSuffix, setStartPosition

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

canStreamToNextPipe, getStopConditionTp, itemToMessage, iterateOverInput, iterateOverStatistics, provideOutputStream, sendMessage, setAddInputToResult, setCloseIteratorOnExit, setCollectResults, setIgnoreExceptions, setItemNoSessionKey, setMaxChildThreads, setMaxItems, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setParallel, setRemoveDuplicates, setRemoveXmlDeclarationInResults, setSender, setStopConditionXPathExpression, setStyleSheetName, setXpathExpression

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

Constructor Detail

StreamLineIteratorPipe

public StreamLineIteratorPipe()

Method Detail

getReader

protected Reader getReader(Message input,
                           PipeLineSession session,
                           Map<String,Object> threadContext)
                    throws SenderException

Throws:

SenderException

getIterator

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

Overrides:

getIterator in class IteratingPipe<String>

Throws:

SenderException

getItem

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

Overrides:

getItem in class IteratingPipe<String>

Throws:

SenderException

setEndOfLineString

public void setEndOfLineString(String string)

If set, each record has to end with this string. If a line read doesn't end with this string more lines are added (including line separators) until the total record ends with the given string

setStartOfLineString

public void setStartOfLineString(String string)

Marks the start of a new record. If set, a new record is started when this line is read.

setCloseInputstreamOnExit

public void setCloseInputstreamOnExit(boolean b)

If set to false, the inputstream is not closed after it has been used

Default value

true