Package org.frankframework.compression

Class ZipWriterSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

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

org.frankframework.compression.ZipWriterSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class ZipWriterSender
extends AbstractCollectorSender<ZipWriter,MessageZipEntry>

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 org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
ZipWriterSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setBackwardsCompatibility(boolean backwardsCompatibility)	Deprecated, for removal: This API element is subject to removal in a future version.
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.AbstractCollectorSender

getCollection

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

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

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

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

isSynchronous, sendMessageOrThrow, start, stop

Methods inherited from interface org.frankframework.core.NameAware

setName

Constructor Details

ZipWriterSender

public ZipWriterSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

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

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractCollectorSender<ZipWriter,MessageZipEntry>

Throws:

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

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 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.

Specified by:

sendMessage in interface ISender

Overrides:

sendMessage in class AbstractCollectorSender<ZipWriter,MessageZipEntry>

Throws:

SenderException

TimeoutException

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

Default value

zipwriterhandle

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.

Input will be 'piped' to the output, and the message will be preserved. Avoid using this if possible.