Class ZipWriterPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.collection.AbstractCollectorPipe<ZipWriter, MessageZipEntry>

org.frankframework.compression.ZipWriterPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class ZipWriterPipe
extends AbstractCollectorPipe<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 AbstractCollectorPipe

AbstractCollectorPipe.Action

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
ZipWriterPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected ZipWriter	createCollector(Message input, PipeLineSession session)
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)

Methods inherited from class AbstractCollectorPipe

addPartToCollection, closeCollector, doAction, doPipe, getCollection, getParameterValueList

Methods inherited from class FixedForwardPipe

getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

ZipWriterPipe

public ZipWriterPipe()

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

Throws:

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

createCollector

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

Specified by:

createCollector in class AbstractCollectorPipe<ZipWriter, MessageZipEntry>

Throws:

CollectionException

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