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.stream.StreamingPipe

nl.nn.adapterframework.collection.CollectorPipe<IZipWritingElement,ZipWriter>

nl.nn.adapterframework.compression.ZipWriterPipe

All Implemented Interfaces:

ICollectingElement<ZipWriter>, IZipWritingElement, HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ZipWriterPipe
extends CollectorPipe<IZipWritingElement,ZipWriter>
implements IZipWritingElement

Pipe that creates a ZipStream. For action=open, the Pipe will create a new zip, that will be written to a file or stream specified by the input message, that must be a:

• String specifying a filename
• OutputStream
• HttpResponse

Since:

4.9.10

Author:

Gerrit van Brakel

Specific parameters

filename with action=open: the filename if the input is a HttpResponse; with action=write: the entryfilename, contents only for action=write: contents of the zipentry, If not specified, the input is used.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
ZipWriter	openCollection(Message input, PipeLineSession session, ParameterValueList pvl)
void	setCharset(String string) Only for action='write': Charset used to write strings to zip entries
void	setCloseInputstreamOnExit(boolean b) Only for action='write': If set to false, the inputstream is not closed after the zip entry is written
void	setCloseOutputstreamOnExit(boolean b) Only for action='open': If set to false, the outputstream is not closed after the zip creation is finished
void	setCloseStreamOnExit(boolean b) 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.CollectorPipe

canProvideOutputStream, doPipe, getAction, getCollection, provideOutputStream, setAction, setCollection

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

canStreamToNextPipe, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough

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, getParameterOverriddenAttributeValue, getParameterValueList, 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.compression.IZipWritingElement

getCharset, isCloseInputstreamOnExit, isCloseOutputstreamOnExit, isCompleteFileHeader

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

getName, setName

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 org.springframework.context.ApplicationContextAware

setApplicationContext

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

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

getMaxThreads

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 CollectorPipe<IZipWritingElement,ZipWriter>

Throws:

ConfigurationException

openCollection

public ZipWriter openCollection(Message input,
                                PipeLineSession session,
                                ParameterValueList pvl)
                         throws CollectionException

Specified by:

openCollection in interface ICollectingElement<ZipWriter>

Throws:

CollectionException

setCloseInputstreamOnExit

public void setCloseInputstreamOnExit(boolean b)

Only for action='write': If set to false, the inputstream is not closed after the zip entry is written

Default value

true

setCloseOutputstreamOnExit

public void setCloseOutputstreamOnExit(boolean b)

Only for action='open': If set to false, the outputstream is not closed after the zip creation is finished

Default value

true

setCloseStreamOnExit

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

Deprecated.

setCharset

public void setCharset(String string)

Only for action='write': Charset used to write strings to zip entries

Default value

utf-8

setZipWriterHandle

@Deprecated
 @ConfigurationWarning(value="Replaced with attribute collection")
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