Class CompressPipe

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class CompressPipe extends FixedForwardPipe
Pipe to zip or unzip a message or file.
Author:
John Dekker, Jaco de Groot
  • Constructor Details

    • CompressPipe

      public CompressPipe()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class FixedForwardPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException
    • setCompress

      public void setCompress(boolean b)
      If true, the pipe compresses; otherwise, it decompresses.
      Default value
      false
    • setFilenamePattern

      @Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use a LocalFileSystemPipe with filename parameter (and optionally a pattern)") public void setFilenamePattern(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      required if result is a file, the pattern for the result filename. Can be set with variables e.g. {file}.{ext}.zip in this example the {file} and {ext} variables are resolved with sessionKeys with the same name
    • setMessageIsContent

      public void setMessageIsContent(boolean b)
      A flag that indicates whether the message is the content or the path to a file with the contents. For multiple files, use ';' as a delimiter.
      Default value
      false
    • setOutputDirectory

      @Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use resultIsContent=true in combination with a LocalFileSystemPipe") public void setOutputDirectory(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Required if the result is a file. The directory in which to store the result file.
    • setResultIsContent

      public void setResultIsContent(boolean b)
      A flag that indicates whether the result must be written to the message or to a file (filename = message).
      Default value
      true when outputDirectory is not set.
    • isResultIsContent

      public boolean isResultIsContent()
    • setZipEntryPattern

      @Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use parameter zipEntryPattern (in combination with the pattern attribute)") public void setZipEntryPattern(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The pattern for the zip entry name in case a zip file is read or written.
    • setFileFormat

      public void setFileFormat(CompressPipe.FileFormat format)