OMQ::QorusClient Class Reference

This class implements static methods in the client API. More...

Inheritance diagram for OMQ::QorusClient:

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
static synchronized	init2 (*bool ignore_warnings)
	the main client initialization method; other functions call this one to initialize the client library
static synchronized	initFast (*bool ignore_warnings)
	fast client initialization method; other functions call this one to initialize the client library
static hash< auto >	parseOptions (string domain)
	option-parsing function: parses the option file
static hash< auto >	parseOptions ()
	option-parsing function: parses the option file
static int	configureInterfaces (hash< auto > config, *bool silent, bool exit_on_error=True)
	set config items in the server
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.
static	createPerm (string perm, string desc, *bool silent)
	Creates the given user permission if the permission does not exist.
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.
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.
static	createUser (string user, string pass, softlist< string > roles, string desc, *bool silent)
	Creates the given user if the user does not exist.
static	createUserConnection (string name, string desc, string url, *hash< auto > options, *bool silent)
	Creates a user connection if the connection does not exist.
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.
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.
static	addDataProviderModuleOption (string mod)
	Adds the given module to the dataprovider-modules system option.
static	addConnectionModuleOption (string mod)
	Adds the given module to the connection-modules system option.
static	addModuleOption (string option, string mod)
	Adds the given module to the given module option.

Public Attributes
const	DefaultZmqTimeout = 5s
	Default client timeout for ZeroMQ messages to acquire an API token.

Detailed Description

This class implements static methods in the client API.

Member Function Documentation

addConnectionModuleOption()

static OMQ::QorusClient::addConnectionModuleOption ( string  mod )

static

Adds the given module to the connection-modules system option.

Parameters

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

Note

Qorus must be restarted for module option changes to take effect

Since

Qorus 4.1.1

addDataProviderModuleOption()

static OMQ::QorusClient::addDataProviderModuleOption ( string  mod )

static

Adds the given module to the dataprovider-modules system option.

Parameters

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

Note

Qorus must be restarted for module option changes to take effect

Since

Qorus 4.1

addModuleOption()

static OMQ::QorusClient::addModuleOption ( string  option, string  mod  )

static

Adds the given module to the given module option.

Parameters

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

Note

Qorus must be restarted for module option changes to take effect

Since

Qorus 4.1

configureInterfaces()

static int OMQ::QorusClient::configureInterfaces ( hash< auto >  config, *bool  silent, bool  exit_on_error = True  )

static

set config items in the server

Parameters

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

Returns

0 = OK, -1 = error occurred

createGlobalError()

static OMQ::QorusClient::createGlobalError ( string  error, string  desc, string  status, *int  retry_delay_secs, *bool  silent  )

static

Creates the given global error configuration if it does not already exist.

Note

• Changes are made with REST API calls; if Qorus is down, no update is performed
• If the global error already exists, no changes are made

Since

Qorus 4.1

createOrUpdateWorkflowError()

static OMQ::QorusClient::createOrUpdateWorkflowError ( string  workflow, string  error, string  desc, string  status, *int  retry_delay_secs, *bool  silent  )

static

Aligns the given workflow error configuration according to the arguments.

Note

Updates are made with REST API calls; if Qorus is down, no update is performed

Since

Qorus 4.1

createPerm()

static OMQ::QorusClient::createPerm ( string  perm, string  desc, *bool  silent  )

static

Creates the given user permission if the permission does not exist.

Note

• Changes are made with REST API calls; if Qorus is down, no action is performed
• If the global error already exists, no changes are made

Since

Qorus 6.0.9

createRole()

static OMQ::QorusClient::createRole ( string  role, string  base_role, string  desc, *softlist< string >  groups, *bool  silent  )

static

Creates the given role as a clone of an existing role if the new role does not exist.

Parameters

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

Note

• Changes are made with REST API calls; if Qorus is down, no action is performed
• If the global error already exists, no changes are made

Since

Qorus 4.1

createRoleWithPerms()

static OMQ::QorusClient::createRoleWithPerms ( string  role, string  desc, hash< auto >  role_info, *bool  silent  )

static

Creates the given role with explicit permissions if the role does not exist.

Note

• Changes are made with REST API calls; if Qorus is down, no action is performed
• If the global error already exists, no changes are made

Since

Qorus 6.0.9

createUser()

static OMQ::QorusClient::createUser ( string  user, string  pass, softlist< string >  roles, string  desc, *bool  silent  )

static

Creates the given user if the user does not exist.

Note

• Changes are made with REST API calls; if Qorus is down, no action is performed
• If the global error already exists, no changes are made

Since

Qorus 4.1

createUserConnection()

static OMQ::QorusClient::createUserConnection ( string  name, string  desc, string  url, *hash< auto >  options, *bool  silent  )

static

Creates a user connection if the connection does not exist.

Note

• Changes are made with REST API calls; if Qorus is down, no action is performed
• If the global error already exists, no changes are made

Since

Qorus 4.1

init()

static OMQ::QorusClient::init ( *bool  ignore_warnings )

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

Parameters

ignore_warnings

if True then warnings will be suppressed

See also

• QorusClient::initFast()
• QorusClient::init2()
• qorus_client_init2()

init2()

static synchronized OMQ::QorusClient::init2 ( *bool  ignore_warnings )

static

the main client initialization method; other functions call this one to initialize the client library

creates global objects; throws exceptions on errors

Parameters

ignore_warnings

if True then warnings will be suppressed

See also

• QorusClient::init()
• QorusClient::initFast()
• qorus_client_init2()

initFast()

static synchronized OMQ::QorusClient::initFast ( *bool  ignore_warnings )

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

Parameters

ignore_warnings

if True then warnings will be suppressed

See also

• QorusClient::init()
• QorusClient::init2()

parseOptions() [1/2]

static hash< auto > OMQ::QorusClient::parseOptions ( )

static

option-parsing function: parses the option file

Returns

a hash of hashes; the first level hash key represents the domain, the second level is the option=value within that option domain

parseOptions() [2/2]

static hash< auto > OMQ::QorusClient::parseOptions ( string  domain )

static

option-parsing function: parses the option file

this function calls qorus_client_init() to ensure the client library is initialized

Returns

a hash of the options in the given domain

restGetCode()

static int OMQ::QorusClient::restGetCode ( string  uri_path, bool  exit_if_down = True  )

static

Sends a REST GET request to the Qorus server and returns the HTTP status code.

Parameters

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

Returns

the HTTP status code returned from the rest request or -1 if Qorus is down and exit_if_down is not True

Since

Qorus 4.1

---

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

• QorusClientBase.qm