Class JsonPipe

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 JsonPipe extends FixedForwardPipe
JSON is not aware of the element order. This pipe performs a best effort JSON to XML transformation. If you wish to validate or add structure to the converted (xml) file, please use the Json2XmlValidator.
Martijn Onstwedder, Tom van der Heijden
  • Constructor Details

    • JsonPipe

      public JsonPipe()
  • 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(JsonPipe.Direction value)
      Direction of the transformation.
      Default value
    • setVersion

      @Deprecated public void setVersion(String version)
    • setAddXmlRootElement

      public void setAddXmlRootElement(boolean addXmlRootElement)
      When direction is JSON2XML, it wraps a root element around the converted message. When direction is XML2JSON, it includes the name of the root element as a key in the converted message.
      Default value
      TRUE when JSON2XML and FALSE when XML2JSON
    • setPrettyPrint

      public void setPrettyPrint(boolean prettyPrint)
      Format the output in easy legible way (currently only for XML)
    • getDirection

      public JsonPipe.Direction getDirection()
    • isPrettyPrint

      public boolean isPrettyPrint()