mitkErrorResponse.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 mitkErrorResponse_h
#define mitkErrorResponse_h
 
#include <nlohmann/json.hpp>
#include <string>
#include <vector>
 
#include <MitkRESTAPIExports.h>
 
namespace mitk
{
  class MITKRESTAPI_EXPORT ErrorResponse
  {
  public:
    using Json = nlohmann::json;
 
    // Common error codes
    static constexpr const char* CODE_INVALID_REQUEST = "INVALID_REQUEST";
    static constexpr const char* CODE_NODE_NOT_FOUND = "NODE_NOT_FOUND";
    static constexpr const char* CODE_PROPERTY_NOT_FOUND = "PROPERTY_NOT_FOUND";
    static constexpr const char* CODE_DATASTORAGE_NOT_AVAILABLE = "DATASTORAGE_NOT_AVAILABLE";
    static constexpr const char* CODE_INTERNAL_ERROR = "INTERNAL_ERROR";
    static constexpr const char* CODE_PROPERTY_PROTECTED = "PROPERTY_PROTECTED";
    static constexpr const char* CODE_NODE_HAS_CHILDREN = "NODE_HAS_CHILDREN";
    static constexpr const char* CODE_NO_DATA = "NO_DATA";
    static constexpr const char* CODE_NO_GEOMETRY = "NO_GEOMETRY";
    static constexpr const char* CODE_RENDERING_ERROR = "RENDERING_ERROR";
    static constexpr const char* CODE_CIRCULAR_HIERARCHY_REFERENCE = "CIRCULAR_HIERARCHY_REFERENCE";
    static constexpr const char* CODE_UNSUPPORTED_FORMAT = "UNSUPPORTED_FORMAT";
    static constexpr const char* CODE_SERIALIZATION_ERROR = "SERIALIZATION_ERROR";
    static constexpr const char* CODE_FILE_NOT_FOUND = "FILE_NOT_FOUND";
    static constexpr const char* CODE_FILE_READ_ERROR = "FILE_READ_ERROR";
    static constexpr const char* CODE_TRANSFER_MODE_NOT_AVAILABLE = "TRANSFER_MODE_NOT_AVAILABLE";
    static constexpr const char* CODE_ACCESS_DENIED = "ACCESS_DENIED";
    static constexpr const char* CODE_UNAUTHORIZED = "UNAUTHORIZED";
    static constexpr const char* CODE_RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED";
    static constexpr const char* CODE_FILE_ACCESS_DENIED = "FILE_ACCESS_DENIED";
    static constexpr const char* CODE_RENDER_WINDOW_NOT_AVAILABLE = "RENDER_WINDOW_NOT_AVAILABLE";
    static constexpr const char* CODE_TIME_NAVIGATION_NOT_AVAILABLE = "TIME_NAVIGATION_NOT_AVAILABLE";
    static constexpr const char* CODE_TIME_STEPPER_NOT_AVAILABLE = "TIME_STEPPER_NOT_AVAILABLE";
    static constexpr const char* CODE_EDITOR_NOT_ACTIVE = "EDITOR_NOT_ACTIVE";
    static constexpr const char* CODE_RENDER_WINDOW_NOT_FOUND = "RENDER_WINDOW_NOT_FOUND";
    static constexpr const char* CODE_UNSUPPORTED_OPERATION = "UNSUPPORTED_OPERATION";
    static constexpr const char* CODE_RENDERER_UNAVAILABLE = "RENDERER_UNAVAILABLE";
 
    static Json Create(
      const std::string& code,
      const std::string& title,
      const std::string& detail,
      int status,
      const std::string& instance = "");
 
    static Json NodeNotFound(const std::string& uid, const std::string& instance = "");
 
    static Json PropertyNotFound(
      const std::string& propertyKey,
      const std::string& nodeUid,
      const std::string& instance = "");
 
    static Json DataStorageNotAvailable(const std::string& instance = "");
 
    static Json InvalidRequest(const std::string& detail, const std::string& instance = "");
 
    static Json InternalError(const std::string& detail, const std::string& instance = "");
 
    static Json PropertyProtected(const std::string& propertyKey, const std::string& instance = "");
 
    static Json NodeHasChildren(int childrenCount, const std::string& instance = "");
 
    static Json NoData(const std::string& nodeUid, const std::string& instance = "");
 
    static Json NoGeometry(const std::string& nodeUid, const std::string& instance = "");
 
    static Json RenderingError(const std::string& detail, const std::string& instance = "");
 
    static Json CircularHierarchyReference(const std::string& instance = "");
 
    static Json UnsupportedFormat(const std::string& detail, const std::string& instance = "");
 
    static Json SerializationError(const std::string& detail, const std::string& instance = "");
 
    static Json FileNotFound(const std::string& filePath, const std::string& instance = "");
 
    static Json FileReadError(const std::string& filePath, const std::string& detail, const std::string& instance = "");
 
    static Json TransferModeNotAvailable(
      const std::string& requestedMode,
      const std::vector<std::string>& availableModes,
      const std::string& instance = "");
 
    static Json AccessDenied(const std::string& detail, const std::string& instance = "");
 
    static Json Unauthorized(const std::string& detail, const std::string& instance = "");
 
    static Json RateLimitExceeded(int retryAfterSeconds, const std::string& instance = "");
 
    static Json FileAccessDenied(const std::string& detail, const std::string& instance = "");
 
    static Json RenderWindowNotAvailable(const std::string& instance = "");
 
    static Json TimeNavigationNotAvailable(const std::string& instance = "");
 
    static Json TimeStepperNotAvailable(const std::string& instance = "");
 
    static Json EditorNotActive(const std::string& detail, const std::string& instance = "");
 
    static Json RenderWindowNotFound(const std::string& windowId, const std::string& instance = "");
 
    static Json UnsupportedOperation(const std::string& detail, const std::string& instance = "");
 
    static Json RendererUnavailable(const std::string& windowId, const std::string& instance = "");
  };
}
 
#endif