//------------------------------------------------------------------------------
//! @file INamespaceGroup.hh
//! @author Georgios Bitzes <georgios.bitzes@cern.ch>
//------------------------------------------------------------------------------

/************************************************************************
 * EOS - the CERN Disk Storage System                                   *
 * Copyright (C) 2019 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/>.*
 ************************************************************************/

#pragma once
#include "namespace/Namespace.hh"
#include "namespace/interface/INamespaceStats.hh"
#include <map>
#include <string>

EOSNSNAMESPACE_BEGIN

//------------------------------------------------------------------------------
//! Forward declarations
//------------------------------------------------------------------------------
namespace common {
  class RWMutex;
}

class IContainerMDSvc;
class IFileMDSvc;
class IView;
class IFsView;
class IContainerMDChangeListener;
class IQuotaStats;
class IFileMDChangeListener;

//------------------------------------------------------------------------------
//! Interface object to hold ownership of all namespace objects.
//! Under construction..
//------------------------------------------------------------------------------
class INamespaceGroup {
public:
  //----------------------------------------------------------------------------
  //! Virtual destructor
  //----------------------------------------------------------------------------
  virtual ~INamespaceGroup() {}

  //----------------------------------------------------------------------------
  //! Initialize with the given configuration - must be called before any
  //! other function, and right after construction.
  //!
  //! Initialization may fail - in such case, "false" will be returned, and
  //! "err" will be filled out.
  //----------------------------------------------------------------------------
  virtual bool initialize(eos::common::RWMutex* mtx,
    const std::map<std::string, std::string> &config, std::string &err, INamespaceStats * namespaceStats) = 0;

  //----------------------------------------------------------------------------
  //! Provide file service
  //----------------------------------------------------------------------------
  virtual IFileMDSvc* getFileService() = 0;

  //----------------------------------------------------------------------------
  //! Provide container service
  //----------------------------------------------------------------------------
  virtual IContainerMDSvc* getContainerService() = 0;

  //----------------------------------------------------------------------------
  //! Provide hierarchical view
  //----------------------------------------------------------------------------
  virtual IView* getHierarchicalView() = 0;

  //----------------------------------------------------------------------------
  //! Provide filesystem view
  //----------------------------------------------------------------------------
  virtual IFsView* getFilesystemView() = 0;

  //----------------------------------------------------------------------------
  //! Provide sync time accounting view
  //----------------------------------------------------------------------------
  virtual IContainerMDChangeListener* getSyncTimeAccountingView() = 0;

  //----------------------------------------------------------------------------
  //! Provide container accounting view
  //----------------------------------------------------------------------------
  virtual IFileMDChangeListener* getContainerAccountingView() = 0;

  //----------------------------------------------------------------------------
  //! Provide quota stats
  //----------------------------------------------------------------------------
  virtual IQuotaStats* getQuotaStats() = 0;

  //----------------------------------------------------------------------------
  //! Is this in-memory namespace?
  //----------------------------------------------------------------------------
  virtual bool isInMemory() = 0;

  //----------------------------------------------------------------------------
  //! Start cache refresh listener
  //----------------------------------------------------------------------------
  virtual void startCacheRefreshListener() = 0;

protected:
  //----------------------------------------------------------------------------
  //! Global namespace mutex - no ownership
  //----------------------------------------------------------------------------
  eos::common::RWMutex* mNsMutex;

  //----------------------------------------------------------------------------
  //! MGM Namespace stats object - no ownership
  //----------------------------------------------------------------------------
  eos::INamespaceStats * mNamespaceStats;
};

EOSNSNAMESPACE_END