Package org.frankframework.compression

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 org.frankframework.collection.AbstractCollectorPipe

AbstractCollectorPipe.Action

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.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)
PipeRunResult	doPipe(Message input, PipeLineSession session)	This is where the action takes place.
void	setBackwardsCompatibility(boolean backwardsCompatibility)	Deprecated, for removal: This API element is subject to removal in a future version.
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, for removal: This API element is subject to removal in a future version.

Methods inherited from class org.frankframework.collection.AbstractCollectorPipe

addPartToCollection, closeCollector, doAction, getCollection, getParameterValueList

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

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

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.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 org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, 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

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.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class AbstractCollectorPipe<ZipWriter,MessageZipEntry>

Throws:

PipeRunException

setZipWriterHandle

@Deprecated(forRemoval=true,
            since="7.9.0")
@ConfigurationWarning("Replaced with attribute collectionName")
public void setZipWriterHandle(String string)

Deprecated, for removal: This API element is subject to removal in a future version.

Session key used to refer to zip session. Must be specified with another value if ZipWriterPipes are nested. Deprecated, use collectionName instead.

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(forRemoval=true,
            since="7.9.0")
public void setBackwardsCompatibility(boolean backwardsCompatibility)

Deprecated, for removal: This API element is subject to removal in a future version.

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.