Package org.apache.camel.jsonpath

Annotation Interface JsonPath

@Retention(RUNTIME) @Documented @Target({FIELD,METHOD,PARAMETER}) @LanguageAnnotation(language="jsonpath", factory=JsonPathAnnotationExpressionFactory.class) public @interface JsonPath
An annotation used to inject a JsonPath expression into a method parameter when using Bean Integration

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    allowSimple
    Whether to allow in inlined simple exceptions in the JsonPath expression
    String
    headerName
     
    com.jayway.jsonpath.Option[]
    options
    To configure the JsonPath options to use
    String
    propertyName
     
    Class<?>
    resultType
    The desired return type.
    boolean
    suppressExceptions
    Whether to suppress exceptions such as PathNotFoundException

  • Element Details

    • suppressExceptions

      boolean suppressExceptions
      Whether to suppress exceptions such as PathNotFoundException
      Default:
      false

    • allowSimple

      boolean allowSimple
      Whether to allow in inlined simple exceptions in the JsonPath expression
      Default:
      true

    • options

      com.jayway.jsonpath.Option[] options
      To configure the JsonPath options to use
      Default:
      {}

    • resultType

      Class<?> resultType
      The desired return type.
      Default:
      java.lang.Object.class

    • headerName

      String headerName
      Returns:
      The name of the header we want to apply the expression to. If this is empty then the expression will be applied to the value of the exchange property or the body instead.
      Default:
      ""

    • propertyName

      String propertyName
      Returns:
      The name of the property we want to apply the expression to. If this is empty then the expression will be applied to the body instead.
      Default:
      ""