![]() |
Qorus Integration Engine® Enterprise Edition 7.0.0_prod
|
Static Public Member Methods | |
static *hash< auto > | getUserContextInfo () |
returns a hash for the current user context | |
static auto | getGlobalConfigItemValue (string item, *hash< auto > local_context, bool expand_complex_values=True) |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item | |
static auto | getGlobalConfigItemValueWithDefault (string item, auto default_value, *hash< auto > local_context, bool expand_complex_values=True) |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item | |
static hash< auto > | getSystemInfo () |
returns a hash of system info | |
static auto | getValueMap (string mapname, string key) |
Gets a lookup value from the value map by a key; the value map must be registered to the current interface. | |
static auto | expandTemplatedValue (auto value, *hash< auto > local_context, bool expand_complex_values=True) |
expands all variables in a templated string | |
static hash< auto > | propGet () |
returns a hash of all system properties in all domains | |
static *hash< auto > | propGet (string domain) |
returns a hash of all key-value pairs in the given domain or NOTHING if the system property domain does not exist | |
static auto | propGet (string domain, string key) |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist | |
static SqlUtil::AbstractTable | getSqlTable (string datasource, string table_name, bool register_dependency=True) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch | |
static SqlUtil::AbstractTable | getSqlTable (AbstractDatasource datasource, string table_name, bool register_dependency=True) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch | |
static | logFatal (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logError (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logWarn (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logInfo (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logDebug (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logTrace (softstring msg,...) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logArgsFatal (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logWithLevel (int level, string msg,...) |
Writes to the current interface log file with the given log level. | |
static | logWithLevelArgs (int level, string msg, *softlist< auto > args) |
Writes to the current interface log file with the given log level. | |
static | logArgsError (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logArgsWarn (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logArgsInfo (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logArgsDebug (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
static | logArgsTrace (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. | |
Mapper API class.
|
static |
expands all variables in a templated string
value | templated string to be expanded; see Config Item / Building Block Template Substitution Strings for more information on this parameter |
local_context | local context supplied by the caller (plus user context info is added - see MapperApi::getUserContextInfo() method) |
expand_complex_values | if True then lists and hashes will have their string values expanded recursively |
LIST-VALUE-ERROR | cannot parse list value expression |
REST-EXPRESSION-ERROR | cannot parse REST expression and argument |
UNSUPPORTED-CONTEXT-ERROR | if an unknown context variable is specified to be expanded |
FORMAT-ERROR | if the templated string doesn't have correct format (e.g. unescaped dollar sign that does not represent a variable) |
SENSITIVE-DATA-FORMAT-ERROR | if the "$sensitive:<skey>.<svalue>.field-ref..." value or "$sensitive-alias:<alias>.field-ref..." template string does not have the required format |
|
static |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item
item | the name of the configuration item to retrieve the value |
local_context | the caller can supply its "local" context for template variables (plus user context info is added - see MapperApi::getUserContextInfo() method) |
expand_complex_values | if True then lists and hashes will have their string values expanded recursively |
CONFIG-ITEM-ERROR | thrown if the configuration item is not valid |
"$"
characters with a backslash ("\"
) to avoid template substitution
|
static |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item
item | the name of the configuration item to retrieve the value |
default_value | the value to be returned if the value is not set |
local_context | the caller can supply its "local" context for template variables (plus user context info is added - see MapperApi::getUserContextInfo() method) |
expand_complex_values | if True then lists and hashes will have their string values expanded recursively |
"$"
characters with a backslash ("\"
) to avoid template substitution
|
static |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
datasource | a DatasourcePool object for a Qorus datasource; note that if the Qore::SQL::DatasourcePool object cannot be matched back to a known Qorus datasource, an INVALID-DATASOURCE exception will be thrown |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known Qorus datasource |
INVALID-DATASOURCE
exceptions can be thrown with a valid Qorus datasource if the given datasource has been reset since it was acquired
|
static |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
datasource | a Qorus datasource name |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known datasource |
|
static |
returns a hash of system info
instance-key
: value of the system option by the same namesession-id
: the session ID for the current Qorus application sessionomq-version
: the version string for the Qorus serveromq-version-code
: a numeric code of the Qorus server version, where omq-version-code
= 20600)qore-version
: the version string for the qore build useddatamodel-version
: the datamodel version required by this version of Qorusomq-schema
: the datasource string for the system schema (without the password)omquser-schema
: the datasource string for the user schema (without the password)starttime:
the date and time when the instance was startedhostname:
the hostname of the machine where the Qorus server is runningpid:
the PID of the Qorus server processthreads:
number of threads currently activeschema-properties
: a hash of schema properties with the following keys:omq-schema-version
omq-schema-compatibility
omq-load-schema-compatibility
logfile:
the path for the system log file
|
static |
returns a hash for the current user context
"type"
: "service"
"servicetype"
: the type of service ("user"
or "system"
)"name"
: the name of the service"version"
: the version of the service"id"
: the service id"context_user"
: the current username context, if any"type"
: "job"
"name"
: the name of the job"version"
: the version of the job"id"
: the job id"job_instanceid"
: the job_instanceid of the current job instance"context_user"
: the current username context, if any"type"
: "workflow"
"name"
: the name of the workflow"version"
: the version of the workflow"id"
: the workflow id"workflow_instanceid"
: the workflow_instanceid of the current workflow instance (if available)"stepname"
: the name of the current step (if available)"stepversion"
: the version of the current step (if available)"stepid"
: the id of the current step (if available)"ind"
: the name of the current step index (if available)"execid"
: the execution ID of the current workflow execution instance (if available)"context_user"
: the current username context, if any
|
static |
Gets a lookup value from the value map by a key; the value map must be registered to the current interface.
mapname | name of the value map |
key | a key name |
VALUE-MAP-ERROR | the given value map is unknown or not registered to the current interface |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
args | the arguments for the format string msg |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower.
msg | the format string for a vsprintf() call with the remaining arguments |
|
static |
Writes to the current interface log file with the given log level.
level | log levels as defined by Logger::LoggerLevel |
msg | the format string for the log message, arguments follow |
|
static |
Writes to the current interface log file with the given log level.
level | log levels as defined by Logger::LoggerLevel |
msg | the format string for the log message |
args | optional argument to format specifiers in msg |
|
static |
returns a hash of all system properties in all domains
|
static |
|
static |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist