Package org.frankframework.jdbc

Class ResultSetIteratingPipe

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.jdbc.JdbcIteratingPipeBase

org.frankframework.jdbc.ResultSetIteratingPipe

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 ResultSetIteratingPipe
extends JdbcIteratingPipeBase

Pipe that iterates over rows in in ResultSet. Each row is send passed to the sender in the same format a row is usually returned from a query.

Since:

4.7

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.jdbc.JdbcIteratingPipeBase

JdbcIteratingPipeBase.MixedQuerySender

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.jdbc.JdbcIteratingPipeBase

querySender

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected IDataIterator<String>	getIterator(IDbmsSupport dbmsSupport, Connection conn, ResultSet rs)

Methods inherited from class org.frankframework.jdbc.JdbcIteratingPipeBase

addParameter, getIterator, setAvoidLocking, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setDatasourceName, setLockRows, setLockWait, setQuery, setSqlDialect, setTrimSpaces, setUseNamedParams, start, stop

Methods inherited from class org.frankframework.pipes.StringIteratorPipe

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

Methods inherited from class org.frankframework.pipes.IteratingPipe

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

Methods inherited from class org.frankframework.pipes.MessageSendingPipe

consumesSessionVariable, doLogToMessageLog, doPipe, increaseRetryIntervalAndWait, postSendAction, propagateName, sendMessageWithRetries, setCheckRootTag, setCheckXmlWellFormed, setExceptionOnResult, setHideMethod, setHideRegex, setInputValidator, setInputWrapper, setLinkMethod, setMaxRetries, setMessageLog, setName, setOutputValidator, setOutputWrapper, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStubFilename, setTimeoutOnResult, setTimeOutOnResult, sizeStatisticsEnabled, storeMessage

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class org.frankframework.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 org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasSender

getSender

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

ResultSetIteratingPipe

public ResultSetIteratingPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JdbcIteratingPipeBase

Throws:

ConfigurationException - in case it was not able to configure the component.

getIterator

protected IDataIterator<String> getIterator(IDbmsSupport dbmsSupport,
 Connection conn,
 ResultSet rs)
                                     throws SenderException

Specified by:

getIterator in class JdbcIteratingPipeBase

Throws:

SenderException