AliCDBStorage.h

Go to the documentation of this file.

#ifndef ALI_CDB_STORAGE_H
#define ALI_CDB_STORAGE_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

//                                                                 //
//  class AliCDBStorage              //
//  interface to specific storage classes                          //
//  (AliCDBGrid, AliCDBLocal, AliCDBDump)        //
//                                                                 //

#include "AliCDBId.h"
#include "AliCDBMetaData.h"
#include "AliCDBManager.h"

#include <TList.h>
#include <TObjArray.h>

class AliCDBEntry;
class AliCDBPath;
class AliCDBParam;
class TFile;

class AliCDBStorage: public TObject {

  public:

    AliCDBStorage();

    void SetURI(const TString& uri) {fURI = uri;}
    const TString& GetURI() const {return fURI;}
    const TString& GetType() const {return fType;}
    const TString& GetBaseFolder() const {return fBaseFolder;}
    AliCDBManager::DataType GetDataType() const;


    void ReadSelectionFromFile(const char *fileName);

    void AddSelection(const AliCDBId& selection);

    void AddSelection(const AliCDBPath& path, 
        const AliCDBRunRange& runRange,
        Int_t version,
        Int_t subVersion = -1);

    void AddSelection(const AliCDBPath& path,
        Int_t firstRun,
        Int_t lastRun,
        Int_t version,
        Int_t subVersion = -1);

    void RemoveSelection(const AliCDBId& selection);

    void RemoveSelection(const AliCDBPath& path,
        const AliCDBRunRange& runRange);

    void RemoveSelection(const AliCDBPath& path,
        Int_t firstRun = -1,
        Int_t lastRun = -1);

    void RemoveSelection(int position);
    void RemoveAllSelections();

    void PrintSelectionList();

    AliCDBEntry* Get(const AliCDBId& query);
    AliCDBEntry* Get(const AliCDBPath& path, Int_t runNumber,
        Int_t version = -1, Int_t subVersion = -1);
    AliCDBEntry* Get(const AliCDBPath& path, const AliCDBRunRange& runRange,
        Int_t version = -1, Int_t subVersion = -1);

    TList* GetAll(const AliCDBId& query);
    TList* GetAll(const AliCDBPath& path, Int_t runNumber, 
        Int_t version = -1, Int_t subVersion = -1);
    TList* GetAll(const AliCDBPath& path, const AliCDBRunRange& runRange,
        Int_t version = -1, Int_t subVersion = -1);

    AliCDBId* GetId(const AliCDBId& query);
    AliCDBId* GetId(const AliCDBPath& path, Int_t runNumber,
        Int_t version = -1, Int_t subVersion = -1);
    AliCDBId* GetId(const AliCDBPath& path, const AliCDBRunRange& runRange,
        Int_t version = -1, Int_t subVersion = -1);

    Bool_t Put(TObject* object, AliCDBId& id,  AliCDBMetaData* metaData, const char* mirrors="",
        AliCDBManager::DataType type=AliCDBManager::kPrivate);
    Bool_t Put(AliCDBEntry* entry, const char* mirrors="", AliCDBManager::DataType type=AliCDBManager::kPrivate);

    virtual void SetMirrorSEs(const char* mirrors);
    virtual const char* GetMirrorSEs() const;

    virtual Bool_t IsReadOnly() const = 0;
    virtual Bool_t HasSubVersion() const = 0;
    virtual Bool_t Contains(const char* path) const = 0;
    virtual Bool_t IdToFilename(const AliCDBId& id, TString& filename) const = 0;

    void QueryCDB(Int_t run, const char* pathFilter="*",
        Int_t version=-1, AliCDBMetaData *mdFilter=0);
    void PrintQueryCDB();
    TObjArray* GetQueryCDBList() {return &fValidFileIds;}
    virtual void SetRetry(Int_t nretry, Int_t initsec) = 0;
    void SetMaxDate(time_t maxDate);
    void SetMaxDate(TTimeStamp maxDate) { SetMaxDate(maxDate.GetSec()); }
    time_t GetMaxDate() const { return fMaxDate; }

  protected:

    virtual ~AliCDBStorage();
    void    GetSelection(/*const*/ AliCDBId* id);
    virtual AliCDBEntry* GetEntry(const AliCDBId& query) = 0;
    virtual AliCDBId* GetEntryId(const AliCDBId& query) = 0;
    virtual TList* GetEntries(const AliCDBId& query) = 0;
    virtual Bool_t PutEntry(AliCDBEntry* entry, const char* mirrors="") = 0;
    virtual TList *GetIdListFromFile(const char* fileName)=0;
    virtual void   QueryValidFiles() = 0;
    void  LoadTreeFromFile(AliCDBEntry* entry) const;
    //void  SetTreeToFile(AliCDBEntry* entry, TFile* file) const;
    time_t GuidToCreationTimestamp(const TString &guid) const;

    TObjArray fValidFileIds;  // list of Id's of the files valid for a given run (cached as fRun)
    Int_t fRun;           // run number, used to manage list of valid files
    AliCDBPath fPathFilter;         // path filter, used to manage list of valid files
    Int_t fVersion;           // version, used to manage list of valid files
    AliCDBMetaData* fMetaDataFilter; // metadata, used to manage list of valid files

    TList fSelections;  // list of selection criteria
    TString fURI;   // storage URI;
    TString fType;    
    TString fBaseFolder;    
    Short_t    fNretry;              // Number of retries in opening the file
    Short_t    fInitRetrySeconds;        // Seconds for first retry

    time_t fMaxDate;  // max file timestamp to take into account upon queries

  private:
    AliCDBStorage(const AliCDBStorage & source);
    AliCDBStorage & operator=(const AliCDBStorage & source);

    ClassDef(AliCDBStorage, 0);
};

#endif