Qorus Integration Engine® Enterprise Edition 6.0.16_prod
|
This class implements static methods in the client API. More...
Static Public Member Methods | |
static | init (*bool ignore_warnings) |
the client initialization function where any errors cause an error message to be displayed and exit() is called More... | |
static synchronized | init2 (*bool ignore_warnings) |
the main client initialization method; other functions call this one to initialize the client library More... | |
static synchronized | initFast (*bool ignore_warnings) |
fast client initialization method; other functions call this one to initialize the client library More... | |
static hash< auto > | parseOptions (string domain) |
option-parsing function: parses the option file More... | |
static hash< auto > | parseOptions () |
option-parsing function: parses the option file More... | |
static int | configureInterfaces (hash< auto > config, *bool silent, bool exit_on_error=True) |
set config items in the server More... | |
static int | restGetCode (string uri_path, bool exit_if_down=True) |
Sends a REST GET request to the Qorus server and returns the HTTP status code. More... | |
static | createPerm (string perm, string desc, *bool silent) |
Creates the given user permission if the permission does not exist. More... | |
static | createRole (string role, string base_role, string desc, *softlist< string > groups, *bool silent) |
Creates the given role as a clone of an existing role if the new role does not exist. More... | |
static | createRoleWithPerms (string role, string desc, hash< auto > role_info, *bool silent) |
Creates the given role with explicit permissions if the role does not exist. More... | |
static | createUser (string user, string pass, softlist< string > roles, string desc, *bool silent) |
Creates the given user if the user does not exist. More... | |
static | createUserConnection (string name, string desc, string url, *hash< auto > options, *bool silent) |
Creates a user connection if the connection does not exist. More... | |
static | createGlobalError (string error, string desc, string status, *int retry_delay_secs, *bool silent) |
Creates the given global error configuration if it does not already exist. More... | |
static | createOrUpdateWorkflowError (string workflow, string error, string desc, string status, *int retry_delay_secs, *bool silent) |
Aligns the given workflow error configuration according to the arguments. More... | |
static | addDataProviderModuleOption (string mod) |
Adds the given module to the dataprovider-modules system option. More... | |
static | addConnectionModuleOption (string mod) |
Adds the given module to the connection-modules system option. More... | |
static | addModuleOption (string option, string mod) |
Adds the given module to the given module option. More... | |
Public Attributes | |
const | DefaultZmqTimeout = 5s |
Default client timeout for ZeroMQ messages to acquire an API token. | |
This class implements static methods in the client API.
|
static |
Adds the given module to the connection-modules
system option.
mod | the module name to add to the option value |
If the options file is updated, then a backup is made and appropriate messages are output
|
static |
Adds the given module to the dataprovider-modules
system option.
mod | the module name to add to the option value |
If the options file is updated, then a backup is made and appropriate messages are output
|
static |
Adds the given module to the given module option.
option | a Qorus module option |
mod | the module name to add to the option value |
If the options file is updated, then a backup is made and appropriate messages are output
|
static |
set config items in the server
config | a hash keyed by REST path to the object to be configured, values are hashes keyed by config item name; values are the config item values |
silent | if True no output will be printed to stdout |
exit_on_error | if True and an error occurs, thread_exit Statements is called, otherwise -1 is returned |
|
static |
Creates the given global error configuration if it does not already exist.
|
static |
Aligns the given workflow error configuration according to the arguments.
|
static |
Creates the given user permission if the permission does not exist.
|
static |
Creates the given role as a clone of an existing role if the new role does not exist.
role | the new role name |
base_role | the role to clone |
desc | the description of the new role |
group | one or more optional interface groups to add to the new role |
silent | if True then no output will be made |
|
static |
Creates the given role with explicit permissions if the role does not exist.
|
static |
Creates the given user if the user does not exist.
|
static |
Creates a user connection if the connection does not exist.
|
static |
the client initialization function where any errors cause an error message to be displayed and exit() is called
creates global objects; throws exceptions on errors
ignore_warnings | if True then warnings will be suppressed |
|
static |
the main client initialization method; other functions call this one to initialize the client library
creates global objects; throws exceptions on errors
ignore_warnings | if True then warnings will be suppressed |
|
static |
fast client initialization method; other functions call this one to initialize the client library
creates global objects; throws exceptions on errors
does not initializes system datasources
ignore_warnings | if True then warnings will be suppressed |
|
static |
option-parsing function: parses the option file
|
static |
option-parsing function: parses the option file
this function calls qorus_client_init() to ensure the client library is initialized
|
static |
Sends a REST GET request to the Qorus server and returns the HTTP status code.
uri_path | the URI path to send |
exit_if_down | if True and Qorus is down, thread_exit Statements is called, otherwise -1 is returned |