Package org.frankframework.pipes

Class StreamLineIteratorPipe

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

org.frankframework.pipes.StreamLineIteratorPipe

All Implemented Interfaces:

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

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

Method Summary

Modifier and Type	Method	Description
String	getEndOfLineString()
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)
String	getStartOfLineString()
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 org.frankframework.pipes.StringIteratorPipe

configure, createItemCallBack, getBlockPrefix, getBlockSuffix, getEndPosition, getKey, getLinePrefix, getLineSuffix, getStartPosition, getStringIteratorPipeBlockSize, isCombineBlocks, isEscapeXml, setBlockPrefix, setBlockSize, setBlockSuffix, setCombineBlocks, setEndPosition, setEscapeXml, setLinePrefix, setLineSuffix, setStartPosition

Methods inherited from class org.frankframework.pipes.IteratingPipe

getBlockSize, getItemNoSessionKey, getMaxChildThreads, getMaxItems, getNamespaceDefs, getOutputType, getStatisticsKeeper, getStopConditionTp, getStopConditionXPathExpression, getStyleSheetName, getTaskExecutor, getXpathExpression, isAddInputToResult, isCloseIteratorOnExit, isCollectResults, isIgnoreExceptions, isOmitXmlDeclaration, isParallel, isRemoveDuplicates, isRemoveXmlDeclarationInResults, itemToMessage, iterateOverInput, sendMessage, setAddInputToResult, 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, isRunning, 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.IPipe

throwEvent

Constructor Details

StreamLineIteratorPipe

public StreamLineIteratorPipe()

Method Details

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

getEndOfLineString

public String getEndOfLineString()

getStartOfLineString

public String getStartOfLineString()