Interface Callbacks.OnRestRequest

  • Enclosing class:
    Callbacks

    public static interface Callbacks.OnRestRequest
    Callback to serve a resource in the REST API.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void call​(RestOutput output, HttpMethod method, java.lang.String uri, java.lang.String[] regularExpressionGroups, java.util.Map<java.lang.String,​java.lang.String> headers, java.util.Map<java.lang.String,​java.lang.String> getParameters, byte[] body)
      Signature of a callback function that answers a REST request.
    • Method Detail

      • call

        void call​(RestOutput output,
                  HttpMethod method,
                  java.lang.String uri,
                  java.lang.String[] regularExpressionGroups,
                  java.util.Map<java.lang.String,​java.lang.String> headers,
                  java.util.Map<java.lang.String,​java.lang.String> getParameters,
                  byte[] body)
        Signature of a callback function that answers a REST request.
        Parameters:
        output - Output containing the answer that is sent to the REST client.
        method - The HTTP method.
        uri - The URI, starting from the root of the Orthanc server.
        regularExpressionGroups - The actual values of the groups matched by the regular expression.
        headers - The HTTP headers of the request.
        getParameters - The parameters of a GET request.
        body - The body of the request (only applicable to POST and PUT methods).