[jira] [Created] (JAMES-3097) Implement level error-handling protocol

["René Cordier (Jira)" <se...@james.apache.org>]

René Cordier created JAMES-3097:
-----------------------------------

             Summary: Implement level error-handling protocol
                 Key: JAMES-3097
                 URL: https://issues.apache.org/jira/browse/JAMES-3097
             Project: James Server
          Issue Type: Improvement
            Reporter: René Cordier


See https://jmap.io/spec-core.html#errors notes about Request-Level Errors:

When an HTTP error response is returned to the client, the server SHOULD return a JSON “problem details” object as the response body, as per [RFC7807](https://tools.ietf.org/html/rfc7807).

The following problem types are defined:

 - urn:ietf:params:jmap:error:unknownCapability The client included a capability in the “using” property of the request that the server does not support.
 - urn:ietf:params:jmap:error:notJSON The content type of the request was not application/json or the request did not parse as I-JSON.
 - urn:ietf:params:jmap:error:notRequest The request parsed as JSON but did not match the type signature of the Request object.
 - urn:ietf:params:jmap:error:limit The request was not processed as it would have exceeded one of the request limits defined on the capability object, such as maxSizeRequest, maxCallsInRequest, or maxConcurrentRequests. A “limit” property MUST also be present on the “problem details” object, containing the name of the limit being applied.

*Example*
{code:java}
{
  "type": "urn:ietf:params:jmap:error:unknownCapability",
  "status": 400,
  "detail": "The Request object used capability
    'https://example.com/apis/foobar', which is not supported
    by this server."
}
{code}

*DOD*:
 - Ommitting the content-type, accept header, sending non json payload, invalid json payload, or violating limits should result in the right error. You will write *memory integration tests* demonstrating these protocol errors.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org