CrestApiBase.h

Go to the documentation of this file.

/*
   Copyright (C) 2019-2024 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef CRESTAPI_CRESAPIBASE_H
#define CRESTAPI_CRESAPIBASE_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>
 
#define DEFAULT_CREST_API_VERSION "/api-v5.0"
 
namespace Crest
{
 
class CrestApiBase {
 
private:
 
   inline static const std::string s_CREST_CLIENT_VERSION = "5.0";
  
protected:
 
    std::string getHash(std::string_view str);
 
    std::string getHashForFile(const std::string &file);
 
    const std::string& getClientVersion();
 
 
public:
    virtual ~CrestApiBase() = default;
    // GlobaTag methods
 
    virtual void createGlobalTag(GlobalTagDto& globalTag) = 0;
 
 
    virtual GlobalTagDto findGlobalTag(const std::string& name) = 0;
 
    virtual GlobalTagSetDto listGlobalTags(const std::string& name, int size, int page, const std::string& sort) = 0;
 
    virtual void removeGlobalTag(const std::string& name) = 0;
  
    // Tag methods
 
    virtual void createTag(TagDto& tag) = 0;
 
    virtual TagDto findTag(const std::string& name) = 0;
 
    virtual TagSetDto listTags(const std::string& name, int size, int page, const std::string& sort) = 0;
 
    virtual void removeTag(const std::string& name) = 0;
 
    virtual int getSize(const std::string& tagname) = 0;
 
    // Tag Meta Info methods
 
    virtual void createTagMeta(TagMetaDto& tag) = 0;
 
    virtual void updateTagMeta(TagMetaDto& tag) = 0;
 
    virtual TagMetaDto findTagMeta(const std::string& name) = 0;
 
 
    // IOV methods
 
    virtual IovSetDto selectIovs(const std::string& name, uint64_t since, uint64_t until, long snapshot, int size, int page, const std::string& sort) = 0;
 
    virtual IovSetDto selectGroups(const std::string& name, long snapshot, int size, int page, const std::string& sort) = 0;
 
    // GlobalTagMap methods
 
    virtual void createGlobalTagMap(GlobalTagMapDto& globalTagMap) = 0;
 
    virtual GlobalTagMapSetDto findGlobalTagMap(const std::string& name, const std::string& xCrestMapMode) = 0;
 
    virtual void removeGlobalTagMap(const std::string& name, const std::string& record, const std::string& label, const std::string& tagname) = 0;
 
    // Payload methods
 
    virtual void storeData(const std::string& tag,
                       const StoreSetDto& storeSetJson,
                         const std::string& payloadFormat,
                       const std::string& objectType,
                       const std::string& compressionType,
                       const std::string& version,
                       uint64_t endTime) = 0;
 
  
    // Payload retrieval methods
 
    virtual std::string getPayload(const std::string& hash) = 0;
 
    virtual PayloadDto getPayloadMeta(const std::string& hash) = 0;
 
    virtual std::string getCrestVersion() = 0;
 
 
};
 
} // namespace Crest
 
#endif // CRESTAPI_CRESTCLIENT_H