//------------------------------------------------------------------------------
//! @file IMgmFileSystemInterface.hh
//! @author Cedric Caffy - CERN
//------------------------------------------------------------------------------

/************************************************************************
 * EOS - the CERN Disk Storage System                                   *
 * Copyright (C) 2017 CERN/Switzerland                                  *
 *                                                                      *
 * This program is free software: you can redistribute it and/or modify *
 * it under the terms of the GNU General Public License as published by *
 * the Free Software Foundation, either version 3 of the License, or    *
 * (at your option) any later version.                                  *
 *                                                                      *
 * This program is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
 * GNU General Public License for more details.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.*
 ************************************************************************/

#ifndef EOS_IMGMFILESYSTEMINTERFACE_HH
#define EOS_IMGMFILESYSTEMINTERFACE_HH

#include "mgm/Namespace.hh"
#include "XrdOuc/XrdOucErrInfo.hh"
#include "XrdSfs/XrdSfsInterface.hh"
#include "XrdSec/XrdSecEntity.hh"
#include "common/VirtualIdentity.hh"
#include "namespace/interface/IContainerMD.hh"

EOSBULKNAMESPACE_BEGIN

/**
 * This interface has mainly been created in order to allow
 * the unit testing of the PrepareManager. There will be two implementation,
 * one that will use the gOFS variable, the other will have its own
 * implementations allowing the unit testing.
 */
class IMgmFileSystemInterface
{
public:
  virtual void addStats(const char* tag, uid_t uid, gid_t gid,
                        unsigned long val) = 0;
  virtual bool isTapeEnabled() = 0;
  virtual int Emsg(const char* pfx, XrdOucErrInfo& einfo, int ecode,
                   const char* op, const char* target = "") = 0;
  virtual int _exists(const char* path, XrdSfsFileExistence& file_exists,
                      XrdOucErrInfo& error, const XrdSecEntity* client = 0,
                      const char* ininfo = 0) = 0;
  virtual int _exists(const char* path, XrdSfsFileExistence& file_exists,
                      XrdOucErrInfo& error, eos::common::VirtualIdentity& vid, const char* opaque = 0,
                      bool take_lock = true) = 0;
  virtual int _attr_ls(const char* path, XrdOucErrInfo& out_error,
                       const eos::common::VirtualIdentity& vid, const char* opaque,
                       eos::IContainerMD::XAttrMap& map,
                       bool links = false) = 0;
  virtual int _access(const char* path, int mode, XrdOucErrInfo& error,
                      eos::common::VirtualIdentity& vid, const char* info) = 0;
  virtual int FSctl(const int cmd, XrdSfsFSctl& args, XrdOucErrInfo& error,
                    const XrdSecEntity* client) = 0;
  virtual int _stat(const char* Name, struct stat* buf, XrdOucErrInfo& out_error,
                    eos::common::VirtualIdentity& vid, const char* opaque = 0,
                    std::string* etag = 0, bool follow = true, std::string* uri = 0) = 0;
  virtual void _stat_set_flags(struct stat* buf) = 0;
  virtual std::string get_logId() = 0;
  virtual std::string get_host() = 0;
  virtual void writeEosReportRecord(const std::string& record) = 0;
  virtual ~IMgmFileSystemInterface() {}
};

EOSBULKNAMESPACE_END

#endif // EOS_IMGMFILESYSTEMINTERFACE_HH