IFileCatalog.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIFILECATALOG_IFILECATALOG_H
#define GAUDIFILECATALOG_IFILECATALOG_H

#include "GaudiKernel/IInterface.h"
#include <Gaudi/PluginService.h>
#include <string>
#include <utility>
#include <vector>

class IMessageSvc;

/*
 *   Gaudi namespace declaration
 */
namespace Gaudi {

  class GAUDI_API IFileCatalog : virtual public IInterface {

  public:
    DeclareInterfaceID( IFileCatalog, 2, 0 );

    using Factory = Gaudi::PluginService::Factory<IInterface*( const std::string&, IMessageSvc* )>;

    typedef std::pair<std::string, std::string> NamedItem;
    typedef std::vector<NamedItem>              Attributes;
    typedef std::vector<NamedItem>              Files;
    typedef std::vector<std::string>            Strings;

    virtual std::string createFID() const = 0;
    virtual const std::string& connectInfo() const = 0;
    virtual void init() = 0;
    virtual void commit() = 0;
    virtual void rollback() = 0;
    virtual bool readOnly() const = 0;
    virtual bool dirty() const = 0;
    virtual void getPFN( const std::string& fid, Files& files ) const = 0;
    virtual void getLFN( const std::string& fid, Files& files ) const = 0;
    virtual void getFID( Strings& fids ) const = 0;
    virtual bool existsPFN( const std::string& pfn ) const = 0;
    virtual std::string lookupPFN( const std::string& lfn ) const = 0;
    virtual bool existsLFN( const std::string& lfn ) const = 0;
    virtual std::string lookupLFN( const std::string& lfn ) const = 0;
    virtual bool existsFID( const std::string& fid ) const = 0;
    virtual void deleteFID( const std::string& FileID ) const = 0;
    virtual void registerPFN( const std::string& fid, const std::string& pfn, const std::string& ftype ) const = 0;
    virtual void registerLFN( const std::string& fid, const std::string& lfn ) const = 0;
    virtual void registerFID( const std::string& fid ) const = 0;
    virtual void renamePFN( const std::string& pfn, const std::string& new_pfn ) const = 0;
    virtual void deletePFN( const std::string& pfn ) const = 0;
    virtual void getMetaData( const std::string& fid, Attributes& attr ) const = 0;
    virtual std::string getMetaDataItem( const std::string& fid, const std::string& name ) const = 0;
    virtual void setMetaData( const std::string& fid, const std::string& name, const std::string& value ) const = 0;
    virtual void dropMetaData( const std::string& fid ) const = 0;
    virtual void dropMetaData( const std::string& fid, const std::string& attr ) const = 0;
  };
} /* End namespace Gaudi             */
#endif /* GAUDIFILECATALOG_IFILECATALOG_H */