Package org.frankframework.pipes

Class JsonPathPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.pipes.JsonPathPipe
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
@EnterpriseIntegrationPattern(TRANSLATOR) public class JsonPathPipe extends FixedForwardPipe
Apply a one-liner JSON path expression to the input to extract a value from input data. If the input is in XML format, it will be converted to JSON using the same method as the Xml2Json pipe. Depending on the result of the expression, this pipe can return a string value or JSON value.

Examples

JSON Path Expression Input Message Output
$.a 
{
   "a": "Hello World"
 }
String with value Hello World
$.*.a 
{
   "k1": {"a": 1},
   "k2": {"a": 2}
 }
JSON Array with value 
[1, 2]
$.a 
{
   "a": {
     "Hello": "World"
   }
 }
JSON Object with value 
{
   "Hello": "World"
 }
If the input message does not have a match with the expression, then the Exception Forward path will be taken.

Since:
9.2