Class Base64Pipe

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

@Category("Basic") @ElementType(TRANSLATOR) public class Base64Pipe extends FixedForwardPipe
Pipe that performs base64 encoding and decoding.
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
      Specified by:
      configure in interface IPipe
      configure in class FixedForwardPipe
    • 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.
    • setDirection

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

      public void setCharset(String string)
      Character encoding to be used to 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 separator between lines. Special values: auto: platform default, dos: crlf, unix: lf
      Default value
    • setLineLength

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

      public Base64Pipe.Direction getDirection()
    • getCharset

      public String getCharset()
    • getLineSeparator

      public String getLineSeparator()
    • getLineLength

      public int getLineLength()