Class ResponseInspectionJson

    • Method Detail

      • identifier

        public final String identifier()

        The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

        JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/sign-up/success" ]

        Returns:
        The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

        JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/sign-up/success" ]

      • hasSuccessValues

        public final boolean hasSuccessValues()
        For responses, this returns true if the service returned a value for the SuccessValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • successValues

        public final List<String> successValues()

        Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

        JSON example: "SuccessValues": [ "True", "Succeeded" ]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSuccessValues() method.

        Returns:
        Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

        JSON example: "SuccessValues": [ "True", "Succeeded" ]

      • hasFailureValues

        public final boolean hasFailureValues()
        For responses, this returns true if the service returned a value for the FailureValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • failureValues

        public final List<String> failureValues()

        Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

        JSON example: "FailureValues": [ "False", "Failed" ]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureValues() method.

        Returns:
        Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

        JSON example: "FailureValues": [ "False", "Failed" ]

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)