irods::plugin_context Class Reference

#include <irods_plugin_context.hpp>

Collaboration diagram for irods::plugin_context:

Public Member Functions
	plugin_context (irods::plugin_property_map &_prop_map, first_class_object_ptr _fco, const std::string &_results)
	plugin_context (rsComm_t *_comm, irods::plugin_property_map &_prop_map, first_class_object_ptr _fco, const std::string &_results)
plugin_context &	operator= (plugin_context other)
	plugin_context (rsComm_t *_comm, irods::plugin_property_map &_prop_map)
virtual	~plugin_context ()
virtual error	valid ()
template<typename OBJ_TYPE >
error	valid ()
virtual rsComm_t *	comm ()
virtual irods::plugin_property_map &	prop_map ()
virtual first_class_object_ptr	fco ()
virtual const std::string	rule_results ()
virtual void	comm (rsComm_t *_c)
virtual void	rule_results (const std::string &_s)

Protected Attributes
rsComm_t *	comm_
irods::plugin_property_map *	prop_map_
first_class_object_ptr	fco_
std::string	results_

Friends
void	swap (plugin_context &first, plugin_context &second)

Detailed Description

Definition at line 18 of file irods_plugin_context.hpp.

Constructor & Destructor Documentation

plugin_context() [1/3]

irods::plugin_context::plugin_context ( irods::plugin_property_map &  _prop_map, first_class_object_ptr  _fco, const std::string &  _results  )

inline

Definition at line 22 of file irods_plugin_context.hpp.

plugin_context() [2/3]

irods::plugin_context::plugin_context ( rsComm_t *  _comm, irods::plugin_property_map &  _prop_map, first_class_object_ptr  _fco, const std::string &  _results  )

inline

Definition at line 35 of file irods_plugin_context.hpp.

plugin_context() [3/3]

irods::plugin_context::plugin_context ( rsComm_t *  _comm, irods::plugin_property_map &  _prop_map  )

inline

Definition at line 54 of file irods_plugin_context.hpp.

~plugin_context()

virtual irods::plugin_context::~plugin_context ( )

inlinevirtual

Definition at line 71 of file irods_plugin_context.hpp.

Member Function Documentation

comm() [1/2]

virtual rsComm_t* irods::plugin_context::comm ( )

inlinevirtual

Definition at line 95 of file irods_plugin_context.hpp.

References comm_.

Referenced by call_rebalance_on_children(), compound_file_close(), compound_file_closedir(), compound_file_create(), compound_file_getfs_freespace(), compound_file_lseek(), compound_file_mkdir(), compound_file_open(), compound_file_opendir(), compound_file_read(), compound_file_readdir(), compound_file_rebalance(), compound_file_redirect_create(), compound_file_redirect_unlink(), compound_file_rename(), compound_file_rmdir(), compound_file_stage_to_cache(), compound_file_stat(), compound_file_sync_to_arch(), compound_file_truncate(), compound_file_unlink(), compound_file_write(), create_replication_list(), irods::data_obj_repl_with_retry(), db_add_avu_metadata_wild_op(), db_add_child_resc_op(), db_check_and_get_object_id_op(), db_check_auth_op(), db_del_child_resc_op(), db_del_coll_by_admin_op(), db_del_coll_op(), db_del_resc_op(), db_del_rule_exec_op(), db_del_user_re_op(), db_del_zone_op(), db_make_limited_pw_op(), db_make_temp_pw_op(), db_mod_coll_op(), db_mod_data_obj_meta_op(), db_mod_group_op(), db_mod_resc_data_paths_op(), db_mod_resc_freespace_op(), db_mod_resc_op(), db_mod_rule_exec_op(), db_mod_user_op(), db_mod_zone_coll_acl_op(), db_mod_zone_op(), db_reg_coll_by_admin_op(), db_reg_coll_op(), db_reg_data_obj_op(), db_reg_replica_op(), db_reg_resc_op(), db_reg_rule_exec_op(), db_reg_user_re_op(), db_reg_zone_op(), db_rename_coll_op(), db_rename_local_zone_op(), db_set_avu_metadata_op(), db_simple_query_op_vector(), db_unreg_replica_op(), deferred_file_close(), deferred_file_closedir(), deferred_file_create(), deferred_file_getfs_freespace(), deferred_file_lseek(), deferred_file_mkdir(), deferred_file_modified(), deferred_file_notify(), deferred_file_open(), deferred_file_opendir(), deferred_file_read(), deferred_file_readdir(), deferred_file_rebalance(), deferred_file_registered(), deferred_file_rename(), deferred_file_rmdir(), deferred_file_stage_to_cache(), deferred_file_stat(), deferred_file_sync_to_arch(), deferred_file_truncate(), deferred_file_unlink(), deferred_file_unregistered(), deferred_file_write(), deferred_redirect_for_operation(), get_load_lists(), get_next_valid_child_resource(), load_balanced_file_close(), load_balanced_file_closedir(), load_balanced_file_create(), load_balanced_file_getfs_freespace(), load_balanced_file_lseek(), load_balanced_file_mkdir(), load_balanced_file_modified(), load_balanced_file_notify(), load_balanced_file_open(), load_balanced_file_opendir(), load_balanced_file_read(), load_balanced_file_readdir(), load_balanced_file_rebalance(), load_balanced_file_registered(), load_balanced_file_rename(), load_balanced_file_rmdir(), load_balanced_file_stage_to_cache(), load_balanced_file_stat(), load_balanced_file_sync_to_arch(), load_balanced_file_truncate(), load_balanced_file_unlink(), load_balanced_file_unregistered(), load_balanced_file_write(), load_balanced_redirect_for_create_operation(), load_balanced_redirect_for_open_operation(), open_for_prefer_archive_policy(), open_for_prefer_cache_policy(), passthru_file_close(), passthru_file_closedir(), passthru_file_create(), passthru_file_getfs_freespace(), passthru_file_lseek(), passthru_file_mkdir(), passthru_file_modified(), passthru_file_notify(), passthru_file_open(), passthru_file_opendir(), passthru_file_read(), passthru_file_readdir(), passthru_file_rebalance(), passthru_file_registered(), passthru_file_rename(), passthru_file_resolve_hierarchy(), passthru_file_rmdir(), passthru_file_stage_to_cache(), passthru_file_stat(), passthru_file_sync_to_arch(), passthru_file_truncate(), passthru_file_unlink(), passthru_file_unregistered(), passthru_file_write(), random_file_close(), random_file_closedir(), random_file_create(), random_file_getfs_freespace(), random_file_lseek(), random_file_mkdir(), random_file_modified(), random_file_notify(), random_file_open(), random_file_opendir(), random_file_read(), random_file_readdir(), random_file_rebalance(), random_file_registered(), random_file_rename(), random_file_resolve_hierarchy(), random_file_rmdir(), random_file_stage_to_cache(), random_file_stat(), random_file_sync_to_arch(), random_file_truncate(), random_file_unlink(), random_file_unregistered(), random_file_write(), repl_file_close(), repl_file_closedir(), repl_file_create(), repl_file_getfs_freespace(), repl_file_lseek(), repl_file_mkdir(), repl_file_modified(), repl_file_notify(), repl_file_open(), repl_file_opendir(), repl_file_read(), repl_file_readdir(), repl_file_registered(), repl_file_rename(), repl_file_rmdir(), repl_file_stage_to_cache(), repl_file_stat(), repl_file_sync_to_arch(), repl_file_truncate(), repl_file_unlink(), repl_file_write(), repl_object(), irods::create_write_replicator::replicate(), irods::impostor_resource::report_error(), resolve_children(), round_robin_file_close(), round_robin_file_closedir(), round_robin_file_create(), round_robin_file_getfs_freespace(), round_robin_file_lseek(), round_robin_file_mkdir(), round_robin_file_modified(), round_robin_file_notify(), round_robin_file_open(), round_robin_file_opendir(), round_robin_file_read(), round_robin_file_readdir(), round_robin_file_rebalance(), round_robin_file_registered(), round_robin_file_rename(), round_robin_file_resolve_hierarchy(), round_robin_file_rmdir(), round_robin_file_stage_to_cache(), round_robin_file_stat(), round_robin_file_sync_to_arch(), round_robin_file_truncate(), round_robin_file_unlink(), round_robin_file_unregistered(), round_robin_file_write(), tar_file_closedir(), tar_file_readdir(), irods::update_out_of_date_replicas(), and verify_non_root_vault_path().

comm() [2/2]

virtual void irods::plugin_context::comm ( rsComm_t *  _c )

inlinevirtual

Definition at line 111 of file irods_plugin_context.hpp.

References comm_.

fco()

virtual first_class_object_ptr irods::plugin_context::fco ( )

inlinevirtual

Definition at line 102 of file irods_plugin_context.hpp.

References fco_.

Referenced by call_rebalance_on_children(), compound_file_close(), compound_file_closedir(), compound_file_create(), compound_file_getfs_freespace(), compound_file_lseek(), compound_file_mkdir(), compound_file_modified(), compound_file_open(), compound_file_opendir(), compound_file_read(), compound_file_readdir(), compound_file_rebalance(), compound_file_redirect_create(), compound_file_redirect_unlink(), compound_file_rename(), compound_file_rmdir(), compound_file_stage_to_cache(), compound_file_stat(), compound_file_sync_to_arch(), compound_file_truncate(), compound_file_unlink(), compound_file_write(), create_replication_list(), deferred_file_close(), deferred_file_closedir(), deferred_file_create(), deferred_file_getfs_freespace(), deferred_file_lseek(), deferred_file_mkdir(), deferred_file_modified(), deferred_file_notify(), deferred_file_open(), deferred_file_opendir(), deferred_file_read(), deferred_file_readdir(), deferred_file_rebalance(), deferred_file_registered(), deferred_file_rename(), deferred_file_rmdir(), deferred_file_stage_to_cache(), deferred_file_stat(), deferred_file_sync_to_arch(), deferred_file_truncate(), deferred_file_unlink(), deferred_file_unregistered(), deferred_file_write(), deferred_get_resc_for_call(), deferred_redirect_for_operation(), get_cache_resc(), get_next_child(), get_next_valid_child_resource(), get_selected_hierarchy(), impostor_file_resolve_hierarchy(), load_balanced_file_close(), load_balanced_file_closedir(), load_balanced_file_create(), load_balanced_file_getfs_freespace(), load_balanced_file_lseek(), load_balanced_file_mkdir(), load_balanced_file_modified(), load_balanced_file_notify(), load_balanced_file_open(), load_balanced_file_opendir(), load_balanced_file_read(), load_balanced_file_readdir(), load_balanced_file_rebalance(), load_balanced_file_registered(), load_balanced_file_rename(), load_balanced_file_resolve_hierarchy(), load_balanced_file_rmdir(), load_balanced_file_stage_to_cache(), load_balanced_file_stat(), load_balanced_file_sync_to_arch(), load_balanced_file_truncate(), load_balanced_file_unlink(), load_balanced_file_unregistered(), load_balanced_file_write(), load_balanced_get_resc_for_call(), load_balanced_redirect_for_create_operation(), load_balanced_redirect_for_open_operation(), mock_archive_file_mkdir(), mock_archive_file_rename(), mock_archive_file_resolve_hierarchy(), mock_archive_file_stage_to_cache(), mock_archive_file_sync_to_arch(), mock_archive_file_truncate(), mock_archive_file_unlink(), native_auth_client_request(), native_auth_client_response(), native_auth_client_start(), native_auth_establish_context(), non_blocking_check_path(), non_blocking_file_close(), non_blocking_file_closedir(), non_blocking_file_create(), non_blocking_file_getfs_freespace(), non_blocking_file_lseek(), non_blocking_file_mkdir(), non_blocking_file_open(), non_blocking_file_opendir(), non_blocking_file_read(), non_blocking_file_readdir(), non_blocking_file_rename(), non_blocking_file_resolve_hierarchy(), non_blocking_file_rmdir(), non_blocking_file_stage_to_cache(), non_blocking_file_stat(), non_blocking_file_sync_to_arch(), non_blocking_file_truncate(), non_blocking_file_unlink(), non_blocking_file_write(), open_for_prefer_archive_policy(), open_for_prefer_cache_policy(), osauth_auth_client_request(), osauth_auth_client_response(), osauth_auth_client_start(), osauth_auth_establish_context(), pam_auth_client_request(), pam_auth_client_start(), passthru_file_close(), passthru_file_closedir(), passthru_file_create(), passthru_file_getfs_freespace(), passthru_file_lseek(), passthru_file_mkdir(), passthru_file_modified(), passthru_file_notify(), passthru_file_open(), passthru_file_opendir(), passthru_file_read(), passthru_file_readdir(), passthru_file_rebalance(), passthru_file_registered(), passthru_file_rename(), passthru_file_resolve_hierarchy(), passthru_file_rmdir(), passthru_file_stage_to_cache(), passthru_file_stat(), passthru_file_sync_to_arch(), passthru_file_truncate(), passthru_file_unlink(), passthru_file_unregistered(), passthru_file_write(), random_file_close(), random_file_closedir(), random_file_create(), random_file_getfs_freespace(), random_file_lseek(), random_file_mkdir(), random_file_modified(), random_file_notify(), random_file_open(), random_file_opendir(), random_file_read(), random_file_readdir(), random_file_rebalance(), random_file_registered(), random_file_rename(), random_file_resolve_hierarchy(), random_file_rmdir(), random_file_stage_to_cache(), random_file_stat(), random_file_sync_to_arch(), random_file_truncate(), random_file_unlink(), random_file_unregistered(), random_file_write(), random_get_resc_for_call(), repl_file_close(), repl_file_closedir(), repl_file_create(), repl_file_getfs_freespace(), repl_file_lseek(), repl_file_mkdir(), repl_file_modified(), repl_file_notify(), repl_file_open(), repl_file_opendir(), repl_file_read(), repl_file_readdir(), repl_file_registered(), repl_file_rename(), repl_file_rmdir(), repl_file_stage_to_cache(), repl_file_stat(), repl_file_sync_to_arch(), repl_file_truncate(), repl_file_unlink(), repl_file_unregistered(), repl_file_write(), repl_object(), replUpdateObjectAndOperProperties(), resolve_children(), round_robin_file_close(), round_robin_file_closedir(), round_robin_file_create(), round_robin_file_getfs_freespace(), round_robin_file_lseek(), round_robin_file_mkdir(), round_robin_file_modified(), round_robin_file_notify(), round_robin_file_open(), round_robin_file_opendir(), round_robin_file_read(), round_robin_file_readdir(), round_robin_file_rebalance(), round_robin_file_registered(), round_robin_file_rename(), round_robin_file_resolve_hierarchy(), round_robin_file_rmdir(), round_robin_file_stage_to_cache(), round_robin_file_stat(), round_robin_file_sync_to_arch(), round_robin_file_truncate(), round_robin_file_unlink(), round_robin_file_unregistered(), round_robin_file_write(), round_robin_get_resc_for_call(), ssl_agent_start(), ssl_agent_stop(), ssl_client_start(), ssl_client_stop(), ssl_read_msg_body(), ssl_read_msg_header(), ssl_send_rods_msg(), ssl_write_msg_header(), tar_file_close(), tar_file_closedir(), tar_file_create(), tar_file_extract(), tar_file_lseek(), tar_file_mkdir(), tar_file_open(), tar_file_opendir(), tar_file_read(), tar_file_readdir(), tar_file_rename(), tar_file_rmdir(), tar_file_stat(), tar_file_sync(), tar_file_truncate(), tar_file_unlink(), tar_file_write(), tcp_read_msg_body(), tcp_read_msg_header(), tcp_send_rods_msg(), tcp_write_msg_header(), univ_mss_file_chmod(), univ_mss_file_mkdir(), univ_mss_file_rename(), univ_mss_file_resolve_hierarchy(), univ_mss_file_stage_to_cache(), univ_mss_file_stat(), univ_mss_file_sync_to_arch(), univ_mss_file_unlink(), unix_check_path(), unix_file_close(), unix_file_closedir(), unix_file_create(), unix_file_getfs_freespace(), unix_file_lseek(), unix_file_mkdir(), unix_file_open(), unix_file_opendir(), unix_file_read(), unix_file_readdir(), unix_file_rename(), unix_file_resolve_hierarchy(), unix_file_rmdir(), unix_file_stage_to_cache(), unix_file_stat(), unix_file_sync_to_arch(), unix_file_truncate(), unix_file_unlink(), unix_file_write(), and unix_resolve_hierarchy_create().

operator=()

plugin_context& irods::plugin_context::operator= ( plugin_context  other )

inline

Definition at line 49 of file irods_plugin_context.hpp.

References swap.

prop_map()

virtual irods::plugin_property_map& irods::plugin_context::prop_map ( )

inlinevirtual

Definition at line 99 of file irods_plugin_context.hpp.

References prop_map_.

Referenced by add_self_to_hierarchy(), auto_replication_is_enabled(), call_rebalance_on_children(), capture_weight(), compound_file_modified(), compound_file_notify(), compound_file_rebalance(), compound_file_redirect_create(), compound_file_redirect_open(), compound_file_redirect_unlink(), compound_file_resolve_hierarchy(), create_replication_list(), irods::data_obj_repl_with_retry(), db_add_child_resc_op(), db_check_and_get_object_id_op(), db_check_auth_op(), db_del_child_resc_op(), db_del_resc_op(), db_del_user_re_op(), db_get_local_zone_op(), db_mod_data_obj_meta_op(), db_mod_group_op(), db_mod_resc_data_paths_op(), db_mod_resc_op(), db_mod_user_op(), db_mod_zone_op(), db_reg_coll_by_admin_op(), db_reg_data_obj_op(), db_reg_replica_op(), db_reg_resc_op(), db_reg_user_re_op(), db_rename_local_zone_op(), db_set_avu_metadata_op(), db_unreg_replica_op(), db_update_pam_password_op(), deferred_file_rebalance(), deferred_file_resolve_hierarchy(), deferred_get_resc_for_call(), deferred_redirect_for_operation(), get_archive(), get_cache(), get_next_child(), get_next_valid_child_resource(), get_selected_hierarchy(), impostor_file_resolve_hierarchy(), load_balanced_file_rebalance(), load_balanced_file_resolve_hierarchy(), load_balanced_get_resc_for_call(), load_balanced_redirect_for_create_operation(), load_balanced_redirect_for_open_operation(), mock_archive_file_rename(), mock_archive_file_resolve_hierarchy(), mock_archive_file_stage_to_cache(), mock_archive_file_sync_to_arch(), non_blocking_check_path(), non_blocking_file_rename(), non_blocking_file_resolve_hierarchy(), open_for_prefer_archive_policy(), passthru_file_close(), passthru_file_closedir(), passthru_file_create(), passthru_file_getfs_freespace(), passthru_file_lseek(), passthru_file_mkdir(), passthru_file_modified(), passthru_file_notify(), passthru_file_open(), passthru_file_opendir(), passthru_file_read(), passthru_file_readdir(), passthru_file_rebalance(), passthru_file_registered(), passthru_file_rename(), passthru_file_resolve_hierarchy(), passthru_file_rmdir(), passthru_file_stage_to_cache(), passthru_file_stat(), passthru_file_sync_to_arch(), passthru_file_truncate(), passthru_file_unlink(), passthru_file_unregistered(), passthru_file_write(), proc_child_list_for_create_policy(), random_file_rebalance(), random_file_resolve_hierarchy(), random_get_resc_for_call(), repl_file_close(), repl_file_create(), repl_file_modified(), repl_file_rebalance(), repl_file_write(), repl_object(), replGetNextRescInHier(), replica_exceeds_resource_free_space(), replicate_create_write_operation(), replUpdateObjectAndOperProperties(), irods::impostor_resource::report_error(), resolve_children(), round_robin_file_modified(), round_robin_file_rebalance(), round_robin_file_resolve_hierarchy(), round_robin_get_resc_for_call(), select_child(), ssl_agent_start(), ssl_client_start(), tar_file_extract(), univ_mss_file_chmod(), univ_mss_file_mkdir(), univ_mss_file_rename(), univ_mss_file_resolve_hierarchy(), univ_mss_file_stage_to_cache(), univ_mss_file_stat(), univ_mss_file_sync_to_arch(), univ_mss_file_unlink(), unix_check_path(), unix_file_rename(), unix_file_resolve_hierarchy(), unix_resolve_hierarchy_create(), and warn_if_deprecated_context_string_set().

rule_results() [1/2]

virtual const std::string irods::plugin_context::rule_results ( )

inlinevirtual

Definition at line 105 of file irods_plugin_context.hpp.

References results_.

Referenced by irods::plugin_base::call(), capture_weight(), compound_file_redirect_open(), and get_rebalance_batch_size().

rule_results() [2/2]

virtual void irods::plugin_context::rule_results ( const std::string &  _s )

inlinevirtual

Definition at line 115 of file irods_plugin_context.hpp.

References results_.

valid() [1/2]

virtual error irods::plugin_context::valid ( )

inlinevirtual

Definition at line 77 of file irods_plugin_context.hpp.

References SUCCESS.

Referenced by compound_check_param(), compound_file_resolve_hierarchy(), db_add_avu_metadata_wild_op(), db_add_child_resc_op(), db_check_and_get_object_id_op(), db_check_auth_op(), db_close_op(), db_commit_op(), db_debug_op(), db_del_child_resc_op(), db_del_coll_by_admin_op(), db_del_coll_op(), db_del_resc_op(), db_del_rule_exec_op(), db_del_user_re_op(), db_del_zone_op(), db_get_local_zone_op(), db_make_limited_pw_op(), db_make_temp_pw_op(), db_mod_coll_op(), db_mod_data_obj_meta_op(), db_mod_group_op(), db_mod_resc_data_paths_op(), db_mod_resc_freespace_op(), db_mod_resc_op(), db_mod_rule_exec_op(), db_mod_user_op(), db_mod_zone_coll_acl_op(), db_mod_zone_op(), db_open_op(), db_reg_coll_by_admin_op(), db_reg_coll_op(), db_reg_data_obj_op(), db_reg_replica_op(), db_reg_resc_op(), db_reg_rule_exec_op(), db_reg_user_re_op(), db_reg_zone_op(), db_rename_coll_op(), db_rename_local_zone_op(), db_rollback_op(), db_set_avu_metadata_op(), db_simple_query_op_vector(), db_start_op(), db_unreg_replica_op(), db_update_pam_password_op(), deferred_check_params(), impostor_file_resolve_hierarchy(), load_balanced_check_params(), mock_archive_file_mkdir(), mock_archive_file_resolve_hierarchy(), native_auth_client_request(), native_auth_client_response(), native_auth_client_start(), native_auth_establish_context(), non_blocking_check_params_and_path(), non_blocking_file_mkdir(), non_blocking_file_resolve_hierarchy(), non_blocking_file_stat(), osauth_auth_client_request(), osauth_auth_client_response(), osauth_auth_client_start(), osauth_auth_establish_context(), pam_auth_client_request(), pam_auth_client_start(), pam_auth_establish_context(), passthru_check_params(), random_check_params(), replCheckParams(), round_robin_check_params(), ssl_agent_start(), ssl_agent_stop(), ssl_client_start(), ssl_client_stop(), ssl_read_msg_body(), ssl_read_msg_header(), ssl_send_rods_msg(), ssl_write_msg_header(), tar_check_params(), tcp_read_msg_body(), tcp_read_msg_header(), tcp_send_rods_msg(), tcp_write_msg_header(), univ_mss_check_param(), univ_mss_file_resolve_hierarchy(), unix_check_params_and_path(), unix_file_mkdir(), unix_file_resolve_hierarchy(), unix_file_stat(), and valid().

valid() [2/2]

template<typename OBJ_TYPE >

error irods::plugin_context::valid ( )

inline

Definition at line 85 of file irods_plugin_context.hpp.

References ERROR, fco_, INVALID_DYNAMIC_CAST, NULL, and valid().

Here is the call graph for this function:

Friends And Related Function Documentation

swap

void swap ( plugin_context &  first, plugin_context &  second  )

friend

Definition at line 61 of file irods_plugin_context.hpp.

Referenced by operator=().

Member Data Documentation

comm_

rsComm_t* irods::plugin_context::comm_

protected

Definition at line 122 of file irods_plugin_context.hpp.

Referenced by comm().

fco_

first_class_object_ptr irods::plugin_context::fco_

protected

Definition at line 124 of file irods_plugin_context.hpp.

Referenced by fco(), and valid().

prop_map_

irods::plugin_property_map* irods::plugin_context::prop_map_

protected

Definition at line 123 of file irods_plugin_context.hpp.

Referenced by prop_map().

results_

std::string irods::plugin_context::results_

protected

Definition at line 125 of file irods_plugin_context.hpp.

Referenced by rule_results().

---

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

• lib/core/include/irods_plugin_context.hpp