mitkIRESTManager.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef mitkIRESTManager_h
#define mitkIRESTManager_h

#include <mitkServiceInterface.h>

#include <MitkRESTExports.h>
#include <mitkRESTUtil.h>

#include <cpprest/json.h>
#include <cpprest/uri.h>
#include <cpprest/http_client.h>

namespace mitk
{
  class IRESTObserver;
  class RESTServer;

  class MITKREST_EXPORT IRESTManager
  {
  public:
    virtual ~IRESTManager();

    enum class RequestType
    {
      Get,
      Post,
      Put
    };

    virtual pplx::task<web::json::value> SendRequest(
      const web::uri &uri,
      const RequestType &type = RequestType::Get,
      const std::map<utility::string_t, utility::string_t> headers = {}) = 0;

    virtual pplx::task<web::json::value> SendJSONRequest(
      const web::uri &uri,
      const RequestType &type = RequestType::Get,
      const web::json::value *body = nullptr,
      const std::map<utility::string_t, utility::string_t> headers = {},
      const utility::string_t &filePath = {}
    ) = 0;

    virtual pplx::task<web::json::value> SendBinaryRequest(const web::uri &uri,
                                                     const RequestType &type = RequestType::Get,
                                                     const std::vector<unsigned char> *body = {},
                                                     const std::map<utility::string_t, utility::string_t> headers = {}) = 0;

    virtual void ReceiveRequest(const web::uri &uri, IRESTObserver *observer) = 0;

    virtual web::http::http_response Handle(const web::uri &uri,
                                            const web::json::value &body,
                                            const web::http::method &method,
                                            const mitk::RESTUtil::ParamMap &headers) = 0;

    virtual void HandleDeleteObserver(IRESTObserver *observer, const web::uri &uri = {}) = 0;

    virtual const std::map<int, RESTServer *>& GetServerMap() = 0;
    virtual const std::map<std::pair<int, utility::string_t>, IRESTObserver *>& GetObservers() = 0;

  };
}

MITK_DECLARE_SERVICE_INTERFACE(mitk::IRESTManager, "org.mitk.IRESTManager")

#endif