public class StringIteratorPipe extends IteratingPipe<String>
IteratingPipe.ItemCallback, IteratingPipe.StopReason
MessageSendingPipe.LinkMethod
HasStatistics.Action
MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, STOP_CONDITION_MET_FORWARD
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
AUTOMATIC_STREAMING
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
StringIteratorPipe() |
Modifier and Type | Method and Description |
---|---|
void |
configure()
checks for correct configuration of forward
|
protected IteratingPipe.ItemCallback |
createItemCallBack(PipeLineSession session,
ISender sender,
Writer writer) |
protected String |
getKey(String item) |
void |
setBlockPrefix(String string)
If
combineBlocks = true , this string is inserted at the start of each block. |
void |
setBlockSize(int i)
Controls multiline behaviour.
|
void |
setBlockSuffix(String string)
If
combineBlocks = true , this string is inserted at the end of the set of lines. |
void |
setCombineBlocks(boolean combineBlocks)
If
true , all items in a block are sent at once. |
void |
setEndPosition(int i)
If
endPosition >= startPosition , this field contains the end position of the key in the current record |
void |
setEscapeXml(boolean escapeXml)
Escape XML characters in each item
|
void |
setLinePrefix(String string)
This string is inserted at the start of each item
|
void |
setLineSuffix(String string)
This string is appended at the end of each item
|
void |
setStartPosition(int i)
If
startPosition >= 0 , this field contains the start position of the key in the current record (first character is 0);
A sequence of lines with the same key is put in one block and send to the sender. |
canStreamToNextPipe, getItem, getIterator, getStopConditionTp, itemToMessage, iterateOverInput, iterateOverStatistics, provideOutputStream, sendMessage, setAddInputToResult, setCloseIteratorOnExit, setCollectResults, setIgnoreExceptions, setItemNoSessionKey, setMaxChildThreads, setMaxItems, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setParallel, setRemoveDuplicates, setRemoveXmlDeclarationInResults, setSender, setStopConditionXPathExpression, setStyleSheetName, setXpathExpression
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
getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine
getMaxThreads
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class IteratingPipe<String>
ConfigurationException
protected IteratingPipe.ItemCallback createItemCallBack(PipeLineSession session, ISender sender, Writer writer)
createItemCallBack
in class IteratingPipe<String>
public void setBlockSize(int i)
IteratingPipe
setBlockSize
in class IteratingPipe<String>
public void setStartPosition(int i)
startPosition >= 0
, this field contains the start position of the key in the current record (first character is 0);
A sequence of lines with the same key is put in one block and send to the sender. Cannot be used in combination with blockSize.public void setEndPosition(int i)
endPosition >= startPosition
, this field contains the end position of the key in the current recordpublic void setCombineBlocks(boolean combineBlocks)
true
, all items in a block are sent at once. If set false, items are sent individually, potentially leveraging block enabled sending capabilities of the senderpublic void setBlockPrefix(String string)
combineBlocks = true
, this string is inserted at the start of each block. Requires blockSize
or startPosition
and endPosition
to be set too.public void setBlockSuffix(String string)
combineBlocks = true
, this string is inserted at the end of the set of lines. Requires blockSize
or startPosition
and endPosition
to be set too.public void setLinePrefix(String string)
public void setLineSuffix(String string)
public void setEscapeXml(boolean escapeXml)
Copyright © 2023 Frank!Framework. All rights reserved.