Package org.frankframework.pipes

Class FileLineIteratorPipe

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

org.frankframework.pipes.FileLineIteratorPipe

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.8.0")
@ConfigurationWarning("Please use StreamLineIteratorPipe")
public class FileLineIteratorPipe
extends StreamLineIteratorPipe

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

Sends a message to a Sender for each line of the file that the input message refers to.

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
FileLineIteratorPipe()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipe(Message input, PipeLineSession session)	Deprecated, for removal: This API element is subject to removal in a future version. Open a reader for the file named according the input messsage and transform it.
String	getCharset()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getMove2dirAfterError()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getMove2dirAfterTransform()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setCharset(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Default charset attribute
void	setMove2dirAfterError(String errorDir)	Deprecated, for removal: This API element is subject to removal in a future version. Directory where input file is moved to in case an error occurred
void	setMove2dirAfterTransform(String readyDir)	Deprecated, for removal: This API element is subject to removal in a future version. Directory where input file is moved to in case of a successful transformation

Methods inherited from class org.frankframework.pipes.StreamLineIteratorPipe

getEndOfLineString, getItem, getIterator, getReader, getStartOfLineString, setCloseInputstreamOnExit, setEndOfLineString, setStartOfLineString

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

FileLineIteratorPipe

public FileLineIteratorPipe()

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

Method Details

doPipe

public PipeRunResult doPipe(Message input,
 PipeLineSession session)
                     throws PipeRunException

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

Open a reader for the file named according the input messsage and transform it. Move the input file to a done directory when transformation is finished and return the names of the generated files.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class MessageSendingPipe

Throws:

PipeRunException

See Also:

• IPipe.doPipe(Message, PipeLineSession)

setMove2dirAfterTransform

public void setMove2dirAfterTransform(String readyDir)

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

Directory where input file is moved to in case of a successful transformation

setMove2dirAfterError

public void setMove2dirAfterError(String errorDir)

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

Directory where input file is moved to in case an error occurred

setCharset

public void setCharset(String value)

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

Default charset attribute

Default value

UTF-8

getMove2dirAfterTransform

public String getMove2dirAfterTransform()

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

getMove2dirAfterError

public String getMove2dirAfterError()

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

getCharset

public String getCharset()

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