nl.nn.adapterframework.compression

Class ZipWriterSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.stream.StreamingSenderBase

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

nl.nn.adapterframework.compression.ZipWriterSender

All Implemented Interfaces:

ICollectingElement<ZipWriter>, IZipWritingElement, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IOutputStreamingSupport, IStreamingSender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ZipWriterSender
extends CollectorSender<IZipWritingElement,ZipWriter>
implements IZipWritingElement

Sender that writes an entry to a ZipStream, similar to ZipWriterPipe with action='write'. Filename and contents are taken from parameters. If one of the parameters is not present, the input message is used for either filename or contents.

Since:

4.9.10

Author:

Gerrit van Brakel

Specific parameters

filename filename of the zipentry, contents contents of the zipentry

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
ZipWriterSender()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
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.CollectorSender

canProvideOutputStream, getAction, getCollection, provideOutputStream, sendMessage, setAction, setCollection

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

sendMessage, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

close, createBean, getLogPrefix, getName, isSynchronous, open, setApplicationContext, setName

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.ISenderWithParameters

consumesSessionVariable

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

close, isSynchronous, open, sendMessageOrThrow

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

addParameter, getParameterList

Constructor Detail

ZipWriterSender

public ZipWriterSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class CollectorSender<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