 |
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
|
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
The base class for Qorus services. More...
Additional Inherited Members | |
 Public Member Methods inherited from OMQ::UserApi::QorusConfigurationItemProvider | |
| final *hash< string, hash< ConfigItemInfo > > | getConfigItems () |
| Method to return local configuration items. More... | |
| *hash< string, hash< ConfigItemInfo > > | getConfigItemsImpl () |
| Method to return local configuration items; this method should be overridden by child classes to provide item configuration. More... | |
| Static Public Member Methods inherited from OMQ::UserApi::Service::ServiceApi | |
| static | checkAuthorization () |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkAuthorizationArgs (softlist< string > args) |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkAuthorizationOr () |
| checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkAuthorizationOrArgs (softlist< string > args) |
| checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized More... | |
| static bool | testAuthorization () |
| tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testAuthorizationArgs (softlist< string > args) |
| tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testAuthorizationOr () |
| tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testAuthorizationOrArgs (softlist< string > args) |
| tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static | checkWorkflowAccess (list< auto > ids) |
| checks if the current user has access to the given list of workflow IDs; throws an exception if the user is not authorized More... | |
| static | checkWorkflowAccess (softint id) |
| checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized More... | |
| static bool | testWorkflowAccess (list< auto > ids) |
| tests if the current user has access to the given list of workflow IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testWorkflowAccess (softint id) |
| tests if the current user has access to the given single workflow ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getWorkflowAccessList () |
| returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getWorkflowAccessHash () |
| returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkWorkflowInstanceAccess (softstring wfiid) |
| checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized More... | |
| static | checkServiceAccess (list< auto > ids) |
| checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized More... | |
| static | checkServiceAccess (softint id) |
| checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized More... | |
| static | checkQueueAccess (softint queueid, string key) |
| checks if the current user has access to the given queue entry (as determined through the workflow access list); throws an exception if the user is not authorized More... | |
| static bool | testServiceAccess (list< auto > ids) |
| tests if the current user has access to the given list of serviceids and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testServiceAccess (softint id) |
| tests if the current user has access to the given single serviceid and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getServiceAccessList () |
| returns a list of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned More... | |
| static *hash< auto > | getServiceAccessHash () |
| returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned More... | |
| static | checkJobAccess (list< auto > ids) |
| checks if the current user has access to the given list of job IDs; throws an exception if the user is not authorized More... | |
| static | checkJobAccess (softint id) |
| checks if the current user has access to the given single job ID; throws an exception if the user is not authorized More... | |
| static bool | testJobAccess (list< auto > ids) |
| tests if the current user has access to the given list of job IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testJobAccess (softint id) |
| tests if the current user has access to the given single job ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getJobAccessList () |
| returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getJobAccessHash () |
| returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkJobInstanceAccess (softstring jiid) |
| checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized More... | |
| static | checkMapperAccess (list< auto > ids) |
| checks if the current user has access to the given list of mapper IDs; throws an exception if the user is not authorized More... | |
| static | checkMapperAccess (softint id) |
| checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized More... | |
| static bool | testMapperAccess (list< auto > ids) |
| tests if the current user has access to the given list of mapper IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testMapperAccess (softint id) |
| tests if the current user has access to the given single mapper ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getMapperAccessList () |
| returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getMapperAccessHash () |
| returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkVmapAccess (list< auto > ids) |
| checks if the current user has access to the given list of value map IDs; throws an exception if the user is not authorized More... | |
| static | checkVmapAccess (softint id) |
| checks if the current user has access to the given single value map ID; throws an exception if the user is not authorized More... | |
| static bool | testVmapAccess (list< auto > ids) |
| tests if the current user has access to the given list of value map IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testVmapAccess (softint id) |
| tests if the current user has access to the given single value map ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getVmapAccessList () |
| returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getVmapAccessHash () |
| returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkFsmAccess (list< auto > ids) |
| checks if the current user has access to the given list of Finite State Machines; throws an exception if the user is not authorized More... | |
| static | checkFsmAccess (string name) |
| checks if the current user has access to the given single Finite State Machine; throws an exception if the user is not authorized More... | |
| static bool | testFsmAccess (list< auto > ids) |
| tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testFsmAccess (string name) |
| tests if the current user has access to the given single Finite State Machine and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getFsmAccessList () |
| returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getFsmAccessHash () |
| returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkPipelineAccess (list< auto > ids) |
| checks if the current user has access to the given list of data pipelines; throws an exception if the user is not authorized More... | |
| static | checkPipelineAccess (string name) |
| checks if the current user has access to the given single data pipeline; throws an exception if the user is not authorized More... | |
| static bool | testPipelineAccess (list< auto > ids) |
| tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testPipelineAccess (string name) |
| tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getPipelineAccessList () |
| returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getPipelineAccessHash () |
| returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserAuthorization (string user) |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkUserAuthorizationArgs (string user, softlist< string > args) |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkUserAuthorizationOr (string user) |
| checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized More... | |
| static | checkUserAuthorizationOrArgs (string user, softlist< string > args) |
| checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized More... | |
| static bool | testUserAuthorization (string user) |
| tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserAuthorizationArgs (string user, softlist< string > args) |
| tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserAuthorizationOr (string user) |
| tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserAuthorizationOrArgs (string user, softlist< string > args) |
| tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static | checkUserWorkflowAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of workflow IDs; throws an exception if the user is not authorized More... | |
| static | checkUserWorkflowAccess (string user, softint id) |
| checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized More... | |
| static bool | testUserWorkflowAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of workflow IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserWorkflowAccess (string user, softint id) |
| tests if the current user has access to the given single workflow ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserWorkflowAccessList (string user) |
| returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserWorkflowAccessHash (string user) |
| returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserWorkflowInstanceAccess (string user, softstring wfiid) |
| checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized More... | |
| static | checkUserServiceAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized More... | |
| static | checkUserServiceAccess (string user, softint id) |
| checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized More... | |
| static | checkUserQueueAccess (string user, softint queueid, string key) |
| checks if the current user has access to the given queue entry (as determined through the workflow access list); throws an exception if the user is not authorized More... | |
| static bool | testUserServiceAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of serviceids and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserServiceAccess (string user, softint id) |
| tests if the current user has access to the given single serviceid and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserServiceAccessList (string user) |
| returns a list of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned More... | |
| static *hash< auto > | getUserServiceAccessHash (string user) |
| returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned More... | |
| static | checkUserJobAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of job IDs; throws an exception if the user is not authorized More... | |
| static | checkUserJobAccess (string user, softint id) |
| checks if the current user has access to the given single job ID; throws an exception if the user is not authorized More... | |
| static bool | testUserJobAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of job IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserJobAccess (string user, softint id) |
| tests if the current user has access to the given single job ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserJobAccessList (string user) |
| returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserJobAccessHash (string user) |
| returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserJobInstanceAccess (string user, softstring jiid) |
| checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized More... | |
| static | checkUserMapperAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of mapper IDs; throws an exception if the user is not authorized More... | |
| static | checkUserMapperAccess (string user, softint id) |
| checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized More... | |
| static bool | testUserMapperAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of mapper IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserMapperAccess (string user, softint id) |
| tests if the current user has access to the given single mapper ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserMapperAccessList (string user) |
| returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserMapperAccessHash (string user) |
| returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserVmapAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of value map IDs; throws an exception if the user is not authorized More... | |
| static | checkUserVmapAccess (string user, softint id) |
| checks if the current user has access to the given single value map ID; throws an exception if the user is not authorized More... | |
| static bool | testUserVmapAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of value map IDs and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserVmapAccess (string user, softint id) |
| tests if the current user has access to the given single value map ID and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserVmapAccessList (string user) |
| returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserVmapAccessHash (string user) |
| returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserFsmAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of Finite State Machines; throws an exception if the user is not authorized More... | |
| static | checkUserFsmAccess (string user, string name) |
| checks if the current user has access to the given single Finite State Machine; throws an exception if the user is not authorized More... | |
| static bool | testUserFsmAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserFsmAccess (string user, string name) |
| tests if the current user has access to the given single Finite State Machine and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserFsmAccessList (string user) |
| returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserFsmAccessHash (string user) |
| returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | checkUserPipelineAccess (string user, list< auto > ids) |
| checks if the current user has access to the given list of data pipelines; throws an exception if the user is not authorized More... | |
| static | checkUserPipelineAccess (string user, string name) |
| checks if the current user has access to the given single data pipeline; throws an exception if the user is not authorized More... | |
| static bool | testUserPipelineAccess (string user, list< auto > ids) |
| tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static bool | testUserPipelineAccess (string user, string name) |
| tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized) More... | |
| static *list< auto > | getUserPipelineAccessList (string user) |
| returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static *hash< auto > | getUserPipelineAccessHash (string user) |
| returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned More... | |
| static | registerSoapHandler (hash< auto > h) |
| registers the current service as a SOAP service and exports its methods that map to SOAP operations in the given WSDL to be called from the Qorus HttpServer with the SOAP protocol More... | |
| static *hash< auto > | getHttpCallContext () |
| returns a hash with HTTP call context information More... | |
| static hash< auto > | getLastEvents (softint count) |
| returns the last system events More... | |
| static hash< auto > | getLastEventsOr (softint count, auto filter, auto and_not) |
| gets the last system events that meet any of the filter criteria and none of the "and_not" criteria, if present More... | |
| static hash< auto > | getLastEventsAnd (softint count, auto filter, auto or_not) |
| gets the last system events that meet all of the filter criteria or none of the "or_not" criteria, if present More... | |
| static hash< auto > | waitForEvents (softint min_id=1, timeout timeout_ms=0) |
| return available system events More... | |
| static hash< auto > | waitForEventsOr (softint min_id=1, auto filter, timeout timeout_ms=0, auto and_not) |
| return system events that meet any of the given criteria and none of the optional "and not" criteria More... | |
| static hash< auto > | waitForEventsAnd (softint min_id=1, auto filter, timeout timeout_ms=0, auto or_not) |
| return system events that meet all of the given criteria or none of the optional "or not" criteria More... | |
| static int | startThread (auto code) |
| starts a service thread; passes the remaining arguments to the function to the new thread More... | |
| static int | startThreadArgs (auto code, auto args) |
| starts a service thread; uses the second argument as the argument list to pass to the new thread More... | |
| static hash< auto > | getServiceInfo (*hash< auto > cx) |
| returns information about the current service More... | |
| static | bindFtp (OMQ::AbstractFtpHandler handler) |
| binds an FTP handler to the service; listeners are started according to the listener information in the OMQ::AbstractFtpHandler argument More... | |
| static list< string > | bindHttp (OMQ::AbstractServiceHttpHandler handler, hash< HttpBindOptionInfo > opts=< HttpBindOptionInfo >{}) |
| binds an HTTP handler to the service More... | |
| static | bindHandler (string name, OMQ::AbstractServiceHttpHandler handler) |
| binds a new handler to a dedicated HTTP service listener by name More... | |
| static | bindHandler (string name, HttpServer::AbstractHttpRequestHandler handler, string url, *softlist< auto > content_type, *softlist< auto > special_headers, bool isregex=True) |
| binds a new handler to a dedicated HTTP service listener by name More... | |
| static *hash< auto > | getCallContext () |
| returns contextual information about the current call More... | |
| static string | getCallContextString (*hash< auto > cx) |
| returns a string describing the current call context More... | |
| static auto | callApiAsCurrentUser (string call, softlist< auto > args) |
| calls a system API with the argument list to the API method as a top-level argument to this method as the current user More... | |
| static *hash< auto > | getServiceInfoAsCurrentUser (string type, string name, *hash< auto > cx) |
| returns information about the given service from the service name (if it's currently loaded) and if the calling user can access the service More... | |
| static *hash< auto > | getServiceInfoAsCurrentUser (softint id, *hash< auto > cx) |
| returns information about the given service from the serviceid (if it's currently loaded) and if the calling user can access the service More... | |
| static list< hash< auto > > | getRunningWorkflowListAsCurrentUser (string name, *string ver) |
| returns a list of hashes giving information about the currently-running workflow execution instances if the current user can access them More... | |
| static hash< auto > | getActiveJobsAsCurrentUser () |
| Returns information on all active jobs visible to the given user. More... | |
| static hash< auto > | getResource (string name, hash< auto > ctx, int code=200, *hash< auto > hdr) |
Returns the given text or binary file resource as its native type in the "body" key of a hash along with an HTTP response code and optionally HTTP headers; if a template exists, then the template is rendered and returned, if the given resource does not exist, then an exception is raised. More... | |
| static *hash< auto > | tryGetResource (string name, hash< auto > ctx, int code=200, *hash< auto > hdr) |
Returns the given text or binary file resource as its native type in the "body" key of a hash along with an HTTP response code and optionally HTTP headers; if a template exists, then the template is rendered and returned, if the given resource does not exist, then NOTHING is returned. More... | |
| static *hash< auto > | getResourceHash () |
| returns a hash of the service's file resources (hash keys are service file resource names) or NOTHING if the service has none More... | |
| static list< string > | getResourceList () |
| returns a list of the service's file resources or NOTHING if the service has none More... | |
| static data | getResourceData (string name, *hash< auto > ctx) |
| Returns the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned, if the given resource does not exist, then an exception is raised. More... | |
| static WSDL::WebService | getResourceWsdl (string name, *hash< auto > ctx) |
| Returns the given file resource as a WSDL::WebService object; any XSD imports are resolved as service resources; if a template exists, then the template is rendered and returned, if the given resource does not exist, then an exception is raised. More... | |
| static *data | tryGetResourceData (string name, *hash< auto > ctx) |
| Returns the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned, if the given resource does not exist, then NOTHING is returned. More... | |
| static bool | hasResource (string name) |
| returns True if the given service file resource exists, False if not More... | |
| static hash< auto > | renderTemplate (string name, hash< auto > ctx) |
| explicitly renders a template file resource given the template argument hash More... | |
| static *hash< auto > | tryRenderTemplate (string name, hash< auto > ctx) |
| render a template file resource and returns the rendered template if the template exists, otherwise returns NOTHING More... | |
| static *hash< auto > | getTemplateHash () |
| returns a hash of the service's template file resources (hash keys are service template resource names) or NOTHING if the service has none More... | |
| static list< string > | getTemplateList () |
| returns a list of the service's template file resources or NOTHING if the service has none More... | |
| static bool | hasTemplate (string name) |
| returns True if the given service template file resource exists, False if not More... | |
| static | uiExtensionRegister (OMQ::QorusExtensionHandler handler) |
| registers the service as an extension of the system UI More... | |
| static | uiExtensionRegister (OMQ::QorusExtensionHandler handler, string url_name) |
| registers the service as an extension of the system UI with deterministic URL path More... | |
| static | streamRegister (string name, softlist< string > methods, code factory, string desc) |
| registers an HTTP chunked data handler as a service resource More... | |
| static | persistenceRegister (code factory) |
| registers the service as providing persistent/dedicated HTTP connection support More... | |
| static | persistenceThreadTerminate () |
| terminates a persistent connection in the current thread More... | |
| static list< hash< auto > > | startListeners (softstring bind, *string cert_path, *string key_path, *string key_password, *string name, int family=AF_UNSPEC) |
| starts one or more new global HTTP listeners; listeners will be started on all possible bind addresses in case more than one interface is resolved from the bind address given More... | |
| static | stopListener (softstring name) |
| stops a single listener based on its name or bind address; does not return until all connections on the listener have closed More... | |
| static | stopListenerId (softint id) |
| stops a single listener based on its listener ID; does not return until all connections on the listener have closed More... | |
| static list< string > | registerSoapListener (hash< auto > sh, softstring bind, int family=AF_UNSPEC, *HttpServer::AbstractAuthenticator auth, hash< HttpBindOptionInfo > opts=< HttpBindOptionInfo >{}) |
| starts a dedicated SOAP listener with the given WSDL and registers the current service as a SOAP service and exports its methods that map to SOAP operations in the given WSDL to be called from the Qorus HttpServer with the SOAP protocol More... | |
| static list< string > | registerSoapListeners (list< auto > sl, softstring bind, *hash< auto > lh, int family=AF_UNSPEC, *HttpServer::AbstractAuthenticator auth, hash< HttpBindOptionInfo > opts=< HttpBindOptionInfo >{}) |
| starts a dedicated SOAP listener with one or more WSDLs and registers the current service as a SOAP service and exports all methods that map to SOAP operations in the given WSDLs to be called from the Qorus HttpServer with the SOAP protocol More... | |
| static *hash< auto > | tryGetWfStaticData () |
| return the static data hash for the current workflow order if the service call was made from a workflow order, otherwise return NOTHING | |
| static *hash< auto > | tryGetWfDynamicData () |
| return the dynamic data hash for the current workflow order if the service call was made from a workflow order, otherwise return NOTHING | |
| static *hash< auto > | tryGetWfTempData () |
| return the temp data hash for the current workflow order if the service call was made from a workflow order, otherwise return NOTHING | |
| static | saveStateData (*hash< auto > data) |
serializes the given hash and stores against the service's state data in SERVICE_STATE_DATA More... | |
| static | saveStateDataPath (string path, auto value) |
serializes the given hash and stores against the service's state data in SERVICE_STATE_DATA More... | |
| static *hash< auto > | getStateData () |
| returns any service state state data stored with saveStateData() More... | |
| static | setOption (hash< auto > opts) |
| Changes option values on a service. More... | |
| static | setOption (string option, auto value) |
| Changes a single option value on a service. More... | |
| static auto | getOption () |
| Returns the value of the named service option(s) More... | |
| static auto | getOptionArgs (*softlist< string > args) |
| Returns the value of the named service option or options. More... | |
| static int | sleep (softint arg) |
| puts the current thread to sleep for a certain number of seconds More... | |
| static int | usleep (softint arg) |
| puts the current thread to sleep for a certain number of microseconds More... | |
| static int | usleep (date arg) |
| puts the current thread to sleep for a certain number of microseconds More... | |
| static auto | getConfigItemValue (string item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns the value of the given service configuration item More... | |
| static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
| returns a hash of all configuration items for the current service More... | |
| static | setConfigItemChangeCallback (*code callback) |
| Set a callback for config item value changes in the service. More... | |
| static string | generateTokenForCurrentUser (timeout expiry=DefaultTokenExpirationPeriod) |
| Generates an access token for the current user with the given expiration time. More... | |
| static string | generateTokenForCurrentUser (int expiry_seconds) |
| Generates an access token for the current user with the given expiration time. More... | |
| static string | generateTokenCheckUser (string username, int expire_seconds) |
| Generates an authentication token for the given user. More... | |
| static string | generateTokenCheckUser (string username, timeout expiry) |
| Generates an authentication token for the given user. More... | |
| static string | generateTokenLoginUser (string username, int expire_seconds, reference< hash< auto > > cx) |
| Generates an authentication token for the given user and logs the user in for the existing connection context. More... | |
| static string | generateTokenLoginUser (string username, timeout expiry, reference< hash< auto > > cx) |
| Generates an authentication token for the given user and logs the user in for the existing connection context. More... | |
| static | setUserLoginContextFromToken (string token, reference< hash< auto > > cx) |
| Sets the user login context from the given token. More... | |
| Static Public Member Methods inherited from OMQ::UserApi::UserApi | |
| static *hash< auto > | getUserServiceInfo (string name) |
| returns information about the given user service (if it's currently loaded) More... | |
| 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 More... | |
| 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 More... | |
| static hash< auto > | getSqlCacheInfo () |
| get information about cached object More... | |
| static | clearSqlTableCache (string datasource, *string table_name) |
| clears all objects for given datasource from the cache (for example, if database objects have been updated in the dataserver) More... | |
| static | clearSqlTableCache (AbstractDatasource datasource, *string table_name) |
| clears cached objects for given datasource (for example, if database objects have been updated in the dataserver) More... | |
| 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. More... | |
| static list< auto > | getValueMaps () |
| Gets all value maps valid for the current interface. More... | |
| static bool | postSlaEventSuccess (string sla, number value) |
| posts a successful SLA event for SLA monitoring and performance tracking More... | |
| static bool | postSlaEventError (string sla, number value, string err, string desc) |
| posts an unsuccessful SLA event for SLA monitoring and performance tracking More... | |
| static | flushSlaEvents () |
| flushes all pending SLA events to disk and returns after the data has been committed More... | |
| static *hash< auto > | getSystemServiceInfo (string name) |
| returns information about the given system service (if it's currently loaded) More... | |
| static *hash< auto > | getServiceInfo (string type, string name) |
| returns information about the given service (if it's currently loaded) More... | |
| static list | getRunningWorkflowList (*string name, *string ver) |
| returns a list of hashes giving information about the currently-running workflow execution instances More... | |
| static hash | getRunningWorkflowInfo (softint id) |
| returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not More... | |
| static softint | createOrder (string name, *string version, hash< auto > params, string status=StatReady) |
| creates a workflow order data instance in the database More... | |
| static softint | createRemoteOrder (string remote, string name, *string version, hash< auto > params, string status=StatReady, bool register_dependency=True) |
| creates a workflow order data instance in a remote Qorus instance More... | |
| static hash< auto > | execSynchronousWorkflow (string name, *string version, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid) |
| executes a workflow order synchronously and returns the final status and order ID in a hash More... | |
| static int | postUserEvent (string severity, auto info) |
| posts an application event of class OMQ::QE_CLASS_USER More... | |
| static hash | runtimeProperties () |
| returns Qorus runtime properties as a hash More... | |
| static auto | callNetworkApiArgsWithAuthentication (string user, string pass, string call, softlist< auto > args) |
| calls a system RPC API with authentication information (username and password) More... | |
| static auto | callNetworkApiArgs (string call, *softlist< auto > args) |
| calls a system RPC API with the argument list to the API method as a top-level argument to this method; the API is called with system permissions (no restrictions) More... | |
| static auto | callNetworkApi (string call) |
| calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) More... | |
| static auto | callRestApi (string method, string path, *hash< auto > body_args) |
| calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More... | |
| static auto | callRestApiWithAuthentication (string user, string pass, string method, string path, *hash< auto > body_args) |
| calls a system REST API method with authentication information (username and password) and returns the result More... | |
| static hash< auto > | getSystemInfo () |
| returns a hash of system info More... | |
| static int | getSessionId () |
| returns the current Qorus application session ID More... | |
| static | startCapturingObjectsFromJava () |
| Starts capturing Qore objects created from Java APIs in the current interface's object cache. More... | |
| static | stopCapturingObjectsFromJava () |
| Stops capturing Qore objects created from Java APIs in the current interface's object cache. More... | |
| static | startCapturingObjectsFromPython () |
| Starts capturing Qore objects created from Python APIs in the current interface's object cache. More... | |
| static | stopCapturingObjectsFromPython () |
| Stops capturing Qore objects created from Python APIs in the current interface's object cache. More... | |
| static | saveObjectInObjectCache (object obj) |
| Saves the object in the object cache. More... | |
| static bool | clearObjectFromObjectCache (object obj) |
| Removes the object from the object cache. More... | |
| static *date | checkObjectCache (object obj) |
| Returns the date/time the object was cached or NOTHING if the object is not in the cache. More... | |
| static int | getObjectCacheSize () |
| Returns the number of objects in the cache. More... | |
| static int | clearObjectCache () |
| Clears the entire the object cache. More... | |
| static int | clearObjectCache (date cutoff) |
| Clears the entire the object cache for all objects cached before the given date/time. More... | |
| static list< hash< CallStackInfo > > | getThreadCallStack () |
| Allows the current thread's call stack to be retrieved in Qorus. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| static | logWithLevel (Logger::LoggerLevel level, string msg) |
| Writes to the current interface log file with the given log level. More... | |
| static | logWithLevel (int level, string msg) |
| Writes to the current interface log file with the given log level. More... | |
| static | logWithLevelArgs (Logger::LoggerLevel level, string msg, *softlist< auto > args) |
| Writes to the current interface log file with the given log level. More... | |
| static | logWithLevelArgs (int level, string msg, *softlist< auto > args) |
| Writes to the current interface log file with the given log level. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| static *int | auditUserEvent (string user_event, *string info1, *string info2) |
| creates a user audit event (with audit code AE_USER_EVENT) against the workflow, service, or job instance More... | |
| static bool | auditCheckEventString (string opt) |
| checks if the given audit event (given as a string) is enabled More... | |
| static bool | auditCheckEvent (softint opt) |
| checks if the given audit event (given as an integer code) is enabled More... | |
| static int | auditGetMask () |
| returns the audit event mask More... | |
| static bool | isKubernetes () |
| returns True when Qorus is running under Kubernetes More... | |
| static int | usleep (date arg) |
| puts the current thread to sleep for a certain number of microseconds More... | |
| static int | sleep (softint arg) |
| puts the current thread to sleep for a certain number of seconds More... | |
| static int | usleep (softint arg) |
| puts the current thread to sleep for a certain number of microseconds More... | |
| static hash< auto > | getQorusOptions () |
| returns the value of the given system option or options More... | |
| static hash< auto > | getQorusOptionInfo () |
| returns a hash giving information about system options More... | |
| static hash< auto > | getQorusOptionInfoArgs (*list< auto > args) |
| returns a hash giving information about system options More... | |
| static auto | getQorusOptionsArgs (softlist< auto > args) |
| returns the value of the given system option or options More... | |
| static hash< auto > | getActiveJobs () |
| Returns information on all active jobs visible to the calling user. More... | |
| static object | getUserConnection (string name, bool connect=True, bool register_dependency=True, *hash< auto > rtopts) |
| Returns an object corresponding to a defined user connection. More... | |
| static hash< auto > | getUserConnectionTags (string name) |
| Returns any tags set on the given user connection. More... | |
| static Qore::SQL::Datasource | getDatasourceDedicated (string name, bool register_dependency=True) |
| returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions More... | |
| static AbstractDatasource | getDatasourcePool (string name, bool register_dependency=True) |
| returns a DatasourcePool object for the given datasource name More... | |
| static hash< auto > | getDatasourceInfo (string name) |
| returns a hash of information for the given datasource, if known, otherwise throws an exception More... | |
| static QorusSystemAPIHelper | getRemoteRpcConnection (string name, bool connect=True, bool register_dependency=True) |
| Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection. More... | |
| static QorusSystemRestHelper | getRemoteRestConnection (string name, bool connect=True, bool register_dependency=True) |
| Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More... | |
| static | raiseTransientAlert (string alert, string reason, *hash< auto > info) |
| raises a transient system alert from a workflow, service, or job More... | |
| static string | qorusGetLocalUrl (*string username, *string password) |
| returns a string giving the local system URL More... | |
| static | setOption (hash< auto > hash) |
| Changes option values on a workflow, service, or job. More... | |
| static auto | getOption () |
| Returns the value of the named workflow, service, or job option or options. More... | |
| static auto | getOptionArgs (*softlist< string > args) |
| Returns the value of the named workflow, service, or job option or options. More... | |
| static hash< auto > | blockOrder (softint wfiid) |
| block the given workflow order data instance More... | |
| static hash< auto > | unblockOrder (softint wfiid, *hash< auto > tempdata, *hash< auto > orderkeys) |
| unblocks the given workflow order data instance More... | |
| static hash< auto > | cancelOrder (softint wfiid) |
| cancel the given workflow order data instance More... | |
| static hash< auto > | uncancelOrder (softint wfiid, *hash< auto > tempdata) |
| uncancels the given workflow order data instance More... | |
| static | updateDynamicOrderData (softint wfiid, hash< auto > new_data) |
| updates the given workflow order instance's dynamic data hash atomically More... | |
| static | updateDynamicOrderDataPath (softint wfiid, string path, auto value) |
| updates the given workflow order instance's dynamic data hash atomically More... | |
| static *hash< auto > | getUserContextInfo () |
| returns a hash for the current user context More... | |
| static *string | getContextUserName () |
| returns the current username for any external user-initiated call or NOTHING if executing in a system context More... | |
| static auto | getConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns config item value in the current user context More... | |
| static auto | getInterfaceConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns config item value in the current interface context More... | |
| static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
| returns a hash of all configuration items for the current interface More... | |
| static hash< auto > | getInterfaceConfigItemHash (*hash< auto > local_context) |
| Returns a hash of all configuration items for the current context as a combination of local and global configuration items. More... | |
| 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 More... | |
| 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 More... | |
| static AbstractDataProvider | getDataProvider (hash< auto > h, *hash< auto > ctx) |
| Returns a data provider corresponding to the hash description. More... | |
| static AbstractDataProvider | getDataProvider (string path) |
| returns the data provider given by a path string More... | |
| static AbstractDataProvider | getDataProvider (string type, string name, *string path, *hash< auto > opts, *hash< auto > ctxt, *bool handle_template_args) |
| returns the data provider given by a path string More... | |
| static AbstractDataProviderType | getQorusType (string type_path) |
| Returns a data provider type from a direct type path. More... | |
| static AbstractDataProviderType | getTypeFromPath (string path) |
| returns a data provider type identified by a path string More... | |
| static Mapper::Mapper | getMapper (string name, *hash< auto > rtopts) |
| returns the given mapper if registered for the current interface More... | |
| static Qore::AbstractIterator | getMapperIterator (string name, Qore::AbstractIterator input, *hash< auto > rtopts) |
| returns an iterator for the named mapper using the iterator argument for input More... | |
| static bool | postSyncEvent (string eventtype, string eventkey) |
| posts a workflow synchronization event given the event type name and the unique event key More... | |
| static hash< auto > | propGet () |
| returns a hash of all system properties in all domains More... | |
| 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 More... | |
| 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 More... | |
| static string | propUpdate (string domain, softstring key, auto value) |
| changes (inserts, updates, or deletes) the value of a single system property More... | |
| static hash< auto > | propUpdate (hash< auto > h) |
| changes (inserts, updates, or deletes) the value of one or more system properties according to a hash argument More... | |
| static softint | getNextSequenceValue (AbstractDatasource ds, string name) |
| returns the next sequence value for the given datasource and sequence More... | |
| static softint | getNextSequenceValue (string ds, string name) |
| returns the next sequence value for the given datasource and sequence More... | |
| static string | serializeQorusData (auto d) |
| returns a string giving the default serialization of the given data structure for storage in Qorus More... | |
| static string | serializeQorusDataWithNothing (auto d) |
| returns a string giving the default serialization of the given data structure for storage in Qorus More... | |
| static auto | deserializeQorusData (string data) |
| parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data More... | |
| static auto | deserializeQorusData (null data) |
| deserializing a NULL value from the DB returns no value | |
| static *string | restartTransaction (string driver, hash< auto > ex) |
| returns a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING More... | |
| static bool | isInternalSystemDebuggingEnabled () |
| returns True if internal system debugging is enabled More... | |
| static auto | getHashDotValue (*hash< auto > var_data, string var_name, *reference< bool > missing_input) |
| returns the value of the given key from the given hash, respects dot notation in the key name More... | |
| static auto | expandOneVariable (string str, string var_context, auto template_arg, *hash< auto > local_context, *bool brackets, bool expand_complex_values=True, *reference< bool > missing_input) |
| expands one variable in a templated string More... | |
| static bool | isSingleTemplatedString (auto value) |
| checks if the given value is a templated string with only one expandable variable More... | |
| static auto | expandTemplatedValue (auto value, *hash< auto > local_context, bool expand_complex_values=True, *reference< bool > missing_input, *string template_context) |
| expands all variables in a templated string More... | |
| static softlist< auto > | expandComplexValue (list< auto > val, *hash< auto > local_context, *string template_context) |
| expands all variables in a list with templated values More... | |
| static hash< auto > | expandComplexValue (hash< auto > val, *hash< auto > local_context, *string template_context) |
| expands all variables in a hash with templated values More... | |
| static hash< BbVariable > | bbParseExactlyOneVariable (string str) |
| parses one template variable and returns a hash with its parts More... | |
| static auto | getInputData (string field_name, *hash< auto > local_context, *hash< auto > input_data_cfg) |
| returns specified input data field's value More... | |
| static hash< auto > | getInputData (*hash< auto > input_data_cfg, *hash< auto > local_context) |
| returns all input data More... | |
| static *hash< auto > | updateHashDotValue (*hash< auto > var_data, string var_name, auto value) |
| updates the given hash with a key in dot notation with the given value More... | |
| static | updateOutputData (string field_name, auto output_data, *hash< auto > output_data_cfg) |
| updates specified output data field's value More... | |
| static | updateOutputData (hash< auto > all_output_data, hash< auto > output_data_cfg=UserApi::getConfigItemValue(BB_OUTPUT_DATA_CFG_KEY, NOTHING, False)) |
| updates all output data More... | |
| static | writeOutputData (*hash< auto > output_data) |
| Writes output data using a concise format. More... | |
| static string | getTextFileFromLocation (string location) |
| returns string data for the given file location More... | |
| static binary | getBinaryFileFromLocation (string location) |
| returns binary data for the given file location More... | |
| static Qore::StreamReader | getStreamReaderFromLocation (string location) |
| Returns a string stream for the file's data at the given location. More... | |
| static Qore::InputStream | getBinaryStreamFromLocation (string location) |
| Returns an input stream for file data at the given location. More... | |
| static | writeFileToLocation (string location, data contents) |
| Writes data to a file at the given location. More... | |
| static FileLocationHandler::OutputStreamWrapper | getOutputStreamForLocation (string location) |
| Returns an output stream for writing data to the given location. More... | |
| static auto | executeFsm (string fsm_name, auto arg) |
| Executes the given Finite State Machine and returns the final output. More... | |
| static | registerFsmAsObserver (string fsm_name, DataProvider::Observable observable, string event_id) |
| Registers the given Finite State Machine with the given object as an Observer. More... | |
| static string | generateTokenForUser (string username, timeout expiry=DefaultTokenExpirationPeriod) |
| Generates an access token for the given user with the given expiration time. More... | |
| static string | generateTokenForUser (string username, int expiry_seconds) |
| Generates an access token for the given user with the given expiration time. More... | |
| static bool | invalidateToken (string token) |
| Invalidates the given token. More... | |
| static | refreshToken (string token, *int expiry_seconds) |
| Refreshes the given token. More... | |
| static | refreshToken (string token, timeout expiry_seconds) |
| Refreshes the given token. More... | |
| static *hash< TokenInfo > | getTokenInfo (string token, *bool refresh_token) |
| Returns information for the given token. More... | |
| static *hash< QorusUserInfo > | getCurrentUserInfo () |
| Returns information for the current user. More... | |
| static hash< QorusUserInfo > | getUserInfo (string username) |
| Returns information for the given user. More... | |
| static public hash< auto > | bindSubworkflow (hash< auto > wf, hash< auto > order) |
| This method binds a workflow to a subworkflow step. More... | |
| static public hash< auto > | skipSubworkflow () |
| This method skips binding a workflow to a subworkflow step. More... | |
| static public | submitAsyncKey (string key) |
| Binds the given key to the asynchronous step. More... | |
| static public | skipAsyncStep () |
| This method will skip the execution of an asynchronous step. More... | |
| static public | bindEvent (string eventkey) |
| binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) More... | |
| static public | bindEventUnposted (string eventkey) |
| binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised More... | |
| static public | skipEvent () |
| skips a workflow synchronization event step More... | |
| static | leaveParentFeedback (string key, auto value) |
| leaves feedback for a parent workflow More... | |
| static auto | getChildFeedback (string key) |
| gets feedback from a child workflow order with the given key More... | |
| static bool | isWorkflowContext () |
| Returns True if the code is executing in an immediate workflow context, False if not. More... | |
| static bool | isServiceContext () |
| Returns True if the code is executing in an immediate service context, False if not. More... | |
| static bool | isJobContext () |
| Returns True if the code is executing in an immediate job context, False if not. More... | |
| Public Attributes inherited from OMQ::UserApi::Service::ServiceApi | |
| const | ServiceCallContextKeys = ("socket", "socket-info", "peer-info", "url", "id", "ssl", "user", "client-cert") |
keys returned from the cx hash in getCallContext() if present More... | |
| Static Private Member Methods inherited from OMQ::UserApi::UserApi | |
| static QorusProgram | DynamicLogic (False, CommonParseOptions|PO_NO_INHERIT_USER_CLASSES|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_INHERIT_USER_CONSTANTS|PO_NO_INHERIT_USER_HASHDECLS|PO_NEW_STYLE|PO_STRICT_ARGS|PO_REQUIRE_TYPES, QorusServerDefines) |
| Program for dynamic logic. | |
| Private Attributes inherited from OMQ::UserApi::UserApi | |
| const | DataProviderRootValues |
| data provider root path values | |
| const | DataTypeRootValues |
| data type root path values | |
| const | DataProviderPathTypeValues |
| data type path provider type values | |
The base class for Qorus services.
Qorus service constructors do not take any arguments; see Service Constructors and Static Initialization for information about constructors and static class initialization.