Class HashPipe

All Implemented Interfaces:
HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ElementType(TRANSLATOR) public class HashPipe extends FixedForwardPipe
Pipe that hashes the input message.
Niels Meijer
  • Constructor Details

    • HashPipe

      public HashPipe()
  • Method Details

    • 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. 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.
    • setAlgorithm

      public void setAlgorithm(HashPipe.HashAlgorithm algorithm)
      Hash Algorithm to use
      Default value
    • setEncoding

      @Deprecated @ConfigurationWarning("attribute encoding has been replaced with attribute charset, default has changed from ISO8859_1 to UTF-8") public void setEncoding(String encoding)
    • setCharset

      public void setCharset(String charset)
      Character set to use for converting the secret from String to bytes
      Default value
    • setHashEncoding

      public void setHashEncoding(HashPipe.HashEncoding hashEncoding)
      Method to use for converting the hash from bytes to String
      Default value
    • setBinaryToTextEncoding

      @Deprecated @ConfigurationWarning("use attribute hashEncoding instead") public void setBinaryToTextEncoding(HashPipe.HashEncoding hashEncoding)
    • setSecret

      public void setSecret(String secret)
      The secret to hash with. Only used if no parameter secret is configured. The secret is only used when there is no authAlias specified, by attribute or parameter
    • setAuthAlias

      public void setAuthAlias(String authAlias)
      authAlias to retrieve the secret from (password field). Only used if no parameter authAlias is configured
    • getCharset

      public String getCharset()
    • getSecret

      public String getSecret()
    • getAuthAlias

      public String getAuthAlias()
    • getAlgorithm

      public HashPipe.HashAlgorithm getAlgorithm()
    • getHashEncoding

      public HashPipe.HashEncoding getHashEncoding()