XrdClPlugInManager.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2014 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// This file is part of the XRootD software suite.
//
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD 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 Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//
// 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 __XRD_CL_PLUGIN_MANAGER__
#define __XRD_CL_PLUGIN_MANAGER__
 
#include "XrdCl/XrdClPlugInInterface.hh"
#include "XrdOuc/XrdOucPinLoader.hh"
#include "XrdSys/XrdSysPthread.hh"
 
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
class PlugInManagerFixture;
 
namespace XrdCl
{
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class PlugInManager
  {
    friend class ::PlugInManagerFixture;
 
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      PlugInManager();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~PlugInManager();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool RegisterFactory( const std::string &url,
                            PlugInFactory     *factory );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool RegisterDefaultFactory( PlugInFactory *factory );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      PlugInFactory *GetFactory( const std::string url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessEnvironmentSettings();
 
    private:
      typedef void *(*PlugInFunc_t)( const void *arg );
 
      struct FactoryHelper
      {
        FactoryHelper(): plugin(0), factory(0), isEnv(false), counter(0) {}
        ~FactoryHelper()
        {
          delete factory;
          if(plugin) plugin->Unload();
          delete plugin;
        }
        XrdOucPinLoader *plugin;
        PlugInFactory   *factory;
        bool             isEnv;
        uint32_t         counter;
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessConfigDir( const std::string &dir );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessConfigDirs( const std::vector<std::string> &dirs );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessConfigDir( const std::string     &dir,
                             std::set<std::string> &settled );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessPlugInConfig( const std::string &confFile );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ProcessPlugInConfig( const std::string           &confFile,
                                const std::set<std::string> &settled,
                                std::set<std::string>       &decided );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::pair<XrdOucPinLoader*,PlugInFactory*> LoadFactory(
        const std::string                        &lib,
        const std::map<std::string, std::string> &config );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool RegisterFactory( const std::string &urlString,
                            const std::string &lib,
                            PlugInFactory     *factory,
                            XrdOucPinLoader   *plugin );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::string NormalizeURL( const std::string url );
 
      std::map<std::string, FactoryHelper*>  pFactoryMap;
      FactoryHelper                         *pDefaultFactory;
      XrdSysMutex                            pMutex;
  };
}
 
#endif // __XRD_CL_PLUGIN_MANAGER__