irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::plugin_name_generator Class Reference

#include <irods_plugin_name_generator.hpp>

Public Types

typedef std::vector< std::string > plugin_list_t

Public Member Functions

 plugin_name_generator (void)
virtual ~plugin_name_generator (void)
virtual error operator() (const std::string &_base_name, const std::string &_dir_name, std::string &_rtn_soname)
bool exists (const std::string &_base_name, const std::string &_dir_name)
error list_plugins (const std::string &_dir_name, plugin_list_t &_list)

Private Member Functions

error generate_plugin_name (const std::string &filename, std::string &_rtn_name)

Detailed Description

Description:\n Functor for generating plugin filenames from the resource name

Definition at line 15 of file irods_plugin_name_generator.hpp.

Member Typedef Documentation

◆ plugin_list_t

typedef std::vector<std::string> irods::plugin_name_generator::plugin_list_t
Description:\n Container for plugin names as std::strings. Use stl iterators and consider it read only.

Definition at line 19 of file irods_plugin_name_generator.hpp.

Constructor & Destructor Documentation

◆ plugin_name_generator()

irods::plugin_name_generator::plugin_name_generator ( void  )
Description:\n ctor

Definition at line 29 of file irods_plugin_name_generator.cpp.

◆ ~plugin_name_generator()

irods::plugin_name_generator::~plugin_name_generator ( void  )

Definition at line 33 of file irods_plugin_name_generator.cpp.

Member Function Documentation

◆ exists()

bool irods::plugin_name_generator::exists ( const std::string &  _base_name,
const std::string &  _dir_name 
Description:\n Constructs a library name from the plugin name and returns true if the library exists and is readable.

Definition at line 68 of file irods_plugin_name_generator.cpp.

References irods::experimental::administration::client::v1::exists(), and irods::error::ok().

Referenced by _addResource().

Here is the call graph for this function:

◆ generate_plugin_name()

error irods::plugin_name_generator::generate_plugin_name ( const std::string &  filename,
std::string &  _rtn_name 
Description:\n Generates a plugin name from a shared object file name or an empty string if it is not a shared object.

Definition at line 135 of file irods_plugin_name_generator.cpp.

References SUCCESS.

Referenced by list_plugins().

◆ list_plugins()

error irods::plugin_name_generator::list_plugins ( const std::string &  _dir_name,
plugin_list_t _list 
Description:\n Searches the specified directory for libraries and returns a list of constructed plugin names.

Definition at line 87 of file irods_plugin_name_generator.cpp.

References ERROR, irods::experimental::administration::client::v1::exists(), generate_plugin_name(), irods::error::ok(), PASSMSG, and SUCCESS.

Referenced by _listRescTypes(), irods::add_plugin_type_to_json_array(), and msiListEnabledMS().

Here is the call graph for this function:

◆ operator()()

error irods::plugin_name_generator::operator() ( const std::string &  _base_name,
const std::string &  _dir_name,
std::string &  _rtn_soname 
Description:\n functor for generating the name from a base name and a directory

Definition at line 37 of file irods_plugin_name_generator.cpp.

References ERROR, irods::not_allowed_char(), SUCCESS, and SYS_INVALID_INPUT_PARAM.

Here is the call graph for this function:

The documentation for this class was generated from the following files: