|
| constructor () |
| creates the object and parses the options file More...
|
|
Connections | getConnectionProvider (string type) |
| returns the connection provider object More...
|
|
bool | isLSB () |
| returns True if the installation is an LSB installation, False if not More...
|
|
string | getOptionFileName () |
| returns the options file name More...
|
|
synchronized private | initUserConnectionsIntern () |
| ensures that user connections have been initialized
|
|
*hash< string, AbstractConnection > | getUserConnections () |
| Returns a hash describing all defined user connections or NOTHING if no user connections are defined. More...
|
|
*hash< auto > | getUserConnectionInfo () |
| Returns a hash describing all defined user connections or NOTHING if no user connections are defined. More...
|
|
ConnectionProvider::AbstractConnection | getUserConnectionObject (string name) |
| Returns a ConnectionProvider::AbstractConnection object corresponding to a defined user connection. More...
|
|
synchronized hash | getUserConnectionInfo (string name) |
| Returns a hash describing the given user connection. More...
|
|
string | getUserConnectionUrl (string name) |
| Returns the URL corresponding to a defined user connection. More...
|
|
object | getUserConnection (string name, bool connect=True, *hash rtopts) |
| Returns an object corresponding to a defined user connection. More...
|
|
| reloadUserConnections () |
| reloads user connections from the DB on the next request for a user connection More...
|
|
synchronized Datasource | getDatasource (string name) |
| returns a Datasource object for the given string if defined in Datasource Connections More...
|
|
Datasource | getNewDatasource (string name) |
| returns a new Datasource object for the given string if defined in Datasource Connections More...
|
|
string | getDatasourceConnectionString (string name) |
| returns the datasource connection string for the given datasource if defined in Datasource Connections More...
|
|
*hash< string, string > | getDatasourceConnectionsAsHash () |
| returns a hash of datasource connections; keys are datasource names, values are connection strings More...
|
|
string | getConfigDir () |
| returns the path to the configuration directory for this instance of Qorus More...
|
|
string | getAppDir () |
| returns the path to the application root directory More...
|
|
synchronized DatasourcePool | getDatasourcePool (string name, int min=0, int max=0) |
| returns a DatasourcePool object for the given string if defined in Datasource Connections More...
|
|
DatasourcePool | getNewDatasourcePool (string name, softint min=0, softint max=0) |
| returns a new DatasourcePool object for the given string if defined in Datasource Connections More...
|
|
*hash | getRemoteInfo () |
| returns a hash of remote connections keyed by remote connection name or NOTHING if no remote connections are defined More...
|
|
ConnectionProvider::AbstractConnection | getRemoteConnectionObject (string name) |
| returns a ConnectionProvider::AbstractConnection object for the given remote connection More...
|
|
hash | getRemoteInfo (string name) |
| returns a hash of the given remote connection More...
|
|
string | getRemoteUrl (string name) |
| returns the URL for a Qorus remote connection from the connection name More...
|
|
OMQ::Client::QorusSystemAPIHelper | getRemote (string name) |
| gets a remote connection based on connection parameters parsed in the Qorus to Qorus Connections More...
|
|
OMQ::Client::QorusSystemRestHelper | getRemoteRest (string name, bool connect=True) |
| returns a connection for RESTful communication with a remote Qorus server based on connection parameters parsed in the Qorus to Qorus Connections More...
|
|
hash< auto > | getRemoteConfig (string name, bool with_password=False) |
| returns a hash with connection parameters for a remote Qorus server based on connection parameters parsed in the Qorus to Qorus Connections More...
|
|
| setRemoteParams (OMQ::Client::QorusSystemAPIHelper ret, string name) |
| sets up a QorusSystemAPIHelper to communicate with the given remote Qorus instance
|
|
string | getConfigFile (string name, *string opt) |
| returns a complete path for the configuration file given as an argument or an exception is thrown if the file does not exist More...
|
|
hash< auto > | getOptions (string domain) |
| returns the options from the given domain as a hash More...
|
|
hash< auto > | getOptions () |
| returns the options from all domains as a hash of hashes More...
|
|
| setOption (string domain, string key, auto value) |
| Allows an option value to be set temporarily.
|
|
SQLInterface | getSQLIF () |
| returns an SQLInterface object using the system DatasourcePool object More...
|
|
SQLInterface | getSQLIF (string dsn) |
| returns an SQLInterface object using a DatasourcePool object for the datasource given as an argument More...
|
|
SQLInterface | getSQLIF (DatasourcePool dsp) |
| returns an SQLInterface object using the DatasourcePool object given as an argument More...
|
|
| resetSystemDatasource () |
| Resets the system datasource.
|
|
| initSystemDatasources () |
| initializes the system Datasource and DatasourcePool objects More...
|
|
synchronized | initOmq () |
| initializes the omq variable
|
|
synchronized | initOmqUser () |
| initializes the omquser variable
|
|
| setDatasourceFromText (string line) |
| this method allows a datasource to be created or redefined from the text passed More...
|
|
hash< auto > | getWorkflowInfoID (softint wfid) |
| returns a hash of information about the given workflow based on the workflowid passed More...
|
|
hash< auto > | getWorkflowInfoName (string name, string version) |
| returns a hash of information about the given workflow based on the workflow name and version passed More...
|
|
hash | getOriginalOptionHash () |
| returns a hash of options originally read form the options file
|
|
*string | getKeyOption (string opt) |
| returns the value of a system opion as a string
|
|
| preSchemaVerifySystem (bool quiet=False) |
| actions to verify the state of an installed Qorus installation before the schema has potentially been created
|
|
| postSchemaVerifySystem (bool quiet=False) |
| actions to verify the state of an installed Qorus installation after the schema has been verified
|
|
| checkAdminUser (bool quiet=False) |
| check if any users exist in the system DB, if not create a superuser named admin with a random password
|
|
| checkNodeOption (bool quiet=False) |
| create a "node" entry in System Options File if not already present
|
|
| generateKeys (bool quiet=False) |
| create encryption key files if they don't exist and sets system options More...
|
|
binary | serializeEncryptSensitiveData (hash< auto > data, binary iv, reference mac, string aad) |
| returns a binary object encrypted with AES-256 for a sensitive data hash More...
|
|
hash< auto > | deserializeDecryptSensitiveData (binary data, binary iv, binary mac, string aad) |
| returns a decrypted sensitive data hash from the AES-256-encrypted binary object and other encryption arguments More...
|
|
string | encodeEncryptSensitiveValue (string svalue) |
| returns a string encrypted with Blowfish and subjected to base64 encoding for a sensitive data key value More...
|
|
string | decodeDecryptSensitiveValue (string svalue) |
| returns a decoded and decrypted sensitive data key value from the base64-encoded encrypted value More...
|
|
hash< auto > | encryptOrderData (softint wfiid, string skey, string svalue, hash< auto > info, *hash< auto > meta) |
| encrypt the data needed for a row in sensitive_order_data
|
|
private | setupEncryption () |
| sets up encryption keys and verifies their state
|
|
|
static | ignoreWarnings (bool ignore_warnings=True) |
| sets a flag to ignore warnings
|
|
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 | createRole (string role, string base_role, string desc, string group, *bool silent) |
| Creates the given role 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...
|
|
|
string | createWorkflowInstanceID (softint wfid, *softstring ext_order_id, *hash sdata, *hash ddata, *hash orderkeys, softint priority=OMQ::DefaultOrderPriority, *softint pwfiid) |
| creates a workflow order data instance from the workflowid and order parameters and returns the workflow_instanceid More...
|
|
string | createWorkflowInstanceName (string name, string version, *softstring ext_order_id, *hash sdata, *hash ddata, *hash orderkeys, softint priority=OMQ::DefaultOrderPriority, *softint pwfiid) |
| creates a workflow order data instance from the workflow and version and order parameters and returns the workflow_instanceid More...
|
|
softstring | getNextSequenceValue (string name) |
| returns the next sequence value for the given sequence using the SQLInterface object (returned as a string)
|
|
int | getNextSequenceValueInt (string name) |
| returns the next sequence value for the given sequence using the SQLInterface object (returned as an int)
|
|
private string | processSystemTemplate (string template) |
| takes a template string and performs substitutions
|
|
string | getQorusSystemLogFilePrefix () |
| returns the system log file name prefix
|
|
string | getWorkflowLogFileName (string name, string version, softint wfid=0) |
| returns a string giving the workflow log file name corresponding to the arguments
|
|
string | getServiceLogFileName (string type, string name, string version, softint svcid=0) |
| returns a string giving the service log file name corresponding to the arguments
|
|
string | getJobLogFileName (string name, string version, softint jobid=0) |
| returns a string giving the service log file name corresponding to the arguments
|
|
internal synchronized | init () |
| on-demand initialization
|
|
internal synchronized | initInternalDb () |
| initalizes the omqp and sqlif members
|
|
|
static | saveOptionsFile (string fn, hash options, string hdr="", string trl="") |
| saves the hash given as the options file
|
|
static | clientError (string msg, string desc) |
| throws an exception with the given parameters
|
|
static | clientWarning (string err, string msg) |
| prints out a warning with the given parameters
|
|
static hash | parseOptionsFile (string fn) |
| parses the given file as a Qorus option file and returns a hash More...
|
|
static hash< auto > | parse_ds (string str) |
| parses a datasource string and returns the hash More...
|
|
static binary | getRandomSalt (int size) |
| returns a random salt from /dev/urandom (on UNIX) as a binary, arg: size in bytes
|
|
static int | createRBACUser (Datasource ds, string user, string pass, string name, softlist roles, bool quiet=False, *string tag) |
| creates an RBAC user with transaction management and duplicate user checking More...
|
|
static | createRBACUserDB (Datasource ds, string user, string pass, string name, softlist roles, bool quiet=False, *string tag) |
| creates an RBAC user More...
|
|
static auto | parseToQoreValue (string arg) |
| tries to convert a string (such as an argument given from the command-line) to a Qore value More...
|
|
This class implements the client interface to a Qorus server.
This class is in charge of parsing the options and providing other client-related services based on these files. This class is normally used from the omqclient object, a global variable initialized by calling qorus_client_init() (or qorus_client_init2()).
For example, retrieving Datasource or DatasourcePool objects:
qorus_client_init();
Datasource app2 = omqclient.getDatasource("app2");
DatasourcePool app2p = omqclient.getDatasourcePool("app2");