Package org.frankframework.pipes

Class ChecksumPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.pipes.HashPipe
org.frankframework.pipes.ChecksumPipe
All Implemented Interfaces:
HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
@Deprecated(forRemoval=true, since="8.3.0") @ConfigurationWarning("Use the HashPipe") public class ChecksumPipe extends HashPipe
Deprecated, for removal: This API element is subject to removal in a future version.
please use the HashPipe
This pipe can be used to generate a hash for the given message using an algorithm. With this, you can prove integrity of the message. If you need to prove the authenticity of the message as well, please use the HashPipe which uses an algorithm and a secret to prove both integrity and authenticity.

The hash is generated based on the bytes of the given input message or on the bytes read from the file path if @{code inputIsFile} is @{code true}

The supported algorithms are:

  • CRC32
  • Adler32
  • MD5
  • SHA
  • SHA256
  • SHA384
  • SHA512
Since:
4.9
Author:
Gerrit van Brakel

  • Constructor Details

    • ChecksumPipe

      public ChecksumPipe()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: FixedForwardPipe
      checks for correct configuration of forward
      Specified by:
      configure in interface IConfigurable
      Specified by:
      configure in interface IPipe
      Overrides:
      configure in class HashPipe
      Throws:
      ConfigurationException

    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
      Specified by:
      doPipe in interface IPipe
      Overrides:
      doPipe in class HashPipe
      Throws:
      PipeRunException

    • setInputIsFile

      @Deprecated(forRemoval=true, since="7.7.0") @ConfigurationWarning("Please use fileSystemPipe to read the file first.") public void setInputIsFile(boolean b)
      Deprecated, for removal: This API element is subject to removal in a future version.
      If set true, the input is assumed to be a filename; otherwise the input itself is used in the calculations.
      Default value
      false

    • setType

      @Deprecated(forRemoval=true, since="8.3.0") @ConfigurationWarning("Please use setAlgorithm to set the algorithm") public void setType(Algorithm value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Type of checksum to be calculated
      Default value
      MD5

    • isInputIsFile

      public boolean isInputIsFile()
      Deprecated, for removal: This API element is subject to removal in a future version.