CrestApi.h

Go to the documentation of this file.

/*
   Copyright (C) 2019-2024 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef CRESTAPI_CRESAPI_H
#define CRESTAPI_CRESAPI_H
 
#include <string>
#include <map>
#include <list>
#include <iosfwd>
#include <cstdint>
#include "nlohmann/json.hpp"
#include <curl/curl.h>
#include <iostream>
#include <CrestApi/CrestModel.h>
#include <CrestApi/CrestApiBase.h>
#include <CrestApi/CrestRequest.h>
 
namespace Crest
{
 
    class CrestClient : public CrestApiBase
    {
    private:
        std::string makeUrl(const std::string &address) const;
 
        std::string m_PATH = DEFAULT_CREST_API_VERSION;
 
        inline static const std::string s_TAG_PATH = "/tags";
        inline static const std::string s_ADMIN_PATH = "/admin";
        inline static const std::string s_IOV_PATH = "/iovs";
 
        inline static const std::string s_IOV_SIZE_PATH = "/size";
 
        inline static const std::string s_GLOBALTAG_PATH = "/globaltags";
        inline static const std::string s_GLOBALTAG_MAP_PATH = "/globaltagmaps";
        inline static const std::string s_PAYLOAD_PATH = "/payloads";
        inline static const std::string s_MONITORING_PAYLOAD_PATH = "/monitoring/payloads";
        inline static const std::string s_META_PATH = "/meta";
        inline static const std::string s_DATA_PATH = "/data";
 
        inline static const std::string s_FOLDER_PATH = "/folders";
        inline static const std::string s_RUNINFO_PATH = "/runinfo";
        inline static const std::string s_RUNINFO_LIST_PATH = "/list";
 
        inline static const std::string s_METHOD_IOVS = "IOVS";
        inline static const std::string s_METHOD_GROUPS = "GROUPS";
 
        // CREST Server data paths:
        inline static const std::string s_MGMT_PATH = "/mgmt";
        inline static const std::string s_MGMT_INFO_PATH = "/info";
        inline static const std::string s_CREST_CLIENT_VERSION = "5.0";
        inline static const std::string s_MGMT_INFO_PATH_2 = "/actuator/info";
 
        // ... other constants
 
        std::string m_host;
        std::string m_port;
        std::string m_prefix = "http://";
 
        Crest::CrestRequest m_request = Crest::CrestRequest();
 
        nlohmann::json getMgmtInfo();
 
 
        std::string getCrestVersion() override;
 
        int getMajorVersion(std::string &str);
 
        nlohmann::json getJson(const std::string &str, const char *method) const;
 
        std::string parseXMLOutput(const std::string_view xmlBuffer) const;
 
        std::string removeCR(const std::string &str) const;
 
      void checkHash(const std::string &hash, const std::string &str, const char* method_name);
 
 
    public:
 
        CrestClient(const std::string &host, const std::string &port, bool checkVersion = false);
 
        CrestClient(std::string_view url, bool checkVersion = false);
      
        ~CrestClient();
 
        inline static const bool s_CREST_CLIENT_CHECK = false;
 
        void checkCrestVersion();
 
        // Overrides
      
        // GlobaTag methods
 
        void createGlobalTag(GlobalTagDto &globalTag) override;
 
        GlobalTagDto findGlobalTag(const std::string &name) override;
 
        GlobalTagSetDto listGlobalTags(const std::string &name, int size, int page, const std::string &sort) override;
 
        void removeGlobalTag(const std::string &name) override;
      
        // Tag methods
 
        void createTag(TagDto &tag) override;
 
        TagDto findTag(const std::string &name) override;
 
        TagSetDto listTags(const std::string &name, int size, int page, const std::string &sort) override;
 
        void removeTag(const std::string &name) override;
 
        int getSize(const std::string& tagname) override;
 
        // TagMeta methods
 
        void createTagMeta(TagMetaDto &tag) override;
 
        void updateTagMeta(TagMetaDto &tag) override;
 
        TagMetaDto findTagMeta(const std::string &name) override;
      
        // GlobalTagMap methods
 
        void createGlobalTagMap(GlobalTagMapDto& globalTagMap) override;
 
        GlobalTagMapSetDto findGlobalTagMap(const std::string& name, const std::string& xCrestMapMode) override;
 
        void removeGlobalTagMap(const std::string& name, const std::string& record, const std::string& label, const std::string& tagname) override;
 
        // Iovs
 
        IovSetDto selectIovs(const std::string &name, uint64_t since, uint64_t until, long snapshot, int size, int page, const std::string &sort) override;
 
        IovSetDto selectGroups(const std::string &name, long snapshot, int size, int page, const std::string &sort) override;
      
        // Payload methods
 
        void storeData(const std::string &tag,
                       const StoreSetDto &storeSetJson,
                 const std::string &payloadFormat="JSON",
                       const std::string &objectType="none",
                       const std::string &compressionType="none",
                       const std::string &version="1.0",
                       uint64_t endTime=-1) override;
 
        // Payload retrieval methods
 
        std::string getPayload(const std::string &hash) override;
 
        PayloadDto getPayloadMeta(const std::string &hash) override;
    };
 
} // namespace Crest
 
#endif // CRESTAPI_CRESTCLIENT_H