Package de.captaingoldfish.scim.sdk.common.response

Class ErrorResponse

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.TreeNode, com.fasterxml.jackson.databind.JsonSerializable, com.fasterxml.jackson.databind.node.JsonNodeCreator, ScimNode, Serializable, Iterable<com.fasterxml.jackson.databind.JsonNode>
    public class ErrorResponse
extends ScimResponse
    author Pascal Knueppel
    created at: 14.10.2019 - 20:58

    represents a SCIM error response
    See Also:
    Serialized Form

    • Constructor Detail

      • ErrorResponse

        public ErrorResponse​(com.fasterxml.jackson.databind.JsonNode responseNode)

      • ErrorResponse

        public ErrorResponse​(ScimException scimException)

      • ErrorResponse

        public ErrorResponse​(ScimException scimException,
                     boolean useDetailMessage)

      • ErrorResponse

        public ErrorResponse()

    • Method Detail

      • getStatus

        public int getStatus()
        The HTTP status code (see Section 6 of [RFC7231]) expressed as a JSON string. REQUIRED.

      • setStatus

        public void setStatus​(int status)
        The HTTP status code (see Section 6 of [RFC7231]) expressed as a JSON string. REQUIRED.

      • getScimType

        public Optional<String> getScimType()
        A SCIM detail error keyword. See Table 9. OPTIONAL.

      • setScimType

        public void setScimType​(String scimType)
        A SCIM detail error keyword. See Table 9. OPTIONAL.

      • getDetail

        public Optional<String> getDetail()
        A detailed human-readable message. OPTIONAL.

      • setDetail

        public void setDetail​(String detail)
        A detailed human-readable message. OPTIONAL.

      • getErrorMessages

        public List<String> getErrorMessages()
        Returns:
        the unspecific error messages from the schema validation that could not be mapped to a specific field

      • getFieldErrors

        public Map<String,​List<String>> getFieldErrors()
        Returns:
        the field errors from the schema validation that indicate errors directly on specific resource fields

      • getHttpStatus

        public int getHttpStatus()
        the http status code of the response
        Specified by:
        getHttpStatus in class ScimResponse

      • getScimException

        public ScimException getScimException()
        the exception that should be turned into a SCIM error response