Module io.helidon.integrations.common.rest
Package io.helidon.integrations.common.rest

Class ApiJsonParser

java.lang.Object
io.helidon.integrations.common.rest.ApiJsonParser
Direct Known Subclasses:
ApiResponse, CertificateGet.Response, DbGet.Response, Encrypt.Encrypted, GetCubbyhole.Response, GetKv1.Response, GetKv2.Response, Kv2Metadata, ListSecrets.Response
public abstract class ApiJsonParser extends Object
Helper methods to process a returned JSON.

  • Constructor Details

    • ApiJsonParser

      public ApiJsonParser()

  • Method Details

    • stringValue

      protected static String stringValue(JsonValue value)
      Get a string value from a json value.
      Parameters:
      value - Json value
      Returns:
      string representation of the value.
      Throws:
      ApiException - in case the value is array or object

    • stringValue

      @Deprecated(since="4.5.0", forRemoval=true) protected static String stringValue(JsonValue value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use stringValue(JsonValue)
      Get a string value from a JSON-P value.
      Parameters:
      value - Json value
      Returns:
      string representation of the value

    • toList

      protected static List<String> toList(JsonObject json, String name)
      Convert a JSON array in the JSON object to a list of strings.
      Parameters:
      json - JSON object
      name - name of the array in the object
      Returns:
      list from the array, or empty if the array does not exist or is null

    • toList

      @Deprecated(since="4.5.0", forRemoval=true) protected static List<String> toList(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toList(JsonObject, String)
      Convert a JSON-P array in the JSON object to a list of strings.
      Parameters:
      json - JSON object
      name - name of the array in the object
      Returns:
      list from the array, or empty if the array does not exist or is null

    • toBytesBase64

      protected static Optional<byte[]> toBytesBase64(JsonObject json, String name)
      Get bytes from a base64 string value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      bytes or empty if the property does not exist or is null

    • toBytesBase64

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<byte[]> toBytesBase64(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toBytesBase64(JsonObject, String)
      Get bytes from a base64 string value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      bytes or empty if the property does not exist or is null

    • toObject

      protected static Optional<JsonObject> toObject(JsonObject json, String name)
      Get a child JSON object.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      JSON object or empty if the property does not exist or is null

    • toObject

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<JsonObject> toObject(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toObject(JsonObject, String)
      Get a child JSON-P object.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      JSON object or empty if the property does not exist or is null

    • toString

      protected static Optional<String> toString(JsonObject json, String name)
      Get a string value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      string or empty if the property does not exist or is null

    • toString

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<String> toString(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toString(JsonObject, String)
      Get a string value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      string or empty if the property does not exist or is null

    • toInt

      protected static Optional<Integer> toInt(JsonObject json, String name)
      Get an int value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      int or empty if the property does not exist or is null

    • toInt

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Integer> toInt(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toInt(JsonObject, String)
      Get an int value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      int or empty if the property does not exist or is null

    • toLong

      protected static Optional<Long> toLong(JsonObject json, String name)
      Get a long value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      long or empty if the property does not exist or is null

    • toLong

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Long> toLong(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toLong(JsonObject, String)
      Get a long value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      long or empty if the property does not exist or is null

    • toDouble

      protected static Optional<Double> toDouble(JsonObject json, String name)
      Get a double value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      double or empty if the property does not exist or is null

    • toDouble

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Double> toDouble(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toDouble(JsonObject, String)
      Get a double value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      double or empty if the property does not exist or is null

    • toBoolean

      protected static Optional<Boolean> toBoolean(JsonObject json, String name)
      Get a boolean value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      boolean or empty if the property does not exist or is null

    • toBoolean

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Boolean> toBoolean(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toBoolean(JsonObject, String)
      Get a boolean value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      boolean or empty if the property does not exist or is null

    • toInstant

      protected static Optional<Instant> toInstant(JsonObject json, String name, DateTimeFormatter formatter)
      Get an Instant value.
      Parameters:
      json - JSON object
      name - name of the property
      formatter - to use when parsing the string value
      Returns:
      instant or empty if the property does not exist or is null

    • toInstant

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Instant> toInstant(JsonObject json, String name, DateTimeFormatter formatter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toInstant(JsonObject, String, DateTimeFormatter)
      Get an Instant value.
      Parameters:
      json - JSON object
      name - name of the property
      formatter - to use when parsing the string value
      Returns:
      instant or empty if the property does not exist or is null

    • toMap

      protected static Map<String,String> toMap(JsonObject json, String name)
      Get a map value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      map with property key/value pairs, or empty if the property does not exist or is null

    • toMap

      @Deprecated(since="4.5.0", forRemoval=true) protected static Map<String,String> toMap(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use toMap(JsonObject, String)
      Get a map value.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      map with property key/value pairs, or empty if the property does not exist or is null

    • isPresent

      protected static Optional<Boolean> isPresent(JsonObject json, String name)
      If the property is present on the JSON object, returns a non-empty optional, otherwise returns an empty.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      non-empty optional if the property exists and is not null

    • isPresent

      @Deprecated(since="4.5.0", forRemoval=true) protected static Optional<Boolean> isPresent(JsonObject json, String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use isPresent(JsonObject, String)
      If the property is present on the JSON-P object, returns a non-empty optional.
      Parameters:
      json - JSON object
      name - name of the property
      Returns:
      non-empty optional if the property exists and is not null