Class Base64Pipe

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

Pipe that performs base64 encoding and decoding.
Since:
4.4
Version:
2.0
Author:
Niels Meijer
  • Constructor Details

    • Base64Pipe

      public Base64Pipe()
  • 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
    • setDirection

      public void setDirection(Base64Pipe.Direction direction)
      Default value
      ENCODE
    • setCharset

      public void setCharset(String string)
      Character encoding to be used when reading input from strings for direction = encode or writing data for direction = decode.
    • setLineSeparator

      public void setLineSeparator(String lineSeparator)
      (Only used when direction=encode) Defines the separator between lines. Special values: auto: platform default, dos: crlf, unix: lf.
      Default value
      auto
    • setLineLength

      public void setLineLength(int lineLength)
      (Only used when direction=encode) Each line of encoded data will be at most the given length (rounded down to the nearest multiple of 4). If linelength <= 0, then the output will not be divided into lines.
      Default value
      76