nl.nn.adapterframework.compression

Class ZipWriterPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.collection.CollectorPipeBase<ZipWriter,MessageZipEntry>

nl.nn.adapterframework.compression.ZipWriterPipe

All Implemented Interfaces:

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

public class ZipWriterPipe
extends CollectorPipeBase<ZipWriter,MessageZipEntry>

Pipe that creates a ZIP archive (on action close).

A chain of zipWriterPipes can be used to create a ZIP archive. You can use the pipe with different actions (see specified below). Action CLOSE will generate the ZIP archive which is returned as the pipe ouput.

Since:

7.9

Author:

Gerrit van Brakel, Niels Meijer

Specific parameters

filename only for action=WRITE: the filename of the zip-entry, contents only for action=WRITE: contents of the zip-entry, If not specified, the input is used.

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.collection.CollectorPipeBase

CollectorPipeBase.Action

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
protected ZipWriter	createCollector(Message input, PipeLineSession session)
PipeRunResult	doPipe(Message input, PipeLineSession session) This is where the action takes place.
void	setBackwardsCompatibility(boolean backwardsCompatibility) Deprecated.
void	setCompleteFileHeader(boolean b) Only for action='write': If set to true, the fields 'crc-32', 'compressed size' and 'uncompressed size' in the zip entry file header are set explicitly (note: compression ratio is zero)
void	setZipWriterHandle(String string) Deprecated.

Methods inherited from class nl.nn.adapterframework.collection.CollectorPipeBase

addPartToCollection, closeCollector, doAction, getCollection, getParameterValueList

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, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, 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.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.INamedObject

getName

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

ZipWriterPipe

public ZipWriterPipe()

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 CollectorPipeBase<ZipWriter,MessageZipEntry>

Throws:

ConfigurationException

createCollector

protected ZipWriter createCollector(Message input,
                                    PipeLineSession session)
                             throws CollectionException

Specified by:

createCollector in class CollectorPipeBase<ZipWriter,MessageZipEntry>

Throws:

CollectionException

doPipe

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

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class CollectorPipeBase<ZipWriter,MessageZipEntry>

Throws:

PipeRunException

setZipWriterHandle

@Deprecated
 @ConfigurationWarning(value="Replaced with attribute collectionName")
public void setZipWriterHandle(String string)

Deprecated.

Session key used to refer to zip session. Must be specified with another value if ZipWriterPipes are nested

Default value

zipwriterhandle

setCompleteFileHeader

public void setCompleteFileHeader(boolean b)

Only for action='write': If set to true, the fields 'crc-32', 'compressed size' and 'uncompressed size' in the zip entry file header are set explicitly (note: compression ratio is zero)

Default value

false

setBackwardsCompatibility

@Deprecated
public void setBackwardsCompatibility(boolean backwardsCompatibility)

Deprecated.

When action is OPEN: If input is a string, it's assumed it's the location where to save the Zip Archive. When action is WRITE: Input will be 'piped' to the output, and the message will be preserved. Avoid using this if possible.