Class ZipWriterSender

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

public class ZipWriterSender extends CollectorSenderBase<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
  • Constructor Details

    • ZipWriterSender

      public ZipWriterSender()
  • Method Details

    • 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 CollectorSenderBase<ZipWriter,MessageZipEntry>
      Throws:
      ConfigurationException
    • sendMessage

      public SenderResult 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:

       synchronousa-synchronous
      ISender.isSynchronous() returnstruefalse
      return value of sendMessage() isthe reply-messagethe messageId of the message sent
      the correlationID specified with sendMessage()may be ignoredis sent with the message
      a {link TimeOutException}may be thrown if a timeout occurs waiting for a replyshould 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 CollectorSenderBase<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.