netstorage_int.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef CONNECT_SERVICES_IMPL__NETSTORAGE_INT__HPP
#define CONNECT_SERVICES_IMPL__NETSTORAGE_INT__HPP
 
/*  $Id: netstorage_int.hpp 91249 2020-09-30 19:12:51Z sadyrovr $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Dmitry Kazimirov
 *
 * File Description:
 *   NetStorage implementation declarations.
 *
 */
 
#include <connect/services/compound_id.hpp>
#include <connect/services/netservice_api.hpp>
 
#include <corelib/ncbimisc.hpp>
 
BEGIN_NCBI_SCOPE
 
/// @internal
template <TNetStorageFlags MASK>
class CNetStorageFlagsSubset
{
    typedef CNetStorageFlagsSubset TSelf;
public:
    CNetStorageFlagsSubset(TNetStorageFlags flags) : m_Flags(flags & MASK) {}
    TSelf& operator &=(TSelf flag) { m_Flags &= flag; return *this; }
    TSelf& operator |=(TSelf flag) { m_Flags |= flag; return *this; }
    TSelf& operator ^=(TSelf flag) { m_Flags ^= flag; return *this; }
    operator TNetStorageFlags() const { return m_Flags; }
 
private:
    TNetStorageFlags m_Flags;
};
 
typedef CNetStorageFlagsSubset<fNST_AnyLoc> TNetStorageLocFlags;
typedef CNetStorageFlagsSubset<fNST_AnyAttr> TNetStorageAttrFlags;
 
/// @internal
class NCBI_XCONNECT_EXPORT CNetStorageObjectLoc
{
public:
    using TVersion = CNullable<int>;
 
    enum EFileTrackSite {
        eFileTrack_ProdSite = 0,
        eFileTrack_DevSite,
        eFileTrack_QASite,
        eNumberOfFileTrackSites
    };
 
    CNetStorageObjectLoc(CCompoundIDPool::TInstance cid_pool,
            TNetStorageAttrFlags flags,
            const string& app_domain,
            Uint8 random_number,
            EFileTrackSite ft_site);
    CNetStorageObjectLoc(CCompoundIDPool::TInstance cid_pool,
            TNetStorageAttrFlags flags,
            const string& app_domain,
            const string& unique_key,
            EFileTrackSite ft_site);
    CNetStorageObjectLoc(CCompoundIDPool::TInstance cid_pool,
            const string& object_loc);
 
    void SetServiceName(const string& service_name);
 
    bool HasServiceName() const {return m_LocatorFlags & fLF_NetStorageService;}
 
    string GetServiceName() const {return m_ServiceName;}
    static string GetServiceName(CCompoundID cid);
 
    ENetStorageObjectLocation GetLocation() const {return m_Location;}
 
    bool IsMetaDataDisabled() const
    {
        return (m_LocatorFlags & fLF_NoMetaData) != 0;
    }
 
    CTime GetCreationTime() const {return CTime(m_Timestamp);}
 
    bool HasUserKey() const {return (m_LocatorFlags & fLF_HasUserKey) != 0;}
    bool HasSubKey() const { return m_LocatorFlags & fLF_HasSubKey; }
 
    // These are intended to be used together
    string GetAppDomain() const {return m_AppDomain;}
    string GetShortUniqueKey() const {return m_ShortUniqueKey;}
 
    // This contains both of the above
    string GetUniqueKey() const {return m_UniqueKey;}
 
    const string& GetSubKey() const { return m_SubKey; }
    const TVersion& GetVersion() const { return m_Version; }
 
    void SetLocation(const string& nc_service_name);
 
    string GetNCServiceName() const {return m_NCServiceName;}
 
    EFileTrackSite GetFileTrackSite() const;
 
    string GetLocator() const
    {
        if (m_Dirty)
            x_Pack();
        return m_Locator;
    }
 
    TNetStorageAttrFlags GetStorageAttrFlags() const;
    void SetStorageAttrFlags(TNetStorageAttrFlags flags);
 
    // Serialize to a JSON object.
    void ToJSON(CJsonNode& root) const;
    CJsonNode ToJSON() const;
 
    static EFileTrackSite ParseFileTrackSite(const string& ft_site_name);
 
    // Create an object locator for an ICache blob
    static string Create(const string& service_name, const string& cache_name,
            const string& key, const string& subkey, const TVersion& version = null);
 
private:
    enum ELocatorFlags {
        fLF_NetStorageService   = (1 << 0),
        fLF_NoMetaData          = (1 << 1),
        fLF_HasObjectID         = (1 << 2),
        fLF_HasUserKey          = (1 << 3),
        fLF_Movable             = (1 << 4),
        fLF_Cacheable           = (1 << 5),
        fLF_DevEnv              = (1 << 6),
        fLF_QAEnv               = (1 << 7),
        fLF_HasSubKey           = (1 << 8),
        fLF_HasVersion          = (1 << 9),
 
        eLF_AttrFlags = (
                fLF_NoMetaData |
                fLF_Movable |
                fLF_Cacheable),
        eLF_FieldFlags = (
                fLF_NetStorageService |
                fLF_HasObjectID |
                fLF_HasUserKey |
                fLF_DevEnv |
                fLF_QAEnv)
    };
    typedef unsigned TLocatorFlags;
 
    CNetStorageObjectLoc() : m_CompoundIDPool(eVoid) {}
    void Parse(CCompoundID cid, bool service_name_only);
    string MakeShortUniqueKey() const;
    string MakeUniqueKey() const { return m_AppDomain + '-' + m_ShortUniqueKey; }
 
    void x_Pack() const;
    void SetLocatorFlags(TLocatorFlags flags) {m_LocatorFlags |= flags;}
    void ClearLocatorFlags(TLocatorFlags flags) {m_LocatorFlags &= ~flags;}
 
    static TLocatorFlags x_StorageFlagsToLocatorFlags(
            TNetStorageAttrFlags storage_flags,
            EFileTrackSite ft_site = eFileTrack_ProdSite);
 
    mutable CCompoundIDPool m_CompoundIDPool;
 
    TLocatorFlags m_LocatorFlags;
 
    // Not used, but still supported (for backward compatibility)
    Uint8 m_ObjectID = 0;
 
    string m_ServiceName;
    string m_LocationCode;
    ENetStorageObjectLocation m_Location = eNFL_Unknown;
 
    string m_AppDomain;
 
    Int8 m_Timestamp;
    Uint8 m_Random;
 
    // Either user key or key composed of timestamp, random value and object ID.
    string m_ShortUniqueKey;
    // The same as above plus app domain
    string m_UniqueKey;
 
    string m_SubKey;
    TVersion m_Version = 0;
 
    string m_NCServiceName;
 
    mutable bool m_Dirty;
 
    mutable string m_Locator;
};
 
/// @internal
class CNetStorageServerError
{
public:
    enum EErrCode {
        eInvalidArgument                    = 1001,
        eMandatoryFieldsMissed              = 1002,
        eHelloRequired                      = 1003,
        eInvalidMessageType                 = 1004,
        eInvalidIncomingMessage             = 1005,
        ePrivileges                         = 1006,
        eInvalidMessageHeader               = 1007,
        eShuttingDown                       = 1008,
        eMessageAfterBye                    = 1009,
        eStorageError                       = 1010,
        eWriteError                         = 1011,
        eReadError                          = 1012,
        eInternalError                      = 1013,
        eNetStorageObjectNotFound           = 1014,
        eNetStorageAttributeNotFound        = 1015,
        eNetStorageAttributeValueNotFound   = 1016,
        eNetStorageClientNotFound           = 1017,
        eNetStorageObjectExpired            = 1018,
        eDatabaseError                      = 1019,
        eInvalidConfig                      = 1020,
        eRemoteObjectNotFound               = 1021,
 
        // Meta info involving operation requested while the service
        // is not configured for meta or HELLO metadata option conflict
        eInvalidMetaInfoRequest             = 1022,
        eUnknownError                       = 1023
    };
};
 
/// @internal
struct SNetStorageAdminImpl;
 
/// @internal
class NCBI_XCONNECT_EXPORT CNetStorageAdmin
{
    NCBI_NET_COMPONENT(NetStorageAdmin);
 
    CNetStorageAdmin(CNetStorage::TInstance netstorage_impl);
 
    CNetService GetService();
 
    CJsonNode MkNetStorageRequest(const string& request_type);
 
    CJsonNode ExchangeJson(const CJsonNode& request,
            CNetServer::TInstance server_to_use = NULL,
            CNetServerConnection* conn = NULL);
 
    CNetStorageAdmin GetServer(CNetServer::TInstance server);
 
    CNetStorageObject Open(const string& object_loc);
};
 
END_NCBI_SCOPE
 
#endif  /* CONNECT_SERVICES_IMPL__NETSTORAGE_INT__HPP */