JsonNode

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read

    • A global object that provides methods to iterate over the JSON content.

    You can access a JsonNode object by calling getAsJsonContent() on a request object.

    You access JSON content from a POST or URL parameter by calling request.postParms.<parameter name>.getAsJsonContent() or request.urlParms.<parameter name>.getAsJsonContent().

    JsonNode - getIterator(String xPath)

    Returns a JsonNodeIterator object for the JSON content.

    This method can only be used on the root node, but can be used to traverse deep into the JSON object. Subsequent traversals must use the iterator() method.

    Table 1. Parameters
    Name Type Description
    xPath String An xPath expression.
    Table 2. Returns
    Type Description
    JsonNodeIterator An object that can iterate over nodes in the JSON object.

    JsonNode - iterator()

    Returns a JsonNodeIterator object that iterates over all child nodes of the current node.

    Table 3. Parameters
    Name Type Description
    None
    Table 4. Returns
    Type Description
    JsonNodeIterator An object that can iterate over nodes in the JSON object.

    JsonNode - getAsString()

    Returns the current node value as a string.

    Table 5. Parameters
    Name Type Description
    None
    Table 6. Returns
    Type Description
    String The current node value.

    JsonNode - getAsString(String propertyName)

    Returns the string value of the specified property.

    Table 7. Parameters
    Name Type Description
    propertyName String Name of the property.
    Table 8. Returns
    Type Description
    String The property value.

    JsonNode - getName()

    Returns the name of the current JSON node.

    Table 9. Parameters
    Name Type Description
    None
    Table 10. Returns
    Type Description
    String Name of the current JSON node.

    JsonNode - valueFor(String tableName, String fieldName)

    Specifies that the JSON property maps to the specified field in the specified table.

    Calling this method on a JSON property tells the proxy that the value for this property maps to the specified field in the specified table. The proxy then decides if the field must be encrypted. If the table and field names are unknown, you can call the valueFor() method on a table and a field that are dynamically assigned based on the request.

    Table 11. Parameters
    Name Type Description
    tableName String The table name.
    fieldName String The field name.
    Table 12. Returns
    Type Description
    void

    JsonNode - encodedQueryFor(String tableName)

    Specifies that the value of the JSON property is an encoded query for the specified table.

    Calling this function on a JSON node tells the proxy that the value is an Encoded query strings for the specified table. The proxy parses the encoded query and encrypts the values for fields in the encoded query that must be encrypted.

    Table 13. Parameters
    Name Type Description
    tableName String The table that you expect the query to run on.
    Table 14. Returns
    Type Description
    void