nl.nn.adapterframework.compression

Class ZipIteratorPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.MessageSendingPipe

nl.nn.adapterframework.pipes.IteratingPipe<String>

nl.nn.adapterframework.compression.ZipIteratorPipe

All Implemented Interfaces:

HasSender, HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, HasStatistics, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ZipIteratorPipe
extends IteratingPipe<String>

Sends a message to a Sender for each entry of its input, that must be an ZipInputStream. The input of the pipe must be one of:

• String refering to a filename
• File
• InputStream

The message sent each time to the sender is the filename of the entry found in the archive. The contents of the archive is available as a Stream or a String in a session variable.

Since:

4.9.10

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.pipes.IteratingPipe

IteratingPipe.ItemCallback, IteratingPipe.StopReason

Nested classes/interfaces inherited from class nl.nn.adapterframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.pipes.IteratingPipe

MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, STOP_CONDITION_MET_FORWARD

Fields inherited from class nl.nn.adapterframework.pipes.MessageSendingPipe

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 nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
ZipIteratorPipe()

Method Summary

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

Methods inherited from class nl.nn.adapterframework.pipes.IteratingPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.MessageSendingPipe

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

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

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

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.HasSender

getSender

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe

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

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

ZipIteratorPipe

public ZipIteratorPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class IteratingPipe<String>

Throws:

ConfigurationException

getZipInputStream

protected ZipInputStream getZipInputStream(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

setContentsSessionKey

public void setContentsSessionKey(String string)

Session key used to store contents of each zip entry

Default value

zipdata

setStreamingContents

public 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

Default value

true

setCloseInputstreamOnExit

public void setCloseInputstreamOnExit(boolean b)

If set to false, the inputstream is not closed after it has been used

Default value

true

setCloseStreamOnExit

@Deprecated
 @ConfigurationWarning(value="attribute \'closeStreamOnExit\' has been renamed to \'closeInputstreamOnExit\'")
public void setCloseStreamOnExit(boolean b)

Deprecated.

setCharset

public void setCharset(String string)

Charset used when reading the contents of the entry (only used if streamingContents=false)

Default value

utf-8

setSkipBOM

public 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)

Default value

false

setProcessFile

@Deprecated
 @ConfigurationWarning(value="Please add a LocalFileSystemPipe with action=read in front of this pipe instead")
public void setProcessFile(boolean b)

Deprecated.

If set true, the each entry is assumed to be the name of a file to be compressed. Otherwise, the input itself is compressed.

Default value

false