mitkIRestServerService.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 mitkIRestServerService_h
#define mitkIRestServerService_h
 
#include <mitkServiceInterface.h>
#include <mitkRestServerConfig.h>
#include <mitkDataStorage.h>
 
namespace mitk { class RenderWindowBridge; }
 
#include <string>
#include <optional>
#include <vector>
#include <cstdint>
 
#include <MitkRESTAPIExports.h>
 
namespace mitk
{
  struct MITKRESTAPI_EXPORT RequestInfo
  {
    std::string endpoint;   
    std::string method;     
    int responseCode;       
    std::string clientIP;   
  };
 
  struct MITKRESTAPI_EXPORT IRestServerService
  {
    virtual ~IRestServerService();
 
    // Lifecycle
 
    virtual bool Start() = 0;
 
    virtual void Stop() = 0;
 
    virtual bool IsRunning() const = 0;
 
    // Configuration
 
    virtual void SetConfig(const RestServerConfig& config) = 0;
 
    virtual RestServerConfig GetPendingConfig() const = 0;
 
    virtual std::optional<RestServerConfig> GetRunningConfig() const = 0;
 
    // Render-window integration
 
    virtual RenderWindowBridge* GetRenderWindowBridge() = 0;
 
    // DataStorage connection
 
    virtual void SetDataStorage(DataStorage* dataStorage) = 0;
 
    virtual DataStorage::Pointer GetDataStorage() const = 0;
 
    // Status
 
    virtual std::optional<std::string> GetServerUrl() const = 0;
 
    virtual std::optional<std::string> GetLastError() const = 0;
 
    // Request tracking
 
    virtual std::vector<std::string> GetClientIPs() const = 0;
 
    virtual std::optional<RequestInfo> GetLastRequestInfo() const = 0;
 
    virtual void SetLogLimit(std::optional<unsigned int> limit) = 0;
 
    virtual std::optional<unsigned int> GetLogLimit() const = 0;
 
    virtual std::vector<RequestInfo> GetRequestLog() const = 0;
 
    virtual void ClearRequestLog() = 0;
 
    virtual uint64_t GetRequestLogVersion() const = 0;
 
    virtual std::optional<int64_t> GetUptimeSeconds() const = 0;
  };
}
 
MITK_DECLARE_SERVICE_INTERFACE(mitk::IRestServerService, "org.mitk.IRestServerService")
 
#endif