 |
Qorus Integration Engine® Enterprise Edition 7.0.6_prod
|
|
Qorus Integration Engine® Enterprise Edition 7.0.6_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. | |
| *hash< string, hash< ConfigItemInfo > > | getConfigItemsImpl () |
| Method to return local configuration items; this method should be overridden by child classes to provide item configuration. | |
| 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 | |
| static | checkAuthorizationArgs (softlist< string > args) |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| static | checkFsmAccess (list< softint > 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 | |
| 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 | |
| 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) | |
| static bool | testFsmAccess (string name) |
| tests if the current user has access to the given single Finite State Machine | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| static | checkConnectionAccess (int id) |
| checks if the current user has access to the given connection; an exception is thrown if not | |
| static | checkConnectionAccess (list< softint > ids) |
| checks if the current user has access to the given list of connections; an exception is thrown if not | |
| static bool | testConnectionAccess (list< softint > ids) |
| tests if the current user has access to the given list of connections and returns True (if authorization is granted) or False (if the user is not authorized) | |
| static bool | testConnectionAccess (int id) |
| tests if the current user has access to the given connection and returns True (if authorization is granted) or False (if the user is not authorized) | |
| static *list< auto > | getConnectionAccessList () |
| returns a list of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned | |
| static *hash< auto > | getConnectionAccessHash () |
| returns a hash of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned | |
| static | checkUserAuthorization (string user) |
| checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| static *hash< auto > | getHttpCallContext () |
| returns a hash with HTTP call context information | |
| static hash< auto > | getLastEvents (softint count) |
| returns the last system events | |
| 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 | |
| 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 | |
| static hash< auto > | waitForEvents (softint min_id=1, timeout timeout_ms=0) |
| return available system events | |
| 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 | |
| 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 | |
| static int | startThread (auto code) |
| starts a service thread; passes the remaining arguments to the function to the new thread | |
| 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 | |
| static hash< auto > | getServiceInfo (*hash< auto > cx) |
| returns information about the current service | |
| 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 | |
| static list< string > | bindHttp (OMQ::AbstractServiceHttpHandler handler, hash< HttpBindOptionInfo > opts=< HttpBindOptionInfo >{}) |
| binds an HTTP handler to the service | |
| static | bindHandler (string name, OMQ::AbstractServiceHttpHandler handler) |
| binds a new handler to a dedicated HTTP service listener by name | |
| 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 | |
| static *hash< auto > | getCallContext () |
| returns contextual information about the current call | |
| static string | getCallContextString (*hash< auto > cx) |
| returns a string describing the current call context | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| static hash< auto > | getActiveJobsAsCurrentUser () |
| Returns information on all active jobs visible to the given user. | |
| 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. | |
| 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. | |
| 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 | |
| static list< string > | getResourceList () |
| returns a list of the service's file resources or NOTHING if the service has none | |
| 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. | |
| 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. | |
| 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. | |
| static bool | hasResource (string name) |
| returns True if the given service file resource exists, False if not | |
| static hash< auto > | renderTemplate (string name, hash< auto > ctx) |
| explicitly renders a template file resource given the template argument hash | |
| 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 | |
| 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 | |
| static list< string > | getTemplateList () |
| returns a list of the service's template file resources or NOTHING if the service has none | |
| static bool | hasTemplate (string name) |
| returns True if the given service template file resource exists, False if not | |
| static | uiExtensionRegister (OMQ::QorusExtensionHandler handler) |
| registers the service as an extension of the system UI | |
| static | uiExtensionRegister (OMQ::QorusExtensionHandler handler, string url_name) |
| registers the service as an extension of the system UI with deterministic URL path | |
| static | streamRegister (string name, softlist< string > methods, code factory, string desc) |
| registers an HTTP chunked data handler as a service resource | |
| static | persistenceRegister (code factory) |
| registers the service as providing persistent/dedicated HTTP connection support | |
| static | persistenceThreadTerminate () |
| terminates a persistent connection in the current thread | |
| 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 | |
| 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 | |
| static | stopListenerId (softint id) |
| stops a single listener based on its listener ID; does not return until all connections on the listener have closed | |
| 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 | |
| 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 | |
| static *hash< auto > | tryGetWfStaticData () |
| return the static data hash for the current workflow order if the service call was made from a workflow order | |
| 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 | |
| static | saveStateDataPath (string path, auto value) |
serializes the given hash and stores against the service's state data in SERVICE_STATE_DATA | |
| static *hash< auto > | getStateData () |
| returns any service state state data stored with saveStateData() | |
| static | setOption (hash< auto > opts) |
| Changes option values on a service. | |
| static | setOption (string option, auto value) |
| Changes a single option value on a service. | |
| static auto | getOption (...) |
| Returns the value of the named service option(s) | |
| static auto | getOptionArgs (*softlist< string > args) |
| Returns the value of the named service option or options. | |
| static int | sleep (softint arg) |
| puts the current thread to sleep for a certain number of seconds | |
| static int | usleep (softint arg) |
| puts the current thread to sleep for a certain number of microseconds | |
| static int | usleep (date arg) |
| puts the current thread to sleep for a certain number of microseconds | |
| static auto | getConfigItemValue (string item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns the value of the given service configuration item | |
| static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
| returns a hash of all configuration items for the current service | |
| static | setConfigItemChangeCallback (*code callback) |
| Set a callback for config item value changes in the service. | |
| static string | generateTokenForCurrentUser (timeout expiry=DefaultTokenExpirationPeriod) |
| Generates an access token for the current user with the given expiration time. | |
| static string | generateTokenForCurrentUser (int expiry_seconds) |
| Generates an access token for the current user with the given expiration time. | |
| static string | generateTokenCheckUser (string username, int expire_seconds) |
| Generates an authentication token for the given user. | |
| static string | generateTokenCheckUser (string username, timeout expiry) |
| Generates an authentication token for the given user. | |
| 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. | |
| 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. | |
| static | setUserLoginContextFromToken (string token, reference< hash< auto > > cx) |
| Sets the user login context from the given token. | |
| static bool | tryAuthenticateRequest (reference< hash< auto > > cx) |
| Try to authenticate an external request from the context hash. | |
| static | addSystemEventObserver (DataProvider::Observer observer) |
| Add an observer for system events. | |
| static bool | removeSystemEventObserver (DataProvider::Observer observer) |
| Removes an observer for system events. | |
| 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) | |
| 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 hash< auto > | getSqlCacheInfo () |
| get information about cached object | |
| 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) | |
| static | clearSqlTableCache (AbstractDatasource datasource, *string table_name) |
| clears cached objects for given datasource (for example, if database objects have been updated in the dataserver) | |
| 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 list< auto > | getValueMaps () |
| Gets all value maps valid for the current interface. | |
| static bool | postSlaEventSuccess (string sla, number value) |
| posts a successful SLA event for SLA monitoring and performance tracking | |
| static bool | postSlaEventError (string sla, number value, string err, string desc) |
| posts an unsuccessful SLA event for SLA monitoring and performance tracking | |
| static | flushSlaEvents () |
| flushes all pending SLA events to disk and returns after the data has been committed | |
| static *hash< auto > | getSystemServiceInfo (string name) |
| returns information about the given system service (if it's currently loaded) | |
| static *hash< auto > | getServiceInfo (string type, string name) |
| returns information about the given service (if it's currently loaded) | |
| static list | getRunningWorkflowList (*string name, *string ver) |
| returns a list of hashes giving information about the currently-running workflow execution instances | |
| 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 | |
| static softint | createOrder (string name, *string version, hash< auto > params, string status=StatReady) |
| creates a workflow order data instance in the database | |
| static softint | createOrder (int wfid, hash< auto > params, string status=StatReady) |
| creates a workflow order data instance in the database | |
| 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 | |
| static softint | createRemoteOrder (string remote, int wfid, hash< auto > params, string status=StatReady, bool register_dependency=True) |
| creates a workflow order data instance in a remote Qorus instance | |
| 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 | |
| static hash< auto > | execSynchronousWorkflow (int wfid, 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 | |
| static hash< auto > | execSynchronousWorkflowAsync (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 in the background and returns immediately | |
| static hash< auto > | execSynchronousWorkflowAsync (int wfid, 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 in the background and returns immediately | |
| static int | postUserEvent (string severity, auto info) |
| posts an application event of class OMQ::QE_CLASS_USER | |
| static hash | runtimeProperties () |
| returns Qorus runtime properties as a hash | |
| static auto | callNetworkApiArgsWithAuthentication (string user, string pass, string call, softlist< auto > args) |
| calls a system RPC API with authentication information (username and password) | |
| static auto | callNetworkApiArgs (string call, *softlist< auto > args) |
| calls a system RPC API and returns the respose | |
| static auto | callNetworkApi (string call,...) |
| calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) | |
| static auto | callRestApi (string method, string path, *hash< auto > body_args) |
| calls a system REST API method and returns the result | |
| static auto | callRestApiWithAuthentication (string user, string pass, string method, string path, *hash< auto > body_args) |
| calls a system REST API method with authentication information and returns the result | |
| static hash< auto > | getSystemInfo () |
| returns a hash of system info | |
| static int | getSessionId () |
| returns the current Qorus application session ID | |
| static | startCapturingObjectsFromJava () |
| Starts capturing Qore objects created from Java APIs in the current interface's object cache. | |
| static | stopCapturingObjectsFromJava () |
| Stops capturing Qore objects created from Java APIs in the current interface's object cache. | |
| static | startCapturingObjectsFromPython () |
| Starts capturing Qore objects created from Python APIs in the current interface's object cache. | |
| static | stopCapturingObjectsFromPython () |
| Stops capturing Qore objects created from Python APIs in the current interface's object cache. | |
| static | saveObjectInObjectCache (object obj) |
| Saves the object in the object cache. | |
| static bool | clearObjectFromObjectCache (object obj) |
| Removes the object from the object cache. | |
| static *date | checkObjectCache (object obj) |
| Returns the date/time the object was cached or NOTHING if the object is not in the cache. | |
| static int | getObjectCacheSize () |
| Returns the number of objects in the cache. | |
| static int | clearObjectCache () |
| Clears the entire the object cache. | |
| static int | clearObjectCache (date cutoff) |
| Clears the entire the object cache for all objects cached before the given date/time. | |
| static list< hash< CallStackInfo > > | getThreadCallStack () |
| Allows the current thread's call stack to be retrieved in Qorus. | |
| 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 (Logger::LoggerLevel level, string msg,...) |
| Writes to the current interface log file with the given log level. | |
| static | logWithLevel (int level, string msg,...) |
| Writes to the current interface log file with the given log level. | |
| static | logWithLevelArgs (Logger::LoggerLevel level, string msg, *softlist< auto > args) |
| 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. | |
| 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 | |
| static bool | auditCheckEventString (string opt) |
| checks if the given audit event (given as a string) is enabled | |
| static bool | auditCheckEvent (softint opt) |
| checks if the given audit event (given as an integer code) is enabled | |
| static int | auditGetMask () |
| returns the audit event mask | |
| static bool | isKubernetes () |
| returns True when Qorus is running under Kubernetes | |
| static int | usleep (date arg) |
| puts the current thread to sleep for a certain number of microseconds | |
| static int | sleep (softint arg) |
| puts the current thread to sleep for a certain number of seconds | |
| static int | usleep (softint arg) |
| puts the current thread to sleep for a certain number of microseconds | |
| static hash< auto > | getQorusOptions (...) |
| returns the value of the given system option or options | |
| static hash< auto > | getQorusOptionInfo (...) |
| returns a hash giving information about system options | |
| static hash< auto > | getQorusOptionInfoArgs (*list< auto > args) |
| returns a hash giving information about system options | |
| static auto | getQorusOptionsArgs (softlist< auto > args) |
| returns the value of the given system option or options | |
| static hash< auto > | getActiveJobs () |
| Returns information on all active jobs visible to the calling user. | |
| static object | getUserConnection (string name, bool connect=True, bool register_dependency=True, *hash< auto > rtopts) |
| Returns an object corresponding to a defined user connection. | |
| static hash< auto > | getUserConnectionTags (string name) |
| Returns any tags set on the given user connection. | |
| 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 | |
| static AbstractDatasource | getDatasourcePool (string name, bool register_dependency=True) |
| returns a DatasourcePool object for the given datasource name | |
| static hash< auto > | getDatasourceInfo (string name) |
| returns a hash of information for the given datasource, if known, otherwise throws an exception | |
| static QorusSystemAPIHelper | getRemoteRpcConnection (string name, bool connect=True, bool register_dependency=True) |
| Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection. | |
| static QorusSystemRestHelper | getRemoteRestConnection (string name, bool connect=True, bool register_dependency=True) |
| Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. | |
| static | raiseTransientAlert (string alert, string reason, *hash< auto > info) |
| raises a transient system alert from a workflow, service, or job | |
| static string | qorusGetPublicUrl (*hash< auto > cx) |
| Returns a string giving the remote / publicly-accessble system URL. | |
| static string | qorusGetLocalUrl (*string username, *string password) |
| returns a string giving the local system URL | |
| static | setOption (hash< auto > hash) |
| Changes option values on a workflow, service, or job. | |
| static auto | getOption (...) |
| Returns the value of the named workflow, service, or job option or options. | |
| static auto | getOptionArgs (*softlist< string > args) |
| Returns the value of the named workflow, service, or job option or options. | |
| static hash< auto > | blockOrder (softint wfiid) |
| block the given workflow order data instance | |
| static hash< auto > | unblockOrder (softint wfiid, *hash< auto > tempdata, *hash< auto > orderkeys) |
| unblocks the given workflow order data instance | |
| static hash< auto > | cancelOrder (softint wfiid) |
| cancel the given workflow order data instance | |
| static hash< auto > | uncancelOrder (softint wfiid, *hash< auto > tempdata) |
| uncancels the given workflow order data instance | |
| static | updateDynamicOrderData (softint wfiid, hash< auto > new_data) |
| updates the given workflow order instance's dynamic data hash atomically | |
| static | updateDynamicOrderDataPath (softint wfiid, string path, auto value) |
| updates the given workflow order instance's dynamic data hash atomically | |
| static *hash< auto > | getUserContextInfo () |
| returns a hash for the current user context | |
| static *string | getContextUserName () |
| returns the current username for any external user-initiated call or NOTHING if executing in a system context | |
| static auto | getConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns config item value in the current user context | |
| static auto | getInterfaceConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
| returns config item value in the current interface context | |
| static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
| returns a hash of all configuration items for the current interface | |
| 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. | |
| 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 AbstractDataProvider | getDataProvider (hash< auto > h, *hash< auto > ctx) |
| Returns a data provider corresponding to the hash description. | |
| static AbstractDataProvider | getDataProvider (string path) |
| returns the data provider given by a path string | |
| 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 | |
| static AbstractDataProviderType | getQorusType (string type_path) |
| Returns a data provider type from a direct type path. | |
| static AbstractDataProviderType | getType (hash< auto > h, *hash< auto > ctx) |
| Returns a type corresponding to the hash description. | |
| static AbstractDataProviderType | getType (string typename, string name, *string path, *string subtype, *string subtypename, *hash< auto > options, *hash< auto > ctx) |
| Returns a type corresponding to the arguments. | |
| static AbstractDataProviderType | getTypeFromPath (string path) |
| returns a data provider type identified by a path string | |
| static Mapper::Mapper | getMapper (string name, *hash< auto > rtopts) |
| returns the given mapper if registered for the current interface | |
| 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 | |
| static bool | postSyncEvent (string eventtype, string eventkey) |
| posts a workflow synchronization event given the event type name and the unique event key | |
| 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 string | propUpdate (string domain, softstring key, auto value) |
| changes (inserts, updates, or deletes) the value of a single system property | |
| 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 | |
| static softint | getNextSequenceValue (AbstractDatasource ds, string name) |
| returns the next sequence value for the given datasource and sequence | |
| static softint | getNextSequenceValue (string ds, string name) |
| returns the next sequence value for the given datasource and sequence | |
| static string | serializeQorusData (auto d) |
| returns a string giving the default serialization of the given data structure for storage in Qorus | |
| static string | serializeQorusDataWithNothing (auto d) |
| returns a string giving the default serialization of the given data structure for storage in Qorus | |
| static auto | deserializeQorusData (string data) |
| parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data | |
| 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 | |
| static bool | isInternalSystemDebuggingEnabled () |
| returns True if internal system debugging is enabled | |
| 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 | |
| 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 | |
| static bool | isSingleTemplatedString (auto value) |
| checks if the given value is a templated string with only one expandable variable | |
| 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 | |
| static softlist< auto > | expandComplexValue (list< auto > val, *hash< auto > local_context, *string template_context) |
| expands all variables in a list with templated values | |
| static hash< auto > | expandComplexValue (hash< auto > val, *hash< auto > local_context, *string template_context) |
| expands all variables in a hash with templated values | |
| static hash< BbVariable > | bbParseExactlyOneVariable (string str) |
| parses one template variable and returns a hash with its parts | |
| static auto | getInputData (string field_name, *hash< auto > local_context, *hash< auto > input_data_cfg) |
| returns specified input data field's value | |
| static hash< auto > | getInputData (*hash< auto > input_data_cfg, *hash< auto > local_context) |
| returns all input data | |
| 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 | |
| static *hash< auto > | deleteHashDotValue (*hash< auto > var_data, string var_name, *bool recursive) |
| Updates the given hash by deleting the value described by a key in dot notation. | |
| static | updateOutputData (string field_name, auto output_data, *hash< auto > output_data_cfg) |
| updates specified output data field's value | |
| 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 | |
| static | writeOutputData (*hash< auto > output_data) |
| Writes output data using a concise format. | |
| static string | getTextFileFromLocation (string location) |
| returns string data for the given file location | |
| static binary | getBinaryFileFromLocation (string location) |
| returns binary data for the given file location | |
| static Qore::StreamReader | getStreamReaderFromLocation (string location) |
| Returns a string stream for the file's data at the given location. | |
| static Qore::InputStream | getBinaryStreamFromLocation (string location) |
| Returns an input stream for file data at the given location. | |
| static | writeFileToLocation (string location, data contents) |
| Writes data to a file at the given location. | |
| static FileLocationHandler::OutputStreamWrapper | getOutputStreamForLocation (string location) |
| Returns an output stream for writing data to the given location. | |
| static auto | executeFsm (string fsm_name, auto arg) |
| Executes the given Finite State Machine and returns the final output. | |
| static | registerFsmAsObserver (string fsm_name, DataProvider::Observable observable, string event_id) |
| Registers the given Finite State Machine with the given object as an Observer. | |
| static string | generateTokenForUser (string username, timeout expiry=DefaultTokenExpirationPeriod) |
| Generates an access token for the given user with the given expiration time. | |
| static string | generateTokenForUser (string username, int expiry_seconds) |
| Generates an access token for the given user with the given expiration time. | |
| static bool | invalidateToken (string token) |
| Invalidates the given token. | |
| static | refreshToken (string token, *int expiry_seconds) |
| Refreshes the given token. | |
| static | refreshToken (string token, timeout expiry_seconds) |
| Refreshes the given token. | |
| static *hash< TokenInfo > | getTokenInfo (string token, *bool refresh_token) |
| Returns information for the given token. | |
| static *hash< QorusUserInfo > | getCurrentUserInfo () |
| Returns information for the current user. | |
| static hash< QorusUserInfo > | getUserInfo (*string username) |
| Returns information for the given user. | |
| hash< auto > | bindSubworkflow (hash< auto > wf, hash< auto > order) |
| This method binds a workflow to a subworkflow step. | |
| hash< auto > | skipSubworkflow () |
| This method skips binding a workflow to a subworkflow step. | |
| submitAsyncKey (string key) | |
| Binds the given key to the asynchronous step. | |
| skipAsyncStep () | |
| This method will skip the execution of an asynchronous step. | |
| bindEvent (string eventkey) | |
| binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) | |
| 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 | |
| skipEvent () | |
| skips a workflow synchronization event step | |
| static | leaveParentFeedback (string key, auto value) |
| leaves feedback for a parent workflow | |
| static auto | getChildFeedback (string key) |
| gets feedback from a child workflow order with the given key | |
| static bool | isWorkflowContext () |
| Returns True if the code is executing in an immediate workflow context, False if not. | |
| static bool | isServiceContext () |
| Returns True if the code is executing in an immediate service context, False if not. | |
| static bool | isJobContext () |
| Returns True if the code is executing in an immediate job context, False if not. | |
| Public Attributes inherited from OMQ::UserApi::Service::ServiceApi | |
| const | ServiceCallContextKeys |
keys returned from the cx hash in getCallContext() if present | |
| 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.