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.configuration.IrodsConfig Class Reference
Inheritance diagram for irods.configuration.IrodsConfig:
[legend]
Collaboration diagram for irods.configuration.IrodsConfig:
[legend]

Public Member Functions

def __init__ (self, injected_environment={}, insert_behavior=True)
 
def version_tuple (self)
 
def server_config (self)
 
def is_catalog (self)
 
def is_resource (self)
 
def default_rule_engine_instance (self)
 
def default_rule_engine_plugin (self)
 
def configured_rule_engine_plugins (self)
 
def database_config (self)
 
def catalog_database_type (self)
 
def odbc_ini_path (self)
 
def version (self)
 
def hosts_config (self)
 
def host_access_control_config (self)
 
def client_environment_path (self)
 
def client_environment (self)
 
def server_environment (self)
 
def print_execution_environment (self)
 
def execution_environment (self)
 
def insert_behavior (self)
 
def insert_behavior (self, value)
 
def injected_environment (self)
 
def injected_environment (self, value)
 
def schema_uri_prefix (self)
 
def admin_password (self)
 
def admin_password (self, value)
 
def validate_configuration (self)
 
def commit (self, config_dict, path, clear_cache=True, make_backup=False)
 
def clear_cache (self)
 
def root_directory (self)
 
def irods_directory (self)
 
def config_directory (self)
 
def home_directory (self)
 
def core_re_directory (self)
 
def scripts_directory (self)
 
def server_config_path (self)
 
def database_config_path (self)
 
def version_path (self)
 
def hosts_config_path (self)
 
def host_access_control_config_path (self)
 
def password_file_path (self)
 
def log_directory (self)
 
def control_log_path (self)
 
def setup_log_path (self)
 
def test_log_path (self)
 
def icommands_test_directory (self)
 
def server_test_directory (self)
 
def server_parent_log_path (self)
 
def server_log_path (self)
 
def re_log_path (self)
 
def server_bin_directory (self)
 
def server_executable (self)
 
def rule_engine_executable (self)
 
def xmsg_server_executable (self)
 
def database_schema_update_directory (self)
 
def service_account_file_path (self)
 
def irods_user (self)
 
def irods_uid (self)
 
def irods_group (self)
 
def irods_gid (self)
 

Private Attributes

 _injected_environment
 
 _insert_behavior
 
 _server_config
 
 _version
 
 _hosts_config
 
 _host_access_control_config
 
 _client_environment
 
 _execution_environment
 
 _schema_uri_prefix
 

Detailed Description

Definition at line 22 of file configuration.py.

Constructor & Destructor Documentation

◆ __init__()

def irods.configuration.IrodsConfig.__init__ (   self,
  injected_environment = {},
  insert_behavior = True 
)

Definition at line 23 of file configuration.py.

Member Function Documentation

◆ admin_password() [1/2]

def irods.configuration.IrodsConfig.admin_password (   self)

Definition at line 215 of file configuration.py.

References irods.password_obfuscation.decode().

Referenced by irods.configuration.IrodsConfig.admin_password().

Here is the call graph for this function:

◆ admin_password() [2/2]

def irods.configuration.IrodsConfig.admin_password (   self,
  value 
)

Definition at line 222 of file configuration.py.

References irods.configuration.IrodsConfig.admin_password(), irods.password_obfuscation.encode(), and int().

Here is the call graph for this function:

◆ catalog_database_type()

def irods.configuration.IrodsConfig.catalog_database_type (   self)

Definition at line 101 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Referenced by irods.configuration.IrodsConfig.database_config().

Here is the call graph for this function:

◆ clear_cache()

◆ client_environment()

def irods.configuration.IrodsConfig.client_environment (   self)

◆ client_environment_path()

def irods.configuration.IrodsConfig.client_environment_path (   self)

Definition at line 134 of file configuration.py.

References irods.configuration.IrodsConfig.execution_environment().

Referenced by irods.configuration.IrodsConfig.validate_configuration().

Here is the call graph for this function:

◆ commit()

def irods.configuration.IrodsConfig.commit (   self,
  config_dict,
  path,
  clear_cache = True,
  make_backup = False 
)

Definition at line 286 of file configuration.py.

References irods.configuration.IrodsConfig.clear_cache(), and irods.join().

Referenced by irods.pypyodbc.Cursor.__exit__(), irods.pypyodbc.Connection.__exit__(), and irods.configuration.IrodsConfig.database_config().

Here is the call graph for this function:

◆ config_directory()

def irods.configuration.IrodsConfig.config_directory (   self)

Definition at line 319 of file configuration.py.

◆ configured_rule_engine_plugins()

def irods.configuration.IrodsConfig.configured_rule_engine_plugins (   self)

Definition at line 69 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ control_log_path()

def irods.configuration.IrodsConfig.control_log_path (   self)

Definition at line 363 of file configuration.py.

◆ core_re_directory()

def irods.configuration.IrodsConfig.core_re_directory (   self)

Definition at line 327 of file configuration.py.

◆ database_config()

def irods.configuration.IrodsConfig.database_config (   self)

Definition at line 76 of file configuration.py.

References irods.configuration.IrodsConfig._server_config, irods.configuration.IrodsConfig.catalog_database_type(), irods.configuration.IrodsConfig.commit(), irods.configuration.IrodsConfig.odbc_ini_path(), and irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ database_config_path()

def irods.configuration.IrodsConfig.database_config_path (   self)

Definition at line 339 of file configuration.py.

◆ database_schema_update_directory()

def irods.configuration.IrodsConfig.database_schema_update_directory (   self)

Definition at line 411 of file configuration.py.

◆ default_rule_engine_instance()

def irods.configuration.IrodsConfig.default_rule_engine_instance (   self)

Definition at line 61 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ default_rule_engine_plugin()

def irods.configuration.IrodsConfig.default_rule_engine_plugin (   self)

Definition at line 65 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ execution_environment()

def irods.configuration.IrodsConfig.execution_environment (   self)

Definition at line 154 of file configuration.py.

References irods.configuration.IrodsConfig._execution_environment, and irods.configuration.IrodsConfig.insert_behavior().

Referenced by irods.configuration.IrodsConfig.client_environment_path(), irods.configuration.IrodsConfig.odbc_ini_path(), and irods.configuration.IrodsConfig.print_execution_environment().

Here is the call graph for this function:

◆ home_directory()

def irods.configuration.IrodsConfig.home_directory (   self)

Definition at line 323 of file configuration.py.

◆ host_access_control_config()

def irods.configuration.IrodsConfig.host_access_control_config (   self)

◆ host_access_control_config_path()

def irods.configuration.IrodsConfig.host_access_control_config_path (   self)

Definition at line 351 of file configuration.py.

◆ hosts_config()

def irods.configuration.IrodsConfig.hosts_config (   self)

◆ hosts_config_path()

def irods.configuration.IrodsConfig.hosts_config_path (   self)

Definition at line 347 of file configuration.py.

◆ icommands_test_directory()

def irods.configuration.IrodsConfig.icommands_test_directory (   self)

Definition at line 375 of file configuration.py.

◆ injected_environment() [1/2]

def irods.configuration.IrodsConfig.injected_environment (   self)

◆ injected_environment() [2/2]

def irods.configuration.IrodsConfig.injected_environment (   self,
  value 
)

Definition at line 180 of file configuration.py.

References irods.configuration.IrodsConfig._injected_environment, irods.configuration.IrodsConfig.clear_cache(), and irods.configuration.IrodsConfig.injected_environment().

Here is the call graph for this function:

◆ insert_behavior() [1/2]

def irods.configuration.IrodsConfig.insert_behavior (   self)

◆ insert_behavior() [2/2]

def irods.configuration.IrodsConfig.insert_behavior (   self,
  value 
)

Definition at line 171 of file configuration.py.

References irods.configuration.IrodsConfig._insert_behavior, irods.configuration.IrodsConfig.clear_cache(), and irods.configuration.IrodsConfig.insert_behavior().

Here is the call graph for this function:

◆ irods_directory()

def irods.configuration.IrodsConfig.irods_directory (   self)

Definition at line 315 of file configuration.py.

◆ irods_gid()

def irods.configuration.IrodsConfig.irods_gid (   self)

Definition at line 431 of file configuration.py.

◆ irods_group()

def irods.configuration.IrodsConfig.irods_group (   self)

Definition at line 427 of file configuration.py.

◆ irods_uid()

def irods.configuration.IrodsConfig.irods_uid (   self)

Definition at line 423 of file configuration.py.

◆ irods_user()

def irods.configuration.IrodsConfig.irods_user (   self)

Definition at line 419 of file configuration.py.

◆ is_catalog()

def irods.configuration.IrodsConfig.is_catalog (   self)

Definition at line 53 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ is_resource()

def irods.configuration.IrodsConfig.is_resource (   self)

Definition at line 57 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ log_directory()

def irods.configuration.IrodsConfig.log_directory (   self)

Definition at line 359 of file configuration.py.

◆ odbc_ini_path()

def irods.configuration.IrodsConfig.odbc_ini_path (   self)

Definition at line 108 of file configuration.py.

References irods.configuration.IrodsConfig.execution_environment().

Referenced by irods.configuration.IrodsConfig.database_config().

Here is the call graph for this function:

◆ password_file_path()

def irods.configuration.IrodsConfig.password_file_path (   self)

Definition at line 355 of file configuration.py.

◆ print_execution_environment()

def irods.configuration.IrodsConfig.print_execution_environment (   self)

Definition at line 150 of file configuration.py.

References irods.configuration.IrodsConfig.execution_environment().

Here is the call graph for this function:

◆ re_log_path()

def irods.configuration.IrodsConfig.re_log_path (   self)

Definition at line 391 of file configuration.py.

◆ root_directory()

def irods.configuration.IrodsConfig.root_directory (   self)

Definition at line 311 of file configuration.py.

◆ rule_engine_executable()

def irods.configuration.IrodsConfig.rule_engine_executable (   self)

Definition at line 403 of file configuration.py.

◆ schema_uri_prefix()

def irods.configuration.IrodsConfig.schema_uri_prefix (   self)

Definition at line 185 of file configuration.py.

References irods.configuration.IrodsConfig._schema_uri_prefix, irods.configuration.IrodsConfig.server_config(), irods.configuration.IrodsConfig.version(), DataObjInfo.version, and rodsArguments_t.version.

Referenced by irods.configuration.IrodsConfig.validate_configuration().

Here is the call graph for this function:

◆ scripts_directory()

def irods.configuration.IrodsConfig.scripts_directory (   self)

Definition at line 331 of file configuration.py.

◆ server_bin_directory()

def irods.configuration.IrodsConfig.server_bin_directory (   self)

Definition at line 395 of file configuration.py.

◆ server_config()

◆ server_config_path()

def irods.configuration.IrodsConfig.server_config_path (   self)

Definition at line 335 of file configuration.py.

◆ server_environment()

def irods.configuration.IrodsConfig.server_environment (   self)

Definition at line 147 of file configuration.py.

References irods.configuration.IrodsConfig.server_config().

Here is the call graph for this function:

◆ server_executable()

def irods.configuration.IrodsConfig.server_executable (   self)

Definition at line 399 of file configuration.py.

◆ server_log_path()

def irods.configuration.IrodsConfig.server_log_path (   self)

Definition at line 387 of file configuration.py.

◆ server_parent_log_path()

def irods.configuration.IrodsConfig.server_parent_log_path (   self)

Definition at line 383 of file configuration.py.

◆ server_test_directory()

def irods.configuration.IrodsConfig.server_test_directory (   self)

Definition at line 379 of file configuration.py.

◆ service_account_file_path()

def irods.configuration.IrodsConfig.service_account_file_path (   self)

Definition at line 415 of file configuration.py.

◆ setup_log_path()

def irods.configuration.IrodsConfig.setup_log_path (   self)

Definition at line 367 of file configuration.py.

◆ test_log_path()

def irods.configuration.IrodsConfig.test_log_path (   self)

Definition at line 371 of file configuration.py.

◆ validate_configuration()

◆ version()

◆ version_path()

def irods.configuration.IrodsConfig.version_path (   self)

Definition at line 343 of file configuration.py.

◆ version_tuple()

def irods.configuration.IrodsConfig.version_tuple (   self)

Definition at line 31 of file configuration.py.

References irods.configuration.IrodsConfig.version(), DataObjInfo.version, and rodsArguments_t.version.

Here is the call graph for this function:

◆ xmsg_server_executable()

def irods.configuration.IrodsConfig.xmsg_server_executable (   self)

Definition at line 407 of file configuration.py.

Member Data Documentation

◆ _client_environment

irods.configuration.IrodsConfig._client_environment
private

◆ _execution_environment

irods.configuration.IrodsConfig._execution_environment
private

◆ _host_access_control_config

irods.configuration.IrodsConfig._host_access_control_config
private

◆ _hosts_config

irods.configuration.IrodsConfig._hosts_config
private

◆ _injected_environment

irods.configuration.IrodsConfig._injected_environment
private

◆ _insert_behavior

irods.configuration.IrodsConfig._insert_behavior
private

Definition at line 25 of file configuration.py.

Referenced by irods.configuration.IrodsConfig.insert_behavior().

◆ _schema_uri_prefix

irods.configuration.IrodsConfig._schema_uri_prefix
private

◆ _server_config

irods.configuration.IrodsConfig._server_config
private

◆ _version

irods.configuration.IrodsConfig._version
private

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