nl.nn.adapterframework.compression

Class ZipWriterSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.compression.ZipWriterSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ZipWriterSender
extends SenderWithParametersBase

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.
String	getCharset()
String	getZipWriterHandle()
boolean	isCloseInputstreamOnExit()
Message	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setCharset(String string)
void	setCloseInputstreamOnExit(boolean b)
void	setCloseStreamOnExit(boolean b) Deprecated.
void	setZipWriterHandle(String string)

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

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue

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.core.ISender

close, isSynchronous, open

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

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 SenderWithParametersBase

Throws:

ConfigurationException

sendMessage

public Message sendMessage(Message message,
                           PipeLineSession session)
                    throws SenderException,
                           TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Throws:

SenderException

TimeoutException

setCloseInputstreamOnExit

@IbisDoc(value={"when set to <code>false</code>, the inputstream is not closed after it has been used","true"})
public void setCloseInputstreamOnExit(boolean b)

setCloseStreamOnExit

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

Deprecated.

isCloseInputstreamOnExit

public boolean isCloseInputstreamOnExit()

setCharset

@IbisDoc(value={"characterset used for writing zip entry","utf-8"})
public void setCharset(String string)

getCharset

public String getCharset()

setZipWriterHandle

@IbisDoc(value={"session key used to refer to zip session. must be used if zipwriterpipes are nested","zipwriterhandle"})
public void setZipWriterHandle(String string)

getZipWriterHandle

public String getZipWriterHandle()