public class ZipIteratorPipe 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 |
---|
ZipIteratorPipe() |
Modifier and Type | Method and Description |
---|---|
void |
configure()
checks for correct configuration of forward
|
protected IDataIterator<String> |
getIterator(Message input,
PipeLineSession session,
Map<String,Object> threadContext) |
protected ZipInputStream |
getZipInputStream(Message input,
PipeLineSession session,
Map<String,Object> threadContext) |
void |
setCharset(String string)
Charset used when reading the contents of the entry (only used if streamingContents=false)
|
void |
setCloseInputstreamOnExit(boolean b)
If set to
false , the inputstream is not closed after it has been used |
void |
setCloseStreamOnExit(boolean b)
Deprecated.
|
void |
setContentsSessionKey(String string)
Session key used to store contents of each zip entry
|
void |
setProcessFile(boolean b)
Deprecated.
|
void |
setSkipBOM(boolean b)
If set to
true , a possible bytes order mark (BOM) at the start of the file is skipped (only used for encoding uft-8) |
void |
setStreamingContents(boolean b)
If set to
false , a string containing the contents of the entry is placed under the session key, instead of the inputstream to the contents |
canStreamToNextPipe, createItemCallBack, getItem, getStopConditionTp, itemToMessage, iterateOverInput, iterateOverStatistics, provideOutputStream, sendMessage, setAddInputToResult, setBlockSize, 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, 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, throwEvent
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 ZipInputStream getZipInputStream(Message input, PipeLineSession session, Map<String,Object> threadContext) throws SenderException
SenderException
protected IDataIterator<String> getIterator(Message input, PipeLineSession session, Map<String,Object> threadContext) throws SenderException
getIterator
in class IteratingPipe<String>
SenderException
public void setContentsSessionKey(String string)
public void setStreamingContents(boolean b)
false
, a string containing the contents of the entry is placed under the session key, instead of the inputstream to the contentspublic void setCloseInputstreamOnExit(boolean b)
false
, the inputstream is not closed after it has been used@Deprecated @ConfigurationWarning(value="attribute \'closeStreamOnExit\' has been renamed to \'closeInputstreamOnExit\'") public void setCloseStreamOnExit(boolean b)
public void setCharset(String string)
public void setSkipBOM(boolean b)
true
, a possible bytes order mark (BOM) at the start of the file is skipped (only used for encoding uft-8)@Deprecated @ConfigurationWarning(value="Please add a LocalFileSystemPipe with action=read in front of this pipe instead") public void setProcessFile(boolean b)
true
, the each entry is assumed to be the name of a file to be compressed. Otherwise, the input itself is compressed.Copyright © 2023 Frank!Framework. All rights reserved.