Class EscapePipe

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 EscapePipe extends FixedForwardPipe
Pipe that performs translations between special characters and their xml equivalents.

When direction=cdata2text all cdata nodes are converted to text nodes without any other translations.

Peter Leeuwenburgh
  • Constructor Details

    • EscapePipe

      public EscapePipe()
  • 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.
    • setSubstringStart

      public void setSubstringStart(String substringStart)
      substring to start translation
    • setSubstringEnd

      public void setSubstringEnd(String substringEnd)
      substring to end translation
    • setDirection

      public void setDirection(EscapePipe.Direction direction)
    • isEncodeSubstring

      public boolean isEncodeSubstring()
    • setEncodeSubstring

      public void setEncodeSubstring(boolean b)
      when set true special characters in substringstart and substringend are first translated to their xml equivalents
      Default value
    • getSubstringStart

      public String getSubstringStart()
    • getSubstringEnd

      public String getSubstringEnd()
    • getDirection

      public EscapePipe.Direction getDirection()