mitkRestServerConfig.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 mitkRestServerConfig_h
#define mitkRestServerConfig_h
 
#include <MitkRESTAPIExports.h>
#include <string>
#include <vector>
 
namespace mitk
{
  enum class ClientAccessMode
  {
    LocalhostOnly,  
    AllowAll,        
    Whitelist        
  };
 
  enum class FileAccessMode
  {
    Unrestricted,       
    AllowedDirectories  
  };
 
  struct MITKRESTAPI_EXPORT RestServerConfig
  {
    std::string host = "::";
    int port = 8080;                       
    bool enabled = false;                  
    int threadPoolSize = 4;                
    int readTimeoutSeconds = 30;           
    int writeTimeoutSeconds = 30;          
 
    ClientAccessMode clientAccessMode = ClientAccessMode::LocalhostOnly;  
    std::vector<std::string> allowedClientIPs;  
 
    bool requireAuth = false;              
    std::string apiToken;                  
 
    int maxPayloadSizeMB = 512;            
 
    FileAccessMode fileAccessMode = FileAccessMode::Unrestricted;  
    std::vector<std::string> allowedFileDirectories;  
 
    bool rateLimitEnabled = false;         
    int rateLimitPerMinute = 120;          
 
    size_t maxActiveTempDirsPerIp = 5;     
 
    bool httpsEnabled = false;             
    std::string sslCertPath;               
    std::string sslKeyPath;                
  };
 
  MITKRESTAPI_EXPORT std::string GetRestApiDocumentationUrl(int major, int minor, int patch);
}
 
#endif