Qorus Integration Engine®  4.0.3.p1_git
com.qoretechnologies.qorus.service.ServiceApi Class Reference

The main Qorus Java service API class. More...

Inheritance diagram for com.qoretechnologies.qorus.service.ServiceApi:
com.qoretechnologies.qorus.UserApi com.qoretechnologies.qorus.OMQ com.qoretechnologies.qorus.service.QorusService

Static Public Member Methods

static void checkAuthorization (String... args) throws Throwable
 checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More...
 
static void checkAuthorizationArgs (String[] args) throws Throwable
 checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized More...
 
static void checkAuthorizationOr (String... args) throws Throwable
 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 void checkAuthorizationOrArgs (String[] args) throws Throwable
 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 boolean testAuthorization (String... args) throws Throwable
 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 boolean testAuthorizationArgs (String[] args) throws Throwable
 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 boolean testAuthorizationOr (String... args) throws Throwable
 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 boolean testAuthorizationOrArgs (String[] args) throws Throwable
 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 void checkWorkflowAccess (int[] ids) throws Throwable
 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 void checkWorkflowAccess (int id) throws Throwable
 checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized More...
 
static boolean testWorkflowAccess (int[] ids) throws Throwable
 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 boolean testWorkflowAccess (int id) throws Throwable
 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 int [] getWorkflowAccessList () throws Throwable
 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 null is returned More...
 
static HashMap< String, ObjectgetWorkflowAccessHash () throws Throwable
 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 null is returned More...
 
static void checkWorkflowInstanceAccess (int wfiid) throws Throwable
 checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized More...
 
static void checkServiceAccess (int[] ids) throws Throwable
 checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized More...
 
static void checkServiceAccess (int id) throws Throwable
 checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized More...
 
static void checkQueueAccess (int queueid, String key) throws Throwable
 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 boolean testServiceAccess (int[] ids) throws Throwable
 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 boolean testServiceAccess (int id) throws Throwable
 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 int [] getServiceAccessList () throws Throwable
 returns a list of service IDs the current user has access to; or, if the current user has access to all services, then null is returned More...
 
static HashMap< String, ObjectgetServiceAccessHash () throws Throwable
 returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then null is returned More...
 
static void checkJobAccess (int[] ids) throws Throwable
 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 void checkJobAccess (int id) throws Throwable
 checks if the current user has access to the given single job ID; throws an exception if the user is not authorized More...
 
static boolean testJobAccess (int[] ids) throws Throwable
 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 boolean testJobAccess (int id) throws Throwable
 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 int [] getJobAccessList () throws Throwable
 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 null is returned More...
 
static HashMap< String, ObjectgetJobAccessHash () throws Throwable
 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 null is returned More...
 
static void checkJobInstanceAccess (int jiid) throws Throwable
 checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized More...
 
static void checkMapperAccess (int[] ids) throws Throwable
 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 void checkMapperAccess (int id) throws Throwable
 checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized More...
 
static boolean testMapperAccess (int[] ids) throws Throwable
 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 boolean testMapperAccess (int id) throws Throwable
 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 int [] getMapperAccessList () throws Throwable
 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 null is returned More...
 
static HashMap< String, ObjectgetMapperAccessHash () throws Throwable
 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 null is returned More...
 
static void checkVmapAccess (int[] ids) throws Throwable
 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 void checkVmapAccess (int id) throws Throwable
 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 boolean testVmapAccess (int[] ids) throws Throwable
 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 boolean testVmapAccess (int id) throws Throwable
 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 int [] getVmapAccessList () throws Throwable
 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 null is returned More...
 
static HashMap< String, ObjectgetVmapAccessHash () throws Throwable
 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 null is returned More...
 
static void registerSoapHandler (HashMap< String, Object > h) throws Throwable
 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 HashMap< String, ObjectgetHttpCallContext () throws Throwable
 returns a hash with HTTP call context information More...
 
static HashMap< String, ObjectgetLastEvents (int count) throws Throwable
 returns the last system events More...
 
static HashMap< String, ObjectgetLastEventsOr (int count, Object filter, Object and_not) throws Throwable
 gets the last system events that meet any of the filter criteria and none of the "and_not" criteria, if present More...
 
static HashMap< String, ObjectgetLastEventsOr (int count, Object filter) throws Throwable
 gets the last system events that meet any of the filter criteria and none of the "and_not" criteria, if present More...
 
static HashMap< String, ObjectgetLastEventsAnd (int count, Object filter, Object or_not) throws Throwable
 gets the last system events that meet all of the filter criteria or none of the "or_not" criteria, if present More...
 
static HashMap< String, ObjectgetLastEventsAnd (int count, Object filter) throws Throwable
 gets the last system events that meet all of the filter criteria or none of the "or_not" criteria, if present More...
 
static HashMap< String, ObjectwaitForEvents (int min_id, int timeout_ms) throws Throwable
 return available system events More...
 
static HashMap< String, ObjectwaitForEvents (int min_id) throws Throwable
 return available system events with no timeout; this method call returns immediately More...
 
static HashMap< String, ObjectwaitForEvents () throws Throwable
 return available system events More...
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter, int timeout_ms, Object and_not) throws Throwable
 return system events that meet any of the given criteria and none of the optional "and not" criteria More...
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter, int timeout_ms) throws Throwable
 return system events that meet any of the given criteria and none of the optional "and not" criteria More...
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter) throws Throwable
 return system events that meet any of the given criteria; this method returns immediately More...
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter, int timeout_ms, Object or_not) throws Throwable
 return system events that meet all of the given criteria or none of the optional "or not" criteria More...
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter, int timeout_ms) throws Throwable
 return system events that meet all of the given criteria or none of the optional "or not" criteria More...
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter) throws Throwable
 return system events that meet all of the given criteria More...
 
static HashMap< String, ObjectgetServiceInfo (HashMap< String, Object > cx) throws Throwable
 returns information about the current service More...
 
static HashMap< String, ObjectgetServiceInfo () throws Throwable
 returns information about the current service More...
 
static HashMap< String, ObjectgetCallContext () throws Throwable
 returns contextual information about the current call More...
 
static String getCallContextString (HashMap< String, Object > cx) throws Throwable
 returns a string describing the current call context More...
 
static String getCallContextString () throws Throwable
 returns a string describing the current call context More...
 
static Object callApiAsCurrentUser (String call, Object... args) throws Throwable
 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 Object callApiAsCurrentUserArgs (String call, Object[] args) throws Throwable
 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 HashMap< String, ObjectgetServiceInfoAsCurrentUser (String type, String name, HashMap< String, Object > cx) throws Throwable
 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 HashMap< String, ObjectgetServiceInfoAsCurrentUser (String type, String name) throws Throwable
 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 HashMap< String, ObjectgetServiceInfoAsCurrentUser (int id, HashMap< String, Object > cx) throws Throwable
 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 HashMap< String, ObjectgetServiceInfoAsCurrentUser (int id) throws Throwable
 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 HashMap< String, Object > [] getRunningWorkflowListAsCurrentUser (String name, String ver) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances if the current user can access them More...
 
static HashMap< String, Object > [] getRunningWorkflowListAsCurrentUser (String name) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances if the current user can access them More...
 
static HashMap< String, ObjectgetActiveJobsAsCurrentUser () throws Throwable
 Returns information on all active jobs visible to the given user. More...
 
static HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx, int code, HashMap< String, Object > hdr) throws Throwable
 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 HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx, int code) throws Throwable
 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 HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx) throws Throwable
 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 HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx, int code, HashMap< String, Object > hdr) throws Throwable
 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 null is returned. More...
 
static HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx, int code) throws Throwable
 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 null is returned. More...
 
static HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx) throws Throwable
 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 null is returned. More...
 
static HashMap< String, ObjectgetResourceHash () throws Throwable
 returns a hash of the service's file resources (hash keys are service file resource names) or null if the service has none More...
 
static String [] getResourceList () throws Throwable
 returns a list of the service's file resources or null if the service has none More...
 
static Object getResourceData (String name, HashMap< String, Object > ctx) throws Throwable
 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 Object getResourceData (String name) throws Throwable
 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 Object tryGetResourceData (String name, HashMap< String, Object > ctx) throws Throwable
 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 null is returned. More...
 
static Object tryGetResourceData (String name) throws Throwable
 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 null is returned. More...
 
static boolean hasResource (String name) throws Throwable
 returns true if the given service file resource exists, false if not More...
 
static HashMap< String, ObjectrenderTemplate (String name, HashMap< String, Object > ctx) throws Throwable
 explicitly renders a template file resource given the template argument hash More...
 
static HashMap< String, ObjecttryRenderTemplate (String name, HashMap< String, Object > ctx) throws Throwable
 render a template file resource and returns the rendered template if the template exists, otherwise returns null More...
 
static HashMap< String, ObjectgetTemplateHash () throws Throwable
 returns a hash of the service's template file resources (hash keys are service template resource names) or null if the service has none More...
 
static String [] getTemplateList () throws Throwable
 returns a list of the service's template file resources or null if the service has none More...
 
static boolean hasTemplate (String name) throws Throwable
 returns true if the given service template file resource exists, false if not More...
 
static HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password, String name, int family) throws Throwable
 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 HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password, String name) throws Throwable
 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 HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password) throws Throwable
 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 HashMap< String, Object > [] startListeners (String bind) throws Throwable
 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 void stopListener (String name) throws Throwable
 stops a single listener based on its name or bind address; does not return until all connections on the listener have closed More...
 
static void stopListenerId (int id) throws Throwable
 stops a single listener based on its listener ID; does not return until all connections on the listener have closed More...
 
static HashMap< String, ObjecttryGetWfStaticData () throws Throwable
 return the static data hash for the current workflow order if the service call was made from a workflow order, otherwise return null More...
 
static HashMap< String, ObjecttryGetWfDynamicData () throws Throwable
 return the dynamic data hash for the current workflow order if the service call was made from a workflow order, otherwise return null More...
 
static HashMap< String, ObjecttryGetWfTempData () throws Throwable
 return the temp data hash for the current workflow order if the service call was made from a workflow order, otherwise return null More...
 
static void saveStateData (HashMap< String, Object > data) throws Throwable
 serializes the given hash and stores against the service's state data in SERVICE_STATE_DATA More...
 
static void saveStateData () throws Throwable
 removes all service state data in SERVICE_STATE_DATA for the current service More...
 
static HashMap< String, ObjectgetStateData () throws Throwable
 returns any service state state data stored with saveStateData() More...
 
static void setOption (HashMap< String, Object > opts) throws Throwable
 Changes option values on a service. More...
 
static void setOption (String option, Object value) throws Throwable
 Changes a single option value on a service. More...
 
static HashMap< String, ObjectgetOption () throws Throwable
 Returns the value of all service options. More...
 
static HashMap< String, ObjectgetOption (String... args) throws Throwable
 Returns the value of the named service option or options. More...
 
static Object getOption (String key) throws Throwable
 Returns the value of the named service option. More...
 
static int sleep (int arg) throws Throwable
 puts the current thread to sleep for a certain number of seconds More...
 
static int usleep (int arg) throws Throwable
 puts the current thread to sleep for a certain number of microseconds More...
 
static int usleep (QoreRelativeTime arg) throws Throwable
 puts the current thread to sleep for a certain number of microseconds More...
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 returns the value of the given configuration item More...
 
static Object getConfigItemValue (String item) throws Throwable
 returns the value of the given configuration item More...
 
static HashMap< String, ObjectgetConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 returns a hash of all configuration items for the current service as a combination of local and global configuration items More...
 
static HashMap< String, ObjectgetConfigItemHash () throws Throwable
 returns a hash of all configuration items for the current service as a combination of local and global configuration items More...
 
- Static Public Member Methods inherited from com.qoretechnologies.qorus.UserApi
static Integer auditUserEvent (String user_event, String info1, String info2) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static Integer auditUserEvent (String user_event, String info1) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static Integer auditUserEvent (String user_event) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static boolean auditCheckEventString (String opt) throws Throwable
 checks if the given audit event (given as a string) is enabled More...
 
static boolean auditCheckEvent (int opt) throws Throwable
 checks if the given audit event (given as an integer code) is enabled More...
 
static int auditGetMask () throws Throwable
 returns the audit event mask More...
 
static int postUserEvent (String severity, Object info) throws Throwable
 posts an application event of class OMQ.QE_CLASS_USER More...
 
static HashMap< String, ObjectruntimeProperties () throws Throwable
 returns Qorus runtime properties as a hash More...
 
static Object callNetworkApi (String call, Object... args) throws Throwable
 calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callNetworkApiArgs (String call, Object[] args) throws Throwable
 calls a system RPC API with the argument list to the API method as a top-level argument to this function; the API is called with system permissions (no restrictions) More...
 
static Object callNetworkApiArgsWithAuthentication (String user, String pass, String call, Object[] args) throws Throwable
 calls a system RPC API with authentication information (username and password) More...
 
static Object callRestApi (String method, String path, HashMap< String, Object > body_args) throws Throwable
 calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callRestApi (String method, String path) throws Throwable
 calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callRestApiWithAuthentication (String user, String pass, String method, String path, HashMap< String, Object > body_args) throws Throwable
 calls a system REST API method with authentication information (username and password) and returns the result More...
 
static AbstractTable getSqlTable (String datasource, String table_name) throws Throwable
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More...
 
static AbstractTable getSqlTable (AbstractDatasource datasource, String table_name) throws Throwable
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More...
 
static HashMap< String, ObjectgetSqlCacheInfo () throws Throwable
 get information about cached object More...
 
static void clearSqlTableCache (String datasource, String table_name) throws Throwable
 clears the entry for the given datasource and table from the SQL cache (for example, if database objects have been updated in the dataserver) More...
 
static void clearSqlTableCache (String datasource) throws Throwable
 clears all objects for given datasource from the SQL cache (for example, if database objects have been updated in the dataserver) More...
 
static Object getValueMap (String mapname, String key) throws Throwable
 Gets a lookup value from the value map by a key; the value map must be registered to the current interface. More...
 
static HashMap< String, Object > [] getValueMaps () throws Throwable
 Gets all value maps valid for the current interface. More...
 
static boolean postSlaEventSuccess (String sla, float value) throws Throwable
 posts a successful SLA event for SLA monitoring and performance tracking More...
 
static boolean postSlaEventError (String sla, float value, String err, String desc) throws Throwable
 posts an unsuccessful SLA event for SLA monitoring and performance tracking More...
 
static void flushSlaEvents () throws Throwable
 flushes all pending SLA events to disk and returns after the data has been committed More...
 
static HashMap< String, ObjectgetSystemServiceInfo (String name) throws Throwable
 returns information about the given system service (if it's currently loaded) More...
 
static HashMap< String, ObjectgetServiceInfo (String type, String name) throws Throwable
 returns information about the given service (if it's currently loaded) More...
 
static HashMap< String, Object > [] getRunningWorkflowList (String name, String ver) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, Object > [] getRunningWorkflowList (String name) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, Object > [] getRunningWorkflowList () throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, ObjectgetRunningWorkflowInfo (int id) throws Throwable
 returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not More...
 
static int createOrder (String name, String version, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in the database with status READY More...
 
static int createOrder (String name, String version, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in the database More...
 
static int createOrder (String name, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in the database with status READY More...
 
static int createOrder (String name, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in the database More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 creates a workflow order data instance in a remote Qorus instance More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 creates a workflow order data instance in a remote Qorus instance More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, String version, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectgetQorusOptions () throws Throwable
 returns the value of all system options More...
 
static Object getQorusOptions (String opt) throws Throwable
 returns the value of the given system option More...
 
static HashMap< String, ObjectgetQorusOptions (String... opts) throws Throwable
 returns the value of the given system options More...
 
static HashMap< String, ObjectgetQorusOptionsArgs (String[] opts) throws Throwable
 returns the value of the given system options More...
 
static HashMap< String, ObjectgetQorusOptionInfo () throws Throwable
 returns a hash giving information about system options More...
 
static HashMap< String, ObjectgetQorusOptionInfoArgs (String[] args) throws Throwable
 returns a hash giving information about system options More...
 
static HashMap< String, ObjectgetActiveJobs () throws Throwable
 Returns information on all active jobs visible to the calling user. More...
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency, HashMap< String, Object > rtopts) throws Throwable
 Returns an object corresponding to a defined user connection. More...
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 Returns an object corresponding to a defined user connection. More...
 
static Object getUserConnection (String name, boolean connect) throws Throwable
 Returns an object corresponding to a defined user connection, establishing a dependency by default between the calling inteerface and the connection. More...
 
static Object getUserConnection (String name) throws Throwable
 Returns an object corresponding to a defined user connection, performing an automatic connection to the target and establishing a dependency by default between the calling inteerface and the connection. More...
 
static DatasourcePool getDatasourcePool (String name, boolean register_dependency) throws Throwable
 returns a DatasourcePool object for the given datasource name More...
 
static DatasourcePool getDatasourcePool (String name) throws Throwable
 returns a DatasourcePool object for the given datasource name; a dependency is created between the calling interface and the datasource More...
 
static HashMap< String, ObjectgetDatasourceInfo (String name) throws Throwable
 returns a hash of information for the given datasource, if known, otherwise throws an exception More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection; a dependency is established between the current interface and the remote connection. More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection; a dependency is established between the current interface and the remote connection and the connection is connected automatically. More...
 
static void raiseTransientAlert (String alert, String reason, HashMap< String, Object > info) throws Throwable
 raises a transient system alert from a workflow, service, or job More...
 
static void raiseTransientAlert (String alert, String reason) throws Throwable
 raises a transient system alert from a workflow, service, or job More...
 
static String qorusGetLocalUrl (String username, String password) throws Throwable
 returns a string giving the local system URL More...
 
static String qorusGetLocalUrl () throws Throwable
 returns a string giving the local system URL More...
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 Changes option values on a workflow, service, or job. More...
 
static void setOption (String option, Object value) throws Throwable
 Changes a single option value on a workflow, service, or job. More...
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 Returns the value of the named workflow, service, or job option or options. More...
 
static Object getOption (String key) throws Throwable
 Returns the value of the named workflow, service, or job option. More...
 
static HashMap< String, ObjectgetOption () throws Throwable
 Returns the value of all workflow, service, or job options depending on the calling context. More...
 
static HashMap< String, ObjectblockOrder (int wfiid) throws Throwable
 block the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata, HashMap< String, Object > orderkeys) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectcancelOrder (int wfiid) throws Throwable
 cancel the given workflow order data instance More...
 
static HashMap< String, ObjectuncancelOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 uncancels the given workflow order data instance More...
 
static HashMap< String, ObjectuncancelOrder (int wfiid) throws Throwable
 uncancels the given workflow order data instance More...
 
static HashMap< String, ObjectgetUserContextInfo () throws Throwable
 returns a hash for the current user context More...
 
static Object getGlobalConfigItemValue (String item) throws Throwable
 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 Mapper getMapper (String name, HashMap< String, Object > rtopts) throws Throwable
 returns the given mapper if registered for the current interface More...
 
static Mapper getMapper (String name) throws Throwable
 returns the given mapper if registered for the current interface More...
 
static boolean postSyncEvent (String eventtype, String eventkey) throws Throwable
 posts a workflow synchronization event given the event type name and the unique event key More...
 
static int getSessionId () throws Throwable
 returns the current Qorus application session ID More...
 
static HashMap< String, ObjectgetSystemInfo () throws Throwable
 returns a hash of system info More...
 
static HashMap< String, ObjectpropGet () throws Throwable
 returns a hash of all system properties in all domains More...
 
static HashMap< String, ObjectpropGet (String domain) throws Throwable
 returns a hash of all key-value pairs in the given domain or null if the system property domain does not exist More...
 
static HashMap< String, ObjectpropGet (String domain, String key) throws Throwable
 returns the value of the given system property key in the given domain or null if the system property does not exist More...
 
static String propUpdate (String domain, String key, Object value) throws Throwable
 changes (inserts, updates, or deletes) the value of a single system property More...
 
static void logFatal (String msg) throws Throwable
 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 void logError (String msg) throws Throwable
 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 void logWarn (String msg) throws Throwable
 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 void logInfo (String msg) throws Throwable
 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 void logDebug (String msg) throws Throwable
 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 void logTrace (String msg) throws Throwable
 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 void logFatal (String msg, Object... args) throws Throwable
 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 void logError (String msg, Object... args) throws Throwable
 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 void logWarn (String msg, Object... args) throws Throwable
 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 void logInfo (String msg, Object... args) throws Throwable
 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 void logDebug (String msg, Object... args) throws Throwable
 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 void logTrace (String msg, Object... args) throws Throwable
 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 getNextSequenceValue (AbstractDatasource ds, String name) throws Throwable
 returns the next sequence value for the given datasource and sequence More...
 
static int getNextSequenceValue (String ds, String name) throws Throwable
 returns the next sequence value for the given datasource and sequence More...
 
static String serializeQorusData (Object d) throws Throwable
 returns a string giving the default serialization of the given data structure for storage in Qorus More...
 
static String serializeQorusDataWithNothing (Object d) throws Throwable
 returns a string giving the default serialization of the given data structure for storage in Qorus More...
 
static Object deserializeQorusData (String data) throws Throwable
 parses a serialized data string and returns the corresponding data More...
 
static String restartTransaction (String driver, HashMap< String, Object > ex) throws Throwable
 returns a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING More...
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context) throws Throwable
 expands one variable in a templated string More...
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context) throws Throwable
 expands all variables in a templated string More...
 
static HashMap< String, ObjectbbParseExactlyOneVariable (String str) throws Throwable
 parses one template variable and returns a hash with its parts More...
 
static HashMap< String, ObjectgetInputData (String field_name, HashMap< String, Object > local_context, HashMap< String, Object > input_data_cfg) throws Throwable
 returns specified input data field's value More...
 
static HashMap< String, ObjectgetInputData (HashMap< String, Object > input_data_cfg, HashMap< String, Object > local_context) throws Throwable
 returns all input data More...
 
static void updateOutputData (String field_name, Object output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 updates output data with the given configuration More...
 
static void updateOutputData (HashMap< String, Object > all_output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 updates all output data More...
 
static String getTextFileFromLocation (String location) throws Throwable
 returns string data for the given file location More...
 
static byte [] getBinaryFileFromLocation (String location) throws Throwable
 returns binary data for the given file location More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.qoretechnologies.qorus.OMQ
static final String OT_CONSTANT = "CONSTANT"
 for constant library objects
 
static final String OT_CLASS = "CLASS"
 for class library objects
 
static final String OT_FUNCTION = "FUNCTION"
 for function library objects
 
static final String ExecNormal = "NORMAL"
 step attribute: for normal steps
 
static final String ExecAsync = "ASYNC"
 step attribute: for async steps
 
static final String ExecSubWorkflow = "SUBWORKFLOW"
 step attribute: for subworkflow steps
 
static final String ExecEvent = "EVENT"
 step attribute: for synchronization event steps
 
static final String SSRunning = "running"
 service status: running
 
static final String SSLoaded = "loaded"
 service status: running
 
static final String SLNone = "none"
 service lock type: none
 
static final String SLRead = "read"
 service lock type: read
 
static final String SLWrite = "write"
 service lock type: write
 
static final String SQLStatComplete = "C"
 SQL Status: COMPLETE. More...
 
static final String SQLStatError = "E"
 SQL Status: ERROR. More...
 
static final String SQLStatWaiting = "W"
 SQL Status: WAITING. More...
 
static final String SQLStatInProgress = "I"
 SQL Status: IN-PROGRESS. More...
 
static final String SQLStatIncomplete = "N"
 SQL Status: INCOMPLETE. More...
 
static final String SQLStatAsyncWaiting = "A"
 SQL Status: ASYNC-WAITING. More...
 
static final String SQLStatEventWaiting = "V"
 SQL Status: EVENT-WAITING. More...
 
static final String SQLStatRetry = "R"
 SQL Status: RETRY. More...
 
static final String SQLStatCanceled = "X"
 SQL Status: CANCELED. More...
 
static final String SQLStatReady = "Y"
 SQL Status: READY. More...
 
static final String SQLStatScheduled = "S"
 SQL Status: SCHEDULED. More...
 
static final String SQLStatBlocked = "B"
 SQL Status: BLOCKED. More...
 
static final int LL_CRITICAL = -1
 Log Level: CRITICAL.
 
static final int LL_IMPORTANT = 0
 Log Level: IMPORTANT.
 
static final int LL_INFO = 1
 Log Level: INFO.
 
static final int LL_DETAIL_1 = 2
 Log Level: DETAIL_1.
 
static final int LL_DETAIL_2 = 3
 Log Level: DETAIL_2.
 
static final int LL_DEBUG_1 = 4
 Log Level: DEBUG_1.
 
static final int LL_DEBUG_2 = 5
 Log Level: DEBUG_2.
 
static final int LL_DEBUG_3 = 6
 Log Level: DEBUG_3.
 
static final String WM_Normal = "NORMAL"
 Workflow Mode: NORMAL.
 
static final String WM_Recovery = "RECOVERY"
 Workflow Mode: RECOVERY.
 
static final String StatComplete = "COMPLETE"
 This status indicates that the object it is attached to has successfully completed its processing. More...
 
static final String StatError = "ERROR"
 Indicates that the workflow order data instance has at least one step with an OMQ.StatError status. More...
 
static final String StatWaiting = "WAITING"
 Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ.StatComplete. More...
 
static final String StatInProgress = "IN-PROGRESS"
 Indicates that the workflow order data instance is currently being processed. More...
 
static final String StatIncomplete = "INCOMPLETE"
 Indicates that processing for the workflow order data instance is not yet complete yet has no errors. More...
 
static final String StatAsyncWaiting = "ASYNC-WAITING"
 Indicates that asynchronous steps are in process and the system is waiting on data to become available in the queue assigned to the step. More...
 
static final String StatEventWaiting = "EVENT-WAITING"
 Indicates that one or more workflow event synchronization steps are in progress and the workflow is waiting for the event(s) to be posted. More...
 
static final String StatRetry = "RETRY"
 Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry. More...
 
static final String StatCanceled = "CANCELED"
 Indicates that workflow order data instance processing has been canceled. More...
 
static final String StatReady = "READY"
 Indicates that a workflow order data instance has been created and is waiting for processing to start. More...
 
static final String StatScheduled = "SCHEDULED"
 Indicates that a workflow order data instance has been created and has not yet been processed because at the time the order was created, the scheduled date (the earliest possible processing date) was in the future. More...
 
static final String StatBlocked = "BLOCKED"
 Indicates that workflow order data instance processing has been temporarily blocked. More...
 
static final Map< String, StringStatMap
 map from text descriptions to SQL status characters
 
static final Map< String, StringSQLStatMap
 hash mapping SQL status characters to text descriptions
 
static final String ES_Major = "MAJOR"
 Error Severity: MAJOR.
 
static final String ES_Warning = "WARNING"
 Error Severity: WARNING.
 
static final String CS_Clean = "C"
 order went to COMPLETE without any errors
 
static final String CS_RecoveredAuto = "A"
 order went to COMPLETE after being recovered automatically
 
static final String CS_RecoveredManual = "M"
 order went to COMPLETE after being recovered with manual retries
 
static final String QS_Waiting = "WAITING"
 Queue Status Text Description: WAITING. More...
 
static final String QS_Received = "RECEIVED"
 Queue Status Text Description: RECEIVED. More...
 
static final String QS_Error = "ERROR"
 Queue Status Text Description: ERROR. More...
 
static final String QS_Used = "USED"
 Queue Status Text Description: USED. More...
 
static final String SQL_QS_Waiting = "W"
 Queue Status SQL Character Code: WAITING. More...
 
static final String SQL_QS_Received = "R"
 Queue Status SQL Character Code: RECEIVED. More...
 
static final String SQL_QS_Error = "E"
 Queue Status SQL Character Code: ERROR. More...
 
static final String SQL_QS_Used = "X"
 Queue Status SQL Character Code: USED. More...
 
static final Map< String, StringQSMap
 map of queue status descriptions to the character code
 
static final Map< String, StringSQLQSMap
 map of queue status character codes to the description
 
static final String QR_LOGIN = "LOGIN"
 RBAC System Permission: "LOGIN". More...
 
static final String QR_SHUTDOWN = "SHUTDOWN"
 RBAC System Permission: "SHUTDOWN". More...
 
static final String QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
 RBAC System Permission: "WORKFLOW-CONTROL". More...
 
static final String QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
 RBAC System Permission: "WORKFLOW-EXEC-CONTROL". More...
 
static final String QR_START_WORKFLOW = "START-WORKFLOW"
 RBAC System Permission: "START-WORKFLOW". More...
 
static final String QR_STOP_WORKFLOW = "STOP-WORKFLOW"
 RBAC System Permission: "STOP-WORKFLOW". More...
 
static final String QR_RESET_WORKFLOW = "RESET-WORKFLOW"
 RBAC System Permission: "RESET-WORKFLOW". More...
 
static final String QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
 RBAC System Permission: "WORKFLOW-OPTION-CONTROL". More...
 
static final String QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
 RBAC System Permission: "WORKFLOW-ERROR-CONTROL". More...
 
static final String QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
 RBAC System Permission: "WORKFLOW-ORDER-CONTROL". More...
 
static final String QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
 RBAC System Permission: "RETRY-WORKFLOW-ORDER". More...
 
static final String QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
 RBAC System Permission: "RESCHEDULE-WORKFLOW-ORDER". More...
 
static final String QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
 RBAC System Permission: "REPRIORITIZE-WORKFLOW-ORDER". More...
 
static final String QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
 RBAC System Permission: "BLOCK-WORKFLOW-ORDER". More...
 
static final String QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
 RBAC System Permission: "CANCEL-WORKFLOW-ORDER". More...
 
static final String QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
 RBAC System Permission: "SET-WORKFLOW-ORDER-ERROR". More...
 
static final String QR_SKIP_STEP = "SKIP-STEP"
 RBAC System Permission: "SKIP-STEP". More...
 
static final String QR_SET_ORDER_INFO = "SET-ORDER-INFO"
 RBAC System Permission: "SET-ORDER-INFO". More...
 
static final String QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
 RBAC System Permission: "POST-WORKFLOW-EVENT". More...
 
static final String QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
 RBAC System Permission: "LOCK-WORKFLOW-ORDER". More...
 
static final String QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
 RBAC System Permission: "BREAK-WORKFLOW-ORDER-LOCK". More...
 
static final String QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
 RBAC System Permission: "EDIT-WORKFLOW-DATA". More...
 
static final String QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 RBAC System Permission: "READ-SENSITIVE-DATA";. More...
 
static final String QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 RBAC System Permission: "EDIT-SENSITIVE-DATA";. More...
 
static final String QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 RBAC System Permission: "DELETE-SENSITIVE-DATA";. More...
 
static final String QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 RBAC System Permission: "SENSITIVE-DATA-CONTROL";. More...
 
static final String QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
 RBAC System Permission: "EXEC-SYNC-WORKFLOW". More...
 
static final String QR_SUBMIT_ORDER = "SUBMIT-ORDER"
 RBAC System Permission: "SUBMIT-ORDER". More...
 
static final String QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 RBAC System Permissions: "SET-STEP-CONFIG". More...
 
static final String QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 RBAC System Permissions: "SET-WORKFLOW-CONFIG". More...
 
static final String QR_SERVICE_CONTROL = "SERVICE-CONTROL"
 RBAC System Permission: "SERVICE-CONTROL". More...
 
static final String QR_LOAD_SERVICE = "LOAD-SERVICE"
 RBAC System Permission: "LOAD-SERVICE". More...
 
static final String QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
 RBAC System Permission: "UNLOAD-SERVICE". More...
 
static final String QR_RESET_SERVICE = "RESET-SERVICE"
 RBAC System Permission: "RESET-SERVICE". More...
 
static final String QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
 RBAC System Permission: "SET-SERVICE-AUTOSTART". More...
 
static final String QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
 RBAC System Permission: "SET-SERVICE-OPTIONS". More...
 
static final String QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
 RBAC System Permission: "CALL-USER-SERVICES-RO". More...
 
static final String QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RO". More...
 
static final String QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
 RBAC System Permission: "CALL-USER-SERVICES-RW". More...
 
static final String QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RW". More...
 
static final String QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 RBAC System Permissions: "SET-SERVICE-CONFIG". More...
 
static final String QR_USER_CONTROL = "USER-CONTROL"
 RBAC System Permission: "USER-CONTROL". More...
 
static final String QR_RELOAD_RBAC = "RELOAD-RBAC"
 RBAC System Permission: "RELOAD-RBAC". More...
 
static final String QR_ADD_USER = "ADD-USER"
 RBAC System Permission: "ADD-USER". More...
 
static final String QR_MODIFY_USER = "MODIFY-USER"
 RBAC System Permission: "MODIFY-USER". More...
 
static final String QR_DELETE_USER = "DELETE-USER"
 RBAC System Permission: "DELETE-USER". More...
 
static final String QR_ADD_PERMISSION = "ADD-PERMISSION"
 RBAC System Permission: "ADD-PERMISSION". More...
 
static final String QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
 RBAC System Permission: "MODIFY-PERMISSION". More...
 
static final String QR_DELETE_PERMISSION = "DELETE-PERMISSION"
 RBAC System Permission: "DELETE-PERMISSION". More...
 
static final String QR_ADD_ROLE = "ADD-ROLE"
 RBAC System Permission: "ADD-ROLE". More...
 
static final String QR_MODIFY_ROLE = "MODIFY-ROLE"
 RBAC System Permission: "MODIFY-ROLE". More...
 
static final String QR_DELETE_ROLE = "DELETE-ROLE"
 RBAC System Permission: "DELETE-ROLE". More...
 
static final String QR_OPTION_CONTROL = "OPTION-CONTROL"
 RBAC System Permission: "OPTION-CONTROL". More...
 
static final String QR_LOGGER_CONTROL = "LOGGER-CONTROL"
 RBAC System Permission: "LOGGER-CONTROL". More...
 
static final String QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 RBAC System Permission: "ROTATE-LOG-FILES". More...
 
static final String QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 RBAC System Permission: "MODIFY-LOGGER". More...
 
static final String QR_DELETE_LOGGER = "DELETE-LOGGER"
 RBAC System Permission: "DELETE-LOGGER". More...
 
static final String QR_CREATE_LOGGER = "CREATE-LOGGER"
 RBAC System Permission: "CREATE-LOGGER". More...
 
static final String QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
 RBAC System Permission: "DATASOURCE-CONTROL". More...
 
static final String QR_READ_DATASOURCE = "READ-DATASOURCE"
 RBAC System Permission: "READ-DATASOURCE". More...
 
static final String QR_ADD_DATASOURCE = "ADD-DATASOURCE"
 RBAC System Permission: "ADD-DATASOURCE". More...
 
static final String QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
 RBAC System Permission: "SELECT-DATASOURCE". More...
 
static final String QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
 RBAC System Permission: "MODIFY-DATASOURCE". More...
 
static final String QR_RESET_DATASOURCE = "RESET-DATASOURCE"
 RBAC System Permission: "RESET-DATASOURCE". More...
 
static final String QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
 RBAC System Permission: "DELETE-DATASOURCE". More...
 
static final String QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
 RBAC System Permission: "RELOAD-DATASOURCE". More...
 
static final String QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
 RBAC System Permission: "FLUSH-DATASOURCE". More...
 
static final String QR_SQLUTIL_READ = "SQLUTIL-READ"
 RBAC System Permission: "SQLUTIL-READ". More...
 
static final String QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
 RBAC System Permission: "SQLUTIL-WRITE". More...
 
static final String QR_GROUP_CONTROL = "GROUP-CONTROL"
 RBAC System Permission: "GROUP-CONTROL". More...
 
static final String QR_ADD_GROUP = "ADD-GROUP"
 RBAC System Permission: "ADD-GROUP". More...
 
static final String QR_MODIFY_GROUP = "MODIFY-GROUP"
 RBAC System Permission: "MODIFY-GROUP". More...
 
static final String QR_DELETE_GROUP = "DELETE-GROUP"
 RBAC System Permission: "DELETE-GROUP". More...
 
static final String QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
 RBAC System Permission: "MODIFY-GROUP-STATUS". More...
 
static final String QR_SERVER_CONTROL = "SERVER-CONTROL"
 RBAC System Permission: "SERVER-CONTROL". More...
 
static final String QR_SET_PROPERTY = "SET-PROPERTY"
 RBAC System Permission: "SET-PROPERTY". More...
 
static final String QR_DELETE_PROPERTY = "DELETE-PROPERTY"
 RBAC System Permission: "DELETE-PROPERTY". More...
 
static final String QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
 RBAC System Permission: "RELOAD-PROPERTIES". More...
 
static final String QR_START_LISTENER = "START-LISTENER"
 RBAC System Permission: "START-LISTENER". More...
 
static final String QR_STOP_LISTENER = "STOP-LISTENER"
 RBAC System Permission: "STOP-LISTENER". More...
 
static final String QR_JOB_CONTROL = "JOB-CONTROL"
 RBAC System Permission: "JOB-CONTROL". More...
 
static final String QR_RUN_JOB = "RUN-JOB"
 RBAC System Permission: "RUN-JOB". More...
 
static final String QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
 RBAC System Permission: "MODIFY-JOB-STATUS". More...
 
static final String QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
 RBAC System Permission: "MODIFY-JOB-EXPIRY". More...
 
static final String QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
 RBAC System Permission: "RESCHEDULE-JOB". More...
 
static final String QR_RESET_JOB = "RESET-JOB"
 RBAC System Permission: "RESET-JOB". More...
 
static final String QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
 RBAC System Permission: "SET-JOB-OPTIONS". More...
 
static final String QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 RBAC System Permissions: "SET-JOB-CONFIG". More...
 
static final String QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
 RBAC System Permission: "SCHEMA-CONTROL". More...
 
static final String QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
 RBAC System Permission: "USER-CONNECTION-CONTROL". More...
 
static final String QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
 RBAC System Permission: "READ-USER-CONNECTION". More...
 
static final String QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
 RBAC System Permission: "RELOAD-USER-CONNECTION". More...
 
static final String QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
 RBAC System Permission: "ADD-USER-CONNECTION". More...
 
static final String QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
 RBAC System Permission: "MODIFY-USER-CONNECTION". More...
 
static final String QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
 RBAC System Permission: "DELETE-USER-CONNECTION". More...
 
static final String QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
 RBAC System Permission: "SERVER-CONNECTION-CONTROL". More...
 
static final String QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
 RBAC System Permission: "RELOAD-SERVER-CONNECTION". More...
 
static final String QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
 RBAC System Permission: "READ-SERVER-CONNECTION". More...
 
static final String QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 RBAC System Permission: "ADD-SERVER-CONNECTION". More...
 
static final String QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 RBAC System Permission: "MODIFY-SERVER-CONNECTION". More...
 
static final String QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 RBAC System Permission: "DELETE-SERVER-CONNECTION". More...
 
static final String QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
 RBAC System Permission: "FILESYSTEM-CONTROL". More...
 
static final String QR_FILESYSTEM_READ = "FILESYSTEM-READ"
 RBAC System Permission: "FILESYSTEM-READ". More...
 
static final String QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
 RBAC System Permission: "FILESYSTEM-WRITE". More...
 
static final String QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 RBAC System Permission: "MAPPER-CONTROL". More...
 
static final String QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 RBAC System Permission: "RELOAD-MAPPER". More...
 
static final String QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 RBAC System Permission: "MODIFY-MAPPER". More...
 
static final String QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 RBAC System Permission: "VALUE-MAP-CONTROL". More...
 
static final String QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 RBAC System Permission: "RELOAD-VALUE-MAP". More...
 
static final String QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 RBAC System Permission: "MODIFY-VALUE-MAP". More...
 
static final String QR_CREATE_SLA = "CREATE-SLA"
 RBAC System Permission: "CREATE-SLA". More...
 
static final String QR_DELETE_SLA = "DELETE-SLA"
 RBAC System Permission: "DELETE-SLA". More...
 
static final String QR_MODIFY_SLA = "MODIFY-SLA"
 RBAC System Permission: "MODIFY-SLA". More...
 
static final String QR_SLA_CONTROL = "SLA-CONTROL"
 RBAC System Permission: "SLA-CONTROL". More...
 
static final String QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 RBAC System Permission: "DEBUG-CONTROL". More...
 
static final int QE_CLASS_SYSTEM = 101
 Event Class Code for SYSTEM Events.
 
static final int QE_CLASS_WORKFLOW = 102
 Event Class Code for WORKFLOW Events.
 
static final int QE_CLASS_SERVICE = 103
 Event Class Code for SERVICE Events.
 
static final int QE_CLASS_USER = 104
 Event Class Code for USER Events.
 
static final int QE_CLASS_JOB = 105
 Event Class Code for JOB Events.
 
static final int QE_CLASS_ALERT = 106
 Event Class Code for ALERT Events.
 
static final int QE_CLASS_GROUP = 107
 Event Class Code for GROUP Events.
 
static final int QE_CLASS_CONNECTION = 108
 Event Class Code for CONNECTION events.
 
static final int QE_CLASS_PROCESS = 109
 Event Class Code for PROCESS events. More...
 
static final int QE_CLASS_CLUSTER = 110
 Event Class Code for CLUSTER events. More...
 
static final int QE_CLASS_LOGGER = 111
 Event Class Code for LOGGER events. More...
 
static final int QE_CLASS_CONFIG_ITEM = 112
 Event Class Code for CONFIG ITEM events. More...
 
static final Map< Integer, StringQE_MAP_CLASS
 hash mapping event class codes to descriptive strings
 
static final int QEC_SYSTEM_STARTUP = 1001
 Qorus Event Code: SYSTEM_STARTUP. More...
 
static final int QEC_SYSTEM_SHUTDOWN = 1002
 Qorus Event Code: SYSTEM_SHUTDOWN. More...
 
static final int QEC_SYSTEM_ERROR = 1003
 Qorus Event Code: SYSTEM_ERROR. More...
 
static final int QEC_SYSTEM_HEALTH_CHANGED = 1004
 Qorus Event Code: SYSTEM_HEALTH_CHANGED. More...
 
static final int QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED. More...
 
static final int QEC_GROUP_STATUS_CHANGED = 1101
 Qorus Event Code: GROUP_STATUS_CHANGED. More...
 
static final int QEC_WORKFLOW_START = 2001
 Qorus Event Code: WORKFLOW_START. More...
 
static final int QEC_WORKFLOW_STOP = 2002
 Qorus Event Code: WORKFLOW_STOP. More...
 
static final int QEC_WORKFLOW_CACHE_RESET = 2003
 Qorus Event Code: WORKFLOW_CACHE_RESET. More...
 
static final int QEC_WORKFLOW_DATA_SUBMITTED = 2004
 Qorus Event Code: WORKFLOW_DATA_SUBMITTED. More...
 
static final int QEC_WORKFLOW_DATA_ERROR = 2005
 Qorus Event Code: WORKFLOW_DATA_ERROR. More...
 
static final int QEC_WORKFLOW_DATA_RELEASED = 2006
 Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event) More...
 
static final int QEC_WORKFLOW_DATA_CACHED = 2007
 Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event) More...
 
static final int QEC_WORKFLOW_INFO_CHANGED = 2008
 Qorus Event Code: WORKFLOW_INFO_CHANGED. More...
 
static final int QEC_WORKFLOW_STATUS_CHANGED = 2009
 Qorus Event Code: WORKFLOW_STATUS_CHANGED. More...
 
static final int QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE. More...
 
static final int QEC_WORKFLOW_PERFORMANCE = 2011
 Qorus Event Code:: WORKFLOW_PERFORMANCE. More...
 
static final int QEC_WORKFLOW_DATA_LOCKED = 2012
 Qorus Event Code: WORKFLOW_DATA_LOCKED. More...
 
static final int QEC_WORKFLOW_DATA_UNLOCKED = 2013
 Qorus Event Code: WORKFLOW_DATA_UNLOCKED. More...
 
static final int QEC_WORKFLOW_DATA_UPDATED = 2014
 Qorus Event Code: WORKFLOW_DATA_UPDATED (static or dynamic data changed) More...
 
static final int QEC_WORKFLOW_STATS_UPDATED = 2015
 Qorus Event Code: WORKFLOW_STATS_UPDATED. More...
 
static final int QEC_WORKFLOW_RECOVERED = 2016
 Qorus Event Code: WORKFLOW_RECOVERED. More...
 
static final int QEC_WORKFLOW_UPDATED = 2017
 Qorus Event code: WORKFLOW_UPDATED. More...
 
static final int QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 Qorus Event Code: WORKFLOW_STEP_DATA_UPDATED (step dynamic data changed) More...
 
static final int QEC_SERVICE_START = 3001
 Qorus Event Code: SERVICE_START. More...
 
static final int QEC_SERVICE_STOP = 3002
 Qorus Event Code: SERVICE_STOP. More...
 
static final int QEC_SERVICE_ERROR = 3003
 Qorus Event Code: SERVICE_ERROR. More...
 
static final int QEC_SERVICE_AUTOSTART_CHANGE = 3004
 Qorus Event Code: SERVICE_AUTOSTART_CHANGE. More...
 
static final int QEC_SERVICE_METHOD_PERFORMANCE = 3005
 Qorus Event Code:: SERVICE_METHOD_PERFORMANCE. More...
 
static final int QEC_SERVICE_UPDATED = 3006
 Qorus Event code: SERVICE_UPDATED. More...
 
static final int QEC_JOB_START = 4001
 Qorus Event Code: JOB_START. More...
 
static final int QEC_JOB_STOP = 4002
 Qorus Event Code: JOB_STOP. More...
 
static final int QEC_JOB_ERROR = 4003
 Qorus Event Code: JOB_ERROR. More...
 
static final int QEC_JOB_INSTANCE_START = 4004
 Qorus Event Code: JOB_INSTANCE_START. More...
 
static final int QEC_JOB_INSTANCE_STOP = 4005
 Qorus Event Code: JOB_INSTANCE_STOP. More...
 
static final int QEC_JOB_RECOVERED = 4006
 Qorus Event Code: JOB_RECOVERED. More...
 
static final int QEC_JOB_UPDATED = 4007
 Qorus Event code: JOB_UPDATED. More...
 
static final int QEC_CONFIG_ITEM_CHANGED = 4100
 Qorus Event code: CONFIG_ITEM_CHANGED. More...
 
static final int QEC_ALERT_ONGOING_RAISED = 5006
 Qorus Event Code: ALERT_ONGOING_RAISED. More...
 
static final int QEC_ALERT_ONGOING_CLEARED = 5007
 Qorus Event Code: ALERT_ONGOING_CLEARED. More...
 
static final int QEC_ALERT_TRANSIENT_RAISED = 5008
 Qorus Event Code: ALERT_TRANSIENT_RAISED. More...
 
static final int QEC_CONNECTION_UP = 5101
 Qorus Event Code: CONNECTION_UP. More...
 
static final int QEC_CONNECTION_DOWN = 5102
 Qorus Event Code: CONNECTION_DOWN. More...
 
static final int QEC_CONNECTION_ENABLED_CHANGE = 5103
 Qorus Event Code: CONNECTION_ENABLED_CHANGE. More...
 
static final int QEC_CONNECTION_CREATED = 5104
 Qorus Event Code: CONNECTION_CREATED. More...
 
static final int QEC_CONNECTION_UPDATED = 5105
 Qorus Event Code: CONNECTION_UPDATED. More...
 
static final int QEC_CONNECTION_DELETED = 5106
 Qorus Event Code: CONNECTION_DELETED. More...
 
static final int QEC_CONNECTIONS_RELOADED = 5107
 Qorus Event Code: CONNECTIONS_RELOADED. More...
 
static final int QEC_LOGGER_CREATED = 5108
 Qorus Event Code: LOGGER_CREATED. More...
 
static final int QEC_LOGGER_UPDATED = 5109
 Qorus Event Code: LOGGER_UPDATED. More...
 
static final int QEC_LOGGER_DELETED = 5110
 Qorus Event Code: LOGGER_DELETED. More...
 
static final int QEC_APPENDER_CREATED = 5111
 Qorus Event Code: APPENDER_CREATED. More...
 
static final int QEC_APPENDER_DELETED = 5112
 Qorus Event Code: APPENDER_DELETED. More...
 
static final int QEC_APPENDER_UPDATED = 5113
 Qorus Event Code: APPENDER_UPDATED. More...
 
static final int QEC_PROCESS_STARTED = 6001
 Qorus Event Code: PROCESS_STARTED. More...
 
static final int QEC_PROCESS_STOPPED = 6002
 Qorus Event Code: PROCESS_STOPPED. More...
 
static final int QEC_PROCESS_START_ERROR = 6003
 Qorus Event Code: PROCESS_START_ERROR. More...
 
static final int QEC_PROCESS_MEMORY_CHANGED = 6004
 Qorus Event Code: PROCESS_MEMORY_CHANGED. More...
 
static final int QEC_NODE_INFO = 7001
 Qorus Event Code: NODE_INFO. More...
 
static final int QEC_USER_EVENT = 9001
 Qorus Event Code: USER_EVENT. More...
 
static final Map< Integer, StringQE_MAP_EVENT
 hash mapping event codes to descriptive strings
 
static final int QSE_OK = 0
 Qorus Startup Error Code: no error.
 
static final int QSE_NO_INSTANCE_KEY = 1
 Qorus Startup Error Code: no instance key set.
 
static final int QSE_INVALID_DB_MAX_THREADS = 2
 Qorus Startup Error Code: invalid db-max-threads option.
 
static final int QSE_DATASOURCE = 3
 Qorus Startup Error Code: can't open system datasources.
 
static final int QSE_LOG_ERROR = 4
 Qorus Startup Error Code: error opening system log files.
 
static final int QSE_RBAC_ERROR = 5
 Qorus Startup Error Code: error initializing RBAC framework.
 
static final int QSE_EVENT_ERROR = 6
 Qorus Startup Error Code: error initializing event framework.
 
static final int QSE_SESSION_ERROR = 7
 Qorus Startup Error Code: error opening or recovering application session.
 
static final int QSE_COMMAND_LINE_ERROR = 8
 Qorus Startup Error Code: error in command-line options.
 
static final int QSE_OPTION_ERROR = 9
 Qorus Startup Error Code: error setting options on startup.
 
static final int QSE_VERSION_ONLY = 10
 Qorus Startup Error Code: command-line option requested version display and exit.
 
static final int QSE_STARTUP_ERROR = 99
 Qorus Startup Error Code: other error starting server.
 
static final int DefaultOrderPriority = 500
 default order priority
 
static final String JS_Complete = "COMPLETE"
 Job Status Text Description: COMPLETE. More...
 
static final String JS_InProgress = "IN-PROGRESS"
 Job Status Text Description: IN-PROGRESS. More...
 
static final String JS_Error = "ERROR"
 Job Status Text Description: ERROR. More...
 
static final String JS_Crash = "CRASH"
 Job Status Text Description: CRASH. More...
 
static final String SQL_JS_Complete = "C"
 Job Status SQL Character Code: COMPLETE. More...
 
static final String SQL_JS_InProgress = "I"
 Job Status SQL Character Code: IN-PROGRESS. More...
 
static final String SQL_JS_Error = "E"
 Job Status SQL Character Code: ERROR. More...
 
static final String SQL_JS_Crash = "Z"
 Job Status SQL Character Code: CRASH. More...
 
static final Map< String, StringJSMap
 map of Job status descriptions to the character code
 
static final Map< String, StringSQLJSMap
 map of Job status character codes to the description
 
static final int AE_USER_EVENT = 1
 user event audit code More...
 
static final int AE_SYSTEM_STARTUP = 2
 system startup audit code More...
 
static final int AE_SYSTEM_SHUTDOWN = 3
 system shutdown audit code More...
 
static final int AE_SYSTEM_RECOVERY_START = 4
 system recovery start audit code More...
 
static final int AE_SYSTEM_RECOVERY_COMPLETE = 5
 system recovery complete audit code More...
 
static final int AE_WORKFLOW_STATUS_CHANGE = 6
 workflow status change audit code More...
 
static final int AE_WORKFLOW_START = 7
 workflow start audit code More...
 
static final int AE_WORKFLOW_STOP = 8
 workflow stop audit code More...
 
static final int AE_SERVICE_START = 9
 service start audit code More...
 
static final int AE_SERVICE_STOP = 10
 service stop audit code More...
 
static final int AE_JOB_START = 11
 job start audit code More...
 
static final int AE_JOB_STOP = 12
 job stop audit code More...
 
static final int AE_JOB_INSTANCE_START = 13
 job instance start audit code More...
 
static final int AE_JOB_INSTANCE_STOP = 14
 job instance stop audit code More...
 
static final int AE_API_CALL = 15
 api call audit code More...
 
static final int AE_JOB_RECOVERY = 16
 job recovery audit code More...
 
static final int AE_WORKFLOW_DATA_CREATED = 17
 workflow order data created audit code More...
 
static final int AE_ALERT_ONGOING_RAISED = 18
 ongoing alert raised audit code More...
 
static final int AE_ALERT_ONGOING_CLEARED = 19
 ongoing alert cleared audit code More...
 
static final int AE_ALERT_TRANSIENT_RAISED = 20
 transient alert raised audit code More...
 
static final int AE_SOURCE_FILE_LOADED = 21
 source file loaded into the system schema by oload More...
 
static final int AE_GROUP_STATUS_CHANGED = 22
 group status changed audit code More...
 
static final String AES_USER_EVENT = "USER-EVENT"
 user event audit code More...
 
static final String AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
 system startup audit code More...
 
static final String AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
 system shutdown audit code More...
 
static final String AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
 system recovery start audit code More...
 
static final String AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
 system recovery complete audit code More...
 
static final String AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
 workflow status change audit code More...
 
static final String AES_WORKFLOW_START = "WORKFLOW-START"
 workflow start audit code More...
 
static final String AES_WORKFLOW_STOP = "WORKFLOW-STOP"
 workflow stop audit code More...
 
static final String AES_SERVICE_START = "SERVICE-START"
 service start audit code More...
 
static final String AES_SERVICE_STOP = "SERVICE-STOP"
 service stop audit code More...
 
static final String AES_JOB_START = "JOB-START"
 job start audit code More...
 
static final String AES_JOB_STOP = "JOB-STOP"
 job stop audit code More...
 
static final String AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
 job instance start audit code More...
 
static final String AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
 job instance stop audit code More...
 
static final String AES_API_CALL = "API-CALL"
 api call audit code More...
 
static final String AES_JOB_RECOVERY = "JOB-RECOVERY"
 job recovery audit code More...
 
static final String AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
 workflow order data created audit code More...
 
static final String AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
 ongoing alert raised audit code More...
 
static final String AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
 ongoing alert cleared audit code More...
 
static final String AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
 transient alert raised audit code More...
 
static final String AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
 source file loaded into the system schema by oload audit code More...
 
static final String AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
 group status changed audit code More...
 
static final Map< Integer, StringAuditEventMap
 map of audit event codes to descriptions
 
static final Map< String, Integer > AuditEventCodeMap
 map of audit event descriptions to codes
 
static final String AO_SYSTEM = "system"
 Audit option: system events. More...
 
static final String AO_WORKFLOWS = "workflows"
 Audit option: workflow events. More...
 
static final String AO_WORKFLOW_DATA = "workflow-data"
 Audit option: workflow data events. More...
 
static final String AO_JOBS = "jobs"
 Audit option: job events. More...
 
static final String AO_JOB_DATA = "job-data"
 Audit option: job data events. More...
 
static final String AO_SERVICES = "services"
 Audit option: service events. More...
 
static final String AO_API = "api"
 Audit option: api write events. More...
 
static final String AO_USER_EVENTS = "user-events"
 Audit option: user events. More...
 
static final String AO_OLOAD_EVENTS = "oload"
 Audit option: oload events. More...
 
static final String AO_ALERT_EVENTS = "alerts"
 Audit option: alert events. More...
 
static final String AO_GROUP_EVENTS = "groups"
 Audit option: RBAC interface group events. More...
 
static final int AOC_SYSTEM = (1 << 0)
 Audit option code: system events. More...
 
static final int AOC_WORKFLOWS = (1 << 1)
 Audit option code: workflow events.
 
static final int AOC_WORKFLOW_DATA = (1 << 2)
 Audit option code: workflow data events.
 
static final int AOC_JOBS = (1 << 3)
 Audit option code: job events.
 
static final int AOC_JOB_DATA = (1 << 4)
 Audit option code: job data events.
 
static final int AOC_SERVICES = (1 << 5)
 Audit option code: service events.
 
static final int AOC_API = (1 << 6)
 Audit option code: api write events.
 
static final int AOC_USER_EVENTS = (1 << 7)
 Audit option code: user events.
 
static final int AOC_OLOAD_EVENTS = (1 << 8)
 Audit option code: oload events. More...
 
static final int AOC_ALERT_EVENTS = (1 << 9)
 Audit option code: alert events. More...
 
static final int AOC_GROUP_EVENTS = (1 << 10)
 Audit option code: RBAC interface group events. More...
 
static final int AuditMask = (AOC_SYSTEM|AOC_WORKFLOWS|AOC_WORKFLOW_DATA|AOC_JOBS|AOC_JOB_DATA|AOC_SERVICES|AOC_API|AOC_USER_EVENTS|AOC_OLOAD_EVENTS|AOC_ALERT_EVENTS|AOC_GROUP_EVENTS)
 mask of all audit options
 
static final Map< String, Integer > AuditOptionMap
 map of audit options to audit codes
 
static final Map< Integer, StringAuditCodeMap
 map of audit codes to audit options
 

Detailed Description

The main Qorus Java service API class.

Member Function Documentation

◆ callApiAsCurrentUser()

static Object com.qoretechnologies.qorus.service.ServiceApi.callApiAsCurrentUser ( String  call,
Object...  args 
) throws Throwable
inlinestatic

calls a system API with the argument list to the API method as a top-level argument to this method as the current user

Parameters
callthe full api method name (ex: "omq.system.exec-synchronous-exiting"); see Network System API for a full list
argsany arguments to the method; if multiple argument should be passed to the method, use a list of arguments here
Returns
the return value of the method
Exceptions
UNKNOWN-API-CALLinvalid API method
INVALID-INTERNAL-API-CALLAPI may not be called internally (ex: omq.system.shutdown-wait())
See also

◆ callApiAsCurrentUserArgs()

static Object com.qoretechnologies.qorus.service.ServiceApi.callApiAsCurrentUserArgs ( String  call,
Object []  args 
) throws Throwable
inlinestatic

calls a system API with the argument list to the API method as a top-level argument to this method as the current user

Parameters
callthe full api method name (ex: "omq.system.exec-synchronous-exiting"); see Network System API for a full list
argsany arguments to the method; if multiple argument should be passed to the method, use a list of arguments here
Returns
the return value of the method
Exceptions
UNKNOWN-API-CALLinvalid API method
INVALID-INTERNAL-API-CALLAPI may not be called internally (ex: omq.system.shutdown-wait())
See also

◆ checkAuthorization()

static void com.qoretechnologies.qorus.service.ServiceApi.checkAuthorization ( String...  args) throws Throwable
inlinestatic

checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized

If current user does not have all of the given permissions, an exception is thrown.

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors; an appropriate exception is thrown.

Parameters
argsthe list of permissions to check
Exceptions
AUTHORIZATION-ERRORno authentication information supplied or user does not have all required permissions
See also

◆ checkAuthorizationArgs()

static void com.qoretechnologies.qorus.service.ServiceApi.checkAuthorizationArgs ( String []  args) throws Throwable
inlinestatic

checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized

If current user does not have all of the given permissions, an exception is thrown.

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors; an appropriate exception is thrown.

Parameters
argsthe list of permissions to check
Exceptions
AUTHORIZATION-ERRORno authentication information supplied or user does not have all required permissions
See also

◆ checkAuthorizationOr()

static void com.qoretechnologies.qorus.service.ServiceApi.checkAuthorizationOr ( String...  args) throws Throwable
inlinestatic

checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized

If current user does not have at least one of the given permissions, an exception is thrown.

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors; an appropriate exception is thrown.

Parameters
argsthe list of permissions to check
Exceptions
AUTHORIZATION-ERRORno authentication information supplied or user does not have any of the permissions given
See also

◆ checkAuthorizationOrArgs()

static void com.qoretechnologies.qorus.service.ServiceApi.checkAuthorizationOrArgs ( String []  args) throws Throwable
inlinestatic

checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized

If current user does not have at least one of the given permissions, an exception is thrown.

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors; an appropriate exception is thrown.

Exceptions
AUTHORIZATION-ERRORno authentication information supplied or user does not have any of the permissions given
See also

◆ checkJobAccess() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkJobAccess ( int []  ids) throws Throwable
inlinestatic

checks if the current user has access to the given list of job IDs; throws an exception if the user is not authorized

Parameters
idsa list of jobids to check
Exceptions
JOB-ACCESS-ERRORthe user does not have access to one or more of the given jobs
See also
svc_check_job_access()

◆ checkJobAccess() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkJobAccess ( int  id) throws Throwable
inlinestatic

checks if the current user has access to the given single job ID; throws an exception if the user is not authorized

Parameters
idthe jobid to check
Exceptions
JOB-ACCESS-ERRORthe user does not have access to the given job
See also
svc_check_job_access()

◆ checkJobInstanceAccess()

static void com.qoretechnologies.qorus.service.ServiceApi.checkJobInstanceAccess ( int  jiid) throws Throwable
inlinestatic

checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized

Parameters
jiidthe job_instanceid to check
Exceptions
JOB-ACCESS-ERRORthe user does not have access to the given job
See also
svc_check_job_instance_access()

◆ checkMapperAccess() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkMapperAccess ( int []  ids) throws Throwable
inlinestatic

checks if the current user has access to the given list of mapper IDs; throws an exception if the user is not authorized

Parameters
idsa list of mapperids to check
Exceptions
MAPPER-ACCESS-ERRORthe user does not have access to one or more of the given mappers
See also
svc_check_mapper_access()

◆ checkMapperAccess() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkMapperAccess ( int  id) throws Throwable
inlinestatic

checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized

Parameters
idthe mapperid to check
Exceptions
MAPPER-ACCESS-ERRORthe user does not have access to the given mapper
See also
svc_check_mapper_access()

◆ checkQueueAccess()

static void com.qoretechnologies.qorus.service.ServiceApi.checkQueueAccess ( int  queueid,
String  key 
) throws Throwable
inlinestatic

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

Parameters
queueidthe queue ID to check
keythe key value in queue given by the first argument to check
Exceptions
WORKFLOW-ACCESS-ERRORno authentication information supplied or user does not have access to the given workflow
See also
svc_check_queue_access()

◆ checkServiceAccess() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkServiceAccess ( int []  ids) throws Throwable
inlinestatic

checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized

Parameters
idsa list of serviceids to check
Exceptions
SERVICE-ACCESS-ERRORno authentication information supplied or user does not have access to one or more of the given services
See also
svc_check_service_access()

◆ checkServiceAccess() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkServiceAccess ( int  id) throws Throwable
inlinestatic

checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized

Parameters
idthe serviceid to check
Exceptions
SERVICE-ACCESS-ERRORno authentication information supplied or user does not have access to the given service
See also
svc_check_service_access()

◆ checkVmapAccess() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkVmapAccess ( int []  ids) throws Throwable
inlinestatic

checks if the current user has access to the given list of value map IDs; throws an exception if the user is not authorized

Parameters
idsa list of value map ids to check
Exceptions
VMAP-ACCESS-ERRORthe user does not have access to one or more of the given value maps
See also
svc_check_vmap_access()

◆ checkVmapAccess() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkVmapAccess ( int  id) throws Throwable
inlinestatic

checks if the current user has access to the given single value map ID; throws an exception if the user is not authorized

Parameters
idthe value map id to check
Exceptions
VMAP-ACCESS-ERRORthe user does not have access to the given value map
See also
svc_check_vmap_access()

◆ checkWorkflowAccess() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkWorkflowAccess ( int []  ids) throws Throwable
inlinestatic

checks if the current user has access to the given list of workflow IDs; throws an exception if the user is not authorized

Parameters
idsa list of workflowids to check
Exceptions
WORKFLOW-ACCESS-ERRORthe user does not have access to one or more of the given workflows
See also
svc_check_workflow_access()

◆ checkWorkflowAccess() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.checkWorkflowAccess ( int  id) throws Throwable
inlinestatic

checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized

Parameters
idthe workflowid to check
Exceptions
WORKFLOW-ACCESS-ERRORthe user does not have access to the given workflow
See also
svc_check_workflow_access()

◆ checkWorkflowInstanceAccess()

static void com.qoretechnologies.qorus.service.ServiceApi.checkWorkflowInstanceAccess ( int  wfiid) throws Throwable
inlinestatic

checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized

Parameters
wfiidthe workflow_instanceid to check
Exceptions
WORKFLOW-ACCESS-ERRORno authentication information supplied or user does not have access to the given workflow
See also
svc_check_workflow_instance_access()

◆ getActiveJobsAsCurrentUser()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getActiveJobsAsCurrentUser ( ) throws Throwable
inlinestatic

Returns information on all active jobs visible to the given user.

If any active jobs are not accessible to the calling user, then they are filtered from the hash returned.

Returns
a hash is keyed by job name; the hash values are job information hashes with the following keys:
  • jobid: the metadata jobid of the job type
  • name: the job name
  • version: the job version
  • description: the job description
  • trigger: a string describing the timer/trigger for the job
  • [job_instanceid]: the id of the job instance (will only have a value if the job is currently executing)
  • [last_executed]: the last executed date/time of the job (null if not yet executed)
  • [last_executed_job_instanceid]: the last executed instance id of the job
  • [expiry_date]: the expiry date of the job, if any; if this date is present, then the job will not run automatically after this date
  • single_instance: true if the job can only be run in a single Qorus instance, False if no such restriction is enabled
  • [next]: the next trigger date/time; this key is only included if the job is active
  • active: this value is always true because this API only returns information about active jobs
See also
svc_get_active_jobs_as_current_user()

◆ getCallContext()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getCallContext ( ) throws Throwable
inlinestatic

returns contextual information about the current call

Returns
null if no context information is available, otherwise a hash with the following possible keys; keys actually present depend on the context of the caller to the service method:
  • wf: this key is present if the call to the service method originated from workflow code while processing an order; the value is a hash with the following keys:
    • name: the name of the workflow
    • version: the version of the workflow
    • workflowid: the workflowid of the workflow
    • workflow_instanceid: the workflow_instanceid of the order being executed
    • stepid: the stepid of the step being executed
    • ind: the array step index of the step being executed
    • priority: the priority of the workflow order
    • started: the date/time the order started processing
    • options: the current workflow execution instance option hash
  • job: this key is present if the call to the service method originated from job code; the value is a hash with the following keys:
    • jobid: the metadata jobid of the job type
    • job_instanceid: the id of the job instance
    • name: the job name
    • version: the job version
    • description: the job description
    • trigger: a string describing the timer/trigger for the job
    • last_executed: the last executed date/time of the job (null if never executed before the current iteration)
    • last_executed_job_instanceid: the last executed instance id of the job
    • single_instance: true if the job can only be run in a single Qorus instance, False if no such restriction is enabled
    • next: the next trigger date/time
  • cx: this key is present if the call to the service method originated externally through the network API; the value is a hash with the following keys:
    • socket: the bind address used to bind the listener ("socket-info" provides more detailed information)
    • socket-info: a hash of socket information for the listening socket (as returned by Socket::getSocketInfo())
    • peer-info: a hash of socket information for the remote socket (as returned by Socket::getPeerInfo())
    • url: a hash of broken-down URL information (as returned from parseURL())
    • id: the unique HTTP connection ID
    • ssl: true if the request was encrypted with HTTPS, false if no
    • user: the current RBAC username (if any)
See also

◆ getCallContextString() [1/2]

static String com.qoretechnologies.qorus.service.ServiceApi.getCallContextString ( HashMap< String, Object cx) throws Throwable
inlinestatic

returns a string describing the current call context

Example:
String str = ServiceApi::getCallContextString(cx);
Parameters
cxoptional thread context hash from HTTP handler if available
Returns
a string describing the current call context
See also
svc_get_call_context_string()

◆ getCallContextString() [2/2]

static String com.qoretechnologies.qorus.service.ServiceApi.getCallContextString ( ) throws Throwable
inlinestatic

returns a string describing the current call context

Example:
String str = ServiceApi::getCallContextString();
Returns
a string describing the current call context
See also
svc_get_call_context_string()

◆ getConfigItemHash() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getConfigItemHash ( HashMap< String, Object local_context) throws Throwable
inlinestatic

returns a hash of all configuration items for the current service as a combination of local and global configuration items

Example:
HashMap<String, Object> config = ServiceApi.getConfigItemHash(local_context);
Parameters
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
a hash of all configuration items for the current service; keys are config item names; values are config item values. If there are no config items for the current service, then an empty hash is returned.
Note
  • if there are local configuration item values and values on global level, local values will take precedence over the global values
  • values are always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Service Configuration Items

◆ getConfigItemHash() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getConfigItemHash ( ) throws Throwable
inlinestatic

returns a hash of all configuration items for the current service as a combination of local and global configuration items

Example:
HashMap<String, Object> config = ServiceApi.getConfigItemHash();
Returns
a hash of all configuration items for the current service; keys are config item names; values are config item values. If there are no config items for the current service, then an empty hash is returned.
Note
  • if there are local configuration item values and values on global level, local values will take precedence over the global values
  • values are always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Service Configuration Items

◆ getConfigItemValue() [1/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.getConfigItemValue ( String  item,
HashMap< String, Object local_context 
) throws Throwable
inlinestatic

returns the value of the given configuration item

Example:
Object val = ServiceApi.getConfigItemValue(item, local_context);
Parameters
itemthe name of the service configuration item; service configuration item values take precedence over values on global level if both are set otherwise if both are not set the default value is returned
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
the value of the given service configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
the value is always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Service Configuration Items

◆ getConfigItemValue() [2/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.getConfigItemValue ( String  item) throws Throwable
inlinestatic

returns the value of the given configuration item

Example:
Object val = ServiceApi.getConfigItemValue(item);
Parameters
itemthe name of the service configuration item; service configuration item values take precedence over values on global level if both are set otherwise if both are not set the default value is returned
Returns
the value of the given service configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
the value is always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Service Configuration Items

◆ getHttpCallContext()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getHttpCallContext ( ) throws Throwable
inlinestatic

returns a hash with HTTP call context information

Note
This API method is relevant for any external HTTP call, including SOAP and REST calls
See also
svc_get_http_call_context()

◆ getJobAccessHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getJobAccessHash ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all jobs

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 null is returned
See also
svc_get_job_access_list()

◆ getJobAccessList()

static int [] com.qoretechnologies.qorus.service.ServiceApi.getJobAccessList ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all jobs

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 null is returned
See also
svc_get_job_access_list()

◆ getLastEvents()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getLastEvents ( int  count) throws Throwable
inlinestatic

returns the last system events

Parameters
countthe maximum number of system events to return
Returns
a hash with the following keys:
  • lastid: the last event ID at the time the method returns
  • events: a list of event hashes (see eventhash for a detailed description); note that this key will be missing if no events are returned
  • shutdown: if this key is returned, it means the system is shutting down
Exceptions
SHUTDOWN-ERRORthis exception is raised if any event API is called a second time after the "shutdown" key is returned
See also
svc_get_last_events()

◆ getLastEventsAnd() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getLastEventsAnd ( int  count,
Object  filter,
Object  or_not 
) throws Throwable
inlinestatic

gets the last system events that meet all of the filter criteria or none of the "or_not" criteria, if present

Parameters
countthe maximum number of events to return; if this argument is 0, then the size of the returned list is only limited by the number of events in the system that match the filter(s) passed.
filterthis argument is the criteria list for "logical and" comparisons to be applied to the events. If an event matches all of the criteria hashes in the first argument, then it is included in the resulting list. To match a criteria hash in the second argument with this API call, any of the criteria keys in a single hash can match, therefore, to get pure "logical and" behavior, the caller must specify only one hash key in each criteria hash; see Event Filter Criteria for a description of each criteria hash
or_notthis argument is an optional criteria list that can augment the list returned with negative matches. If this argument is present and any element in the system’s event list does not match any of the criteria hashes in the third argument, then it is also included in the returned event list. Note that the third argument, if present, is processed with inverted logic compared to the second argument; for a single criteria hash to match, all of the criteria given as hash keys in the criteria hash must match, therefore, to get pure inverted "logical or" logic, the caller must specify only one hash key per hash in the list making up the third argument; see Event Filter Criteria for a description of each criteria hash
Returns
a hash with the following keys:
  • lastid: the last event ID at the time the method returns
  • events: a list of event hashes (see eventhash for a detailed description); note that this key will be missing if no events are returned
  • shutdown: if this key is returned, it means the system is shutting down
Exceptions
GET-LAST-EVENTS-AND-ERRORempty or missing filter value
GET-EVENTS-ERRORnon-hash criteria element passed in event filter
INVALID-CRITERIA-CODEinvalid criteria code found in event filter
SHUTDOWN-ERRORthis exception is raised if any event API is called a second time after the "shutdown" key is returned
See also
svc_get_last_events_and()

◆ getLastEventsAnd() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getLastEventsAnd ( int  count,
Object  filter 
) throws Throwable
inlinestatic

gets the last system events that meet all of the filter criteria or none of the "or_not" criteria, if present

Parameters
countthe maximum number of events to return; if this argument is 0, then the size of the returned list is only limited by the number of events in the system that match the filter(s) passed.
filterthis argument is the criteria list for "logical and" comparisons to be applied to the events. If an event matches all of the criteria hashes in the first argument, then it is included in the resulting list. To match a criteria hash in the second argument with this API call, any of the criteria keys in a single hash can match, therefore, to get pure "logical and" behavior, the caller must specify only one hash key in each criteria hash; see Event Filter Criteria for a description of each criteria hash
Returns
a hash with the following keys:
  • lastid: the last event ID at the time the method returns
  • events: a list of event hashes (see eventhash for a detailed description); note that this key will be missing if no events are returned
  • shutdown: if this key is returned, it means the system is shutting down
Exceptions
GET-LAST-EVENTS-AND-ERRORempty or missing filter value
GET-EVENTS-ERRORnon-hash criteria element passed in event filter
INVALID-CRITERIA-CODEinvalid criteria code found in event filter
SHUTDOWN-ERRORthis exception is raised if any event API is called a second time after the "shutdown" key is returned
See also
svc_get_last_events_and()

◆ getLastEventsOr() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getLastEventsOr ( int  count,
Object  filter,
Object  and_not 
) throws Throwable
inlinestatic

gets the last system events that meet any of the filter criteria and none of the "and_not" criteria, if present

Returns a hash giving the list of the most recent system events matching a filter and the last event ID generated by the system. Events in the event list returned must match the criteria passed as the second argument; if any of the criteria match an event, then it is included in the return list, unless a third criteria list argument is also passed, which allows for removing elements from the list returned.

Parameters
countthe maximum number of events to return; if this argument is 0, then the size of the returned list is only limited by the number of events in the system that match the filter(s) passed.
filterthis argument gives the criteria list for "logical or" comparisons to be applied to the events. If an event matches any of the criteria hashes in the first argument, then it is included in the resulting list, subject to processing by the optional third argument. To match a criteria hash in the second argument with this API call, all of the criteria keys in each hash must match, therefore, to get pure "logical or" behavior the caller must specify only one hash key in each criteria hash; see Event Filter Criteria for a description of each criteria hash
and_notthis argument is an optional criteria list allowing the resulting event list to be filtered; if any event selected by the second argument matches all criteria hashes in the criteria hashes passed as the third argument, then it is filtered out of the resulting list. Note that the third argument, if present, is processed with inverted logic compared to the second argument; for a criteria hash to match, any of the criteria given as hash keys in a criteria hash can match, however, all criteria hashes must match for the filter to operate. Therefore, to get pure "logical and" filtering the caller must specify only one hash key per hash in the list making up the third argument; see Event Filter Criteria for a description of each criteria hash
Returns
a hash with the following keys:
  • lastid: the last event ID at the time the method returns
  • events: a list of event hashes (see eventhash for a detailed description); note that this key will be missing if no events are returned
  • shutdown: if this key is returned, it means the system is shutting down
Exceptions
GET-LAST-EVENTS-OR-ERRORempty or missing filter value
GET-EVENTS-ERRORnon-hash criteria element passed in event filter
INVALID-CRITERIA-CODEinvalid criteria code found in event filter
SHUTDOWN-ERRORthis exception is raised if any event API is called a second time after the "shutdown" key is returned
See also
svc_get_last_events_or()

◆ getLastEventsOr() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getLastEventsOr ( int  count,
Object  filter 
) throws Throwable
inlinestatic

gets the last system events that meet any of the filter criteria and none of the "and_not" criteria, if present

Returns a hash giving the list of the most recent system events matching a filter and the last event ID generated by the system. Events in the event list returned must match the criteria passed as the second argument; if any of the criteria match an event, then it is included in the return list, unless a third criteria list argument is also passed, which allows for removing elements from the list returned.

Parameters
countthe maximum number of events to return; if this argument is 0, then the size of the returned list is only limited by the number of events in the system that match the filter(s) passed.
filterthis argument gives the criteria list for "logical or" comparisons to be applied to the events. If an event matches any of the criteria hashes in the first argument, then it is included in the resulting list, subject to processing by the optional third argument. To match a criteria hash in the second argument with this API call, all of the criteria keys in each hash must match, therefore, to get pure "logical or" behavior the caller must specify only one hash key in each criteria hash; see Event Filter Criteria for a description of each criteria hash
Returns
a hash with the following keys:
  • lastid: the last event ID at the time the method returns
  • events: a list of event hashes (see eventhash for a detailed description); note that this key will be missing if no events are returned
  • shutdown: if this key is returned, it means the system is shutting down
Exceptions
GET-LAST-EVENTS-OR-ERRORempty or missing filter value
GET-EVENTS-ERRORnon-hash criteria element passed in event filter
INVALID-CRITERIA-CODEinvalid criteria code found in event filter
SHUTDOWN-ERRORthis exception is raised if any event API is called a second time after the "shutdown" key is returned
See also
svc_get_last_events_or()

◆ getMapperAccessHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getMapperAccessHash ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all mappers

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 null is returned
Note
a return value of an empty hash means that the user has access to no value maps; this must be distinguished from a return value of null, which means that the user has access to all value maps
See also
svc_get_mapper_access_hash()

◆ getMapperAccessList()

static int [] com.qoretechnologies.qorus.service.ServiceApi.getMapperAccessList ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all mappers

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 null is returned
Note
a return value of an empty list means that the user has access to no value maps; this must be distinguished from a return value of null, which means that the user has access to all value maps
See also
svc_get_mapper_access_list()

◆ getOption() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getOption ( ) throws Throwable
inlinestatic

Returns the value of all service options.

Returns
all service-level options are returned as a hash
See also

◆ getOption() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getOption ( String...  args) throws Throwable
inlinestatic

Returns the value of the named service option or options.

If the option is not set on the service, and it is a valid system option, then the value of the system option will be returned.

Parameters
argsthe list of options to return
Returns
the value requested directly if only one argument is passed, otherwise a hash of option keys and values; note that if no arguments are passed to the method all service-level options are returned as a hash
Note
Invalid options do not cause an errors to be raised; the associated key values in the hash returned will be null
See also

◆ getOption() [3/3]

static Object com.qoretechnologies.qorus.service.ServiceApi.getOption ( String  key) throws Throwable
inlinestatic

Returns the value of the named service option.

If the option is not set on the service, and it is a valid system option, then the value of the system option will be returned.

Returns
the value of the requested option
Note
Invalid options do not cause an errors to be raised; the associated value returned will be null
See also
WorkflowApi::getOption()

◆ getResource() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getResource ( String  name,
HashMap< String, Object ctx,
int  code,
HashMap< String, Object hdr 
) throws Throwable
inlinestatic

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.

Example:
HashMap<String, Object> h = ServiceApi::getResource("image.jpg", cx);
Parameters
namethe name of the resource
ctxthe argument hash to the template code
codethe HTTP response code for the response
hdrany optional headers for the response (the "Content-Type" header is set from the templates "Content-Type" value automatically)
Returns
a hash with the following keys:
  • code: the HTTP response code corresponding to the code argument
  • body: the rendered template or file resource
  • hdr: a hash of headers corresponding to the hdr argument plus the "Content-Type" key set from the template's "Content-Type" value)
Exceptions
SERVICE-FILE-RESOURCE-ERRORthe given service file resource does not exist
See also

◆ getResource() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getResource ( String  name,
HashMap< String, Object ctx,
int  code 
) throws Throwable
inlinestatic

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.

Example:
HashMap<String, Object> h = ServiceApi::getResource("image.jpg", cx);
Parameters
namethe name of the resource
ctxthe argument hash to the template code
codethe HTTP response code for the response
Returns
a hash with the following keys:
  • code: the HTTP response code corresponding to the code argument
  • body: the rendered template or file resource
  • hdr: a hash of headers corresponding to the hdr argument plus the "Content-Type" key set from the template's "Content-Type" value)
Exceptions
SERVICE-FILE-RESOURCE-ERRORthe given service file resource does not exist
See also

◆ getResource() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getResource ( String  name,
HashMap< String, Object ctx 
) throws Throwable
inlinestatic

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.

Example:
HashMap<String, Object> h = ServiceApi::getResource("image.jpg", cx);
Parameters
namethe name of the resource
ctxthe argument hash to the template code
Returns
a hash with the following keys:
  • code: the HTTP response code; in this variant always 200
  • body: the rendered template or file resource
  • hdr: a hash of headers corresponding to the hdr argument plus the "Content-Type" key set from the template's "Content-Type" value)
Exceptions
SERVICE-FILE-RESOURCE-ERRORthe given service file resource does not exist
See also

◆ getResourceData() [1/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.getResourceData ( String  name,
HashMap< String, Object ctx 
) throws Throwable
inlinestatic

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.

Example:
binary img = ServiceApi::getResourceData("image.jpg");
Parameters
namethe name of the file resource
ctxan optional argument hash used if rendering a template resource
Returns
the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned
Exceptions
SERVICE-FILE-RESOURCE-ERRORthe given service file resource does not exist
See also

◆ getResourceData() [2/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.getResourceData ( String  name) throws Throwable
inlinestatic

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.

Example:
binary img = ServiceApi::getResourceData("image.jpg");
Parameters
namethe name of the file resource
Returns
the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned
Exceptions
SERVICE-FILE-RESOURCE-ERRORthe given service file resource does not exist
See also

◆ getResourceHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getResourceHash ( ) throws Throwable
inlinestatic

returns a hash of the service's file resources (hash keys are service file resource names) or null if the service has none

Example:
*HashMap<String, Object> h = ServiceApi::getResourceHash();
Returns
a hash of the service's file resources (hash keys are service file resource names) or null if the service has none
See also

◆ getResourceList()

static String [] com.qoretechnologies.qorus.service.ServiceApi.getResourceList ( ) throws Throwable
inlinestatic

returns a list of the service's file resources or null if the service has none

Example:
list<auto> l = ServiceApi::getResourceList();
Returns
a list of the service's file resources or null if the service has none
See also

◆ getRunningWorkflowListAsCurrentUser() [1/2]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.getRunningWorkflowListAsCurrentUser ( String  name,
String  ver 
) throws Throwable
inlinestatic

returns a list of hashes giving information about the currently-running workflow execution instances if the current user can access them

Parameters
namethe workflow name
verthe worklow version
Returns
a list of hashes giving information about the currently-running workflow execution instances; if no workflow execution instances are running, then an empty list is returned; otherwise each list element is a hash with the following keys:
  • executionID: the workflow execution instance id
    • name: the name of the workflow
    • version: version of the workflow
    • workflowid: the workflowid of the workflow
    • mode: OMQ.WM_Normal, OMQ.WM_Recovery, OMQ::WM_Synchronous
    • status: OMQ::WISInitializing, OMQ::WISRunning, OMQ::WISWaiting, OMQ::WISStopping
    • iterations: number of segment iterations performed so far
    • totalSegments: number of segments executed
    • errors: total number of errors encountered
    • warnings: total number of warnings raised
    • starttime: date/time the execution instance was started
    • options: options set on the workflow execution instance
    • logfile: log file name
Exceptions
WORKFLOW-ACCESS-ERRORthe current user does not have the right to access one or more running workflows
See also
svc_get_running_workflow_list_as_current_user()

◆ getRunningWorkflowListAsCurrentUser() [2/2]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.getRunningWorkflowListAsCurrentUser ( String  name) throws Throwable
inlinestatic

returns a list of hashes giving information about the currently-running workflow execution instances if the current user can access them

Parameters
namethe workflow name
Returns
a list of hashes giving information about the currently-running workflow execution instances; if no workflow execution instances are running, then an empty list is returned; otherwise each list element is a hash with the following keys:
  • executionID: the workflow execution instance id
    • name: the name of the workflow
    • version: version of the workflow
    • workflowid: the workflowid of the workflow
    • mode: OMQ.WM_Normal, OMQ.WM_Recovery, OMQ::WM_Synchronous
    • status: OMQ::WISInitializing, OMQ::WISRunning, OMQ::WISWaiting, OMQ::WISStopping
    • iterations: number of segment iterations performed so far
    • totalSegments: number of segments executed
    • errors: total number of errors encountered
    • warnings: total number of warnings raised
    • starttime: date/time the execution instance was started
    • options: options set on the workflow execution instance
    • logfile: log file name
Exceptions
WORKFLOW-ACCESS-ERRORthe current user does not have the right to access one or more running workflows
See also
svc_get_running_workflow_list_as_current_user()

◆ getServiceAccessHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceAccessHash ( ) throws Throwable
inlinestatic

returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then null is returned

null is only returned if the current user has access to all services

Returns
a hash of service IDs the current user has access to; or, if the current user has access to all services, then null is returned
See also
svc_get_service_access_hash()

◆ getServiceAccessList()

static int [] com.qoretechnologies.qorus.service.ServiceApi.getServiceAccessList ( ) throws Throwable
inlinestatic

returns a list of service IDs the current user has access to; or, if the current user has access to all services, then null is returned

null is only returned if the current user has access to all services

Returns
a list of service IDs the current user has access to; or, if the current user has access to all services, then null is returned
See also
svc_get_service_access_list()

◆ getServiceInfo() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfo ( HashMap< String, Object cx) throws Throwable
inlinestatic

returns information about the current service

Parameters
cxoptional thread context hash from HTTP handler if available
Returns
a hash with the following keys:
  • type: the service type ("user" or "system")
  • name: the name of the service
  • version: the version of the service
  • desc: the description of the service
  • serviceid: the ID of the service, corresponding to SERVICES.SERVICEID in the database
  • status: either OMQ.SSRunning (if there are running threads) or OMQ.SSLoaded
  • threads: the number of currently running threads
  • autostart: the autostart flag
  • loaded: the date/time the service was loaded/started
  • methods: a list of hashes with name and desc keys for each method
  • method: the name of the current method being called
  • resources: a hash of resources attached to the service (may be null); each hash key is the unique resource name, and the value of each key is a hash with the following keys:
  • type: a string giving the resource type name (ie "HttpGlobalHandler", "HttpListener", "FtpListener", etc)
  • desc: a hashdecl description of the resource
  • info: a hash with additional, free-form information about the resource
  • groups: a list of zero or more strings giving group names the service is a member of
See also
svc_get_service_info()

◆ getServiceInfo() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfo ( ) throws Throwable
inlinestatic

returns information about the current service

Returns
a hash with the following keys:
  • type: the service type ("user" or "system")
  • name: the name of the service
  • version: the version of the service
  • desc: the description of the service
  • serviceid: the ID of the service, corresponding to SERVICES.SERVICEID in the database
  • status: either OMQ.SSRunning (if there are running threads) or OMQ.SSLoaded
  • threads: the number of currently running threads
  • autostart: the autostart flag
  • loaded: the date/time the service was loaded/started
  • methods: a list of hashes with name and desc keys for each method
  • method: the name of the current method being called
  • resources: a hash of resources attached to the service (may be null); each hash key is the unique resource name, and the value of each key is a hash with the following keys:
  • type: a string giving the resource type name (ie "HttpGlobalHandler", "HttpListener", "FtpListener", etc)
  • desc: a hashdecl description of the resource
  • info: a hash with additional, free-form information about the resource
  • groups: a list of zero or more strings giving group names the service is a member of
See also
svc_get_service_info()

◆ getServiceInfoAsCurrentUser() [1/4]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfoAsCurrentUser ( String  type,
String  name,
HashMap< String, Object cx 
) throws Throwable
inlinestatic

returns information about the given service from the service name (if it's currently loaded) and if the calling user can access the service

to get information about services whether they are loaded or not, call REST API:

system/metadata/lookupserviceinfo/<type>/<name>
Parameters
typethe type of service (either "system" or "user"; case is ignored)
namethe name of the system service to query
cxoptional thread context hash from HTTP handler if available
Returns
a hash of service information or null if the service is not loaded; the hash will have the following structure:
  • type: either "system" or "user" corresponding to the argument
  • name: the name of the service
  • version: version of the service
  • desc: description of the service
  • serviceid: service ID
  • status: OMQ.SSRunning or OMQ.SSLoaded
  • threads: number of running threads in the service
  • autostart: true or false if the autostart flag is set
  • loaded: date/time the service was loaded
  • methods: list of hashes for each method with name and desc keys
Exceptions
SERVICE-ACCESS-ERRORthe current user does not have the right to access the given service
See also
svc_get_service_info_as_current_user()

◆ getServiceInfoAsCurrentUser() [2/4]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfoAsCurrentUser ( String  type,
String  name 
) throws Throwable
inlinestatic

returns information about the given service from the service name (if it's currently loaded) and if the calling user can access the service

to get information about services whether they are loaded or not, call REST API:

system/metadata/lookupserviceinfo/<type>/<name>
Parameters
typethe type of service (either "system" or "user"; case is ignored)
namethe name of the system service to query
Returns
a hash of service information or null if the service is not loaded; the hash will have the following structure:
  • type: either "system" or "user" corresponding to the argument
  • name: the name of the service
  • version: version of the service
  • desc: description of the service
  • serviceid: service ID
  • status: OMQ.SSRunning or OMQ.SSLoaded
  • threads: number of running threads in the service
  • autostart: true or false if the autostart flag is set
  • loaded: date/time the service was loaded
  • methods: list of hashes for each method with name and desc keys
Exceptions
SERVICE-ACCESS-ERRORthe current user does not have the right to access the given service
See also
svc_get_service_info_as_current_user()

◆ getServiceInfoAsCurrentUser() [3/4]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfoAsCurrentUser ( int  id,
HashMap< String, Object cx 
) throws Throwable
inlinestatic

returns information about the given service from the serviceid (if it's currently loaded) and if the calling user can access the service

to get information about services whether they are loaded or not, call REST API:

system/metadata/lookupserviceinfo/<type>/<name>
Parameters
idthe serviceid of the service
cxoptional thread context hash from HTTP handler if available
Returns
a hash of service information or null if the service is not loaded; the hash will have the following structure:
  • type: either "system" or "user" corresponding to the argument
  • name: the name of the service
  • version: version of the service
  • desc: description of the service
  • serviceid: service ID
  • status: OMQ.SSRunning or OMQ.SSLoaded
  • threads: number of running threads in the service
  • autostart: true or false if the autostart flag is set
  • loaded: date/time the service was loaded
  • methods: list of hashes for each method with name and desc keys
Exceptions
SERVICE-ACCESS-ERRORthe current user does not have the right to access the given service
See also
svc_get_service_info_as_current_user()

◆ getServiceInfoAsCurrentUser() [4/4]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getServiceInfoAsCurrentUser ( int  id) throws Throwable
inlinestatic

returns information about the given service from the serviceid (if it's currently loaded) and if the calling user can access the service

to get information about services whether they are loaded or not, call REST API:

system/metadata/lookupserviceinfo/<type>/<name>
Parameters
idthe serviceid of the service
Returns
a hash of service information or null if the service is not loaded; the hash will have the following structure:
  • type: either "system" or "user" corresponding to the argument
  • name: the name of the service
  • version: version of the service
  • desc: description of the service
  • serviceid: service ID
  • status: OMQ.SSRunning or OMQ.SSLoaded
  • threads: number of running threads in the service
  • autostart: true or false if the autostart flag is set
  • loaded: date/time the service was loaded
  • methods: list of hashes for each method with name and desc keys
Exceptions
SERVICE-ACCESS-ERRORthe current user does not have the right to access the given service
See also
svc_get_service_info_as_current_user()

◆ getStateData()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getStateData ( ) throws Throwable
inlinestatic

returns any service state state data stored with saveStateData()

Returns
any service state state data stored with saveStateData()
Note
service state state data is automatically cleared when a service instance gets a OMQ.StatComplete status
See also

◆ getTemplateHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getTemplateHash ( ) throws Throwable
inlinestatic

returns a hash of the service's template file resources (hash keys are service template resource names) or null if the service has none

Example:
*HashMap<String, Object> h = ServiceApi::getTemplateHash();
Returns
a hash of the service's template file resources (hash keys are service template resource names) or null if the service has none
See also

◆ getTemplateList()

static String [] com.qoretechnologies.qorus.service.ServiceApi.getTemplateList ( ) throws Throwable
inlinestatic

returns a list of the service's template file resources or null if the service has none

Example:
list<auto> l = ServiceApi::getTemplateList();
Returns
a list of the service's template file resources or null if the service has none
See also

◆ getVmapAccessHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getVmapAccessHash ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all value maps

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 null is returned
Note
a return value of an empty hash means that the user has access to no value maps; this must be distinguished from a return value of null, which means that the user has access to all value maps
See also
svc_get_vmap_access_hash()

◆ getVmapAccessList()

static int [] com.qoretechnologies.qorus.service.ServiceApi.getVmapAccessList ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all value maps

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 null is returned
Note
a return value of an empty list means that the user has access to no value maps; this must be distinguished from a return value of null, which means that the user has access to all value maps
See also
svc_test_vmap_access()

◆ getWorkflowAccessHash()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.getWorkflowAccessHash ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all workflows

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 null is returned
See also
svc_get_workflow_access_hash()

◆ getWorkflowAccessList()

static int [] com.qoretechnologies.qorus.service.ServiceApi.getWorkflowAccessList ( ) throws Throwable
inlinestatic

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 null is returned

null is only returned if the current user has access to all workflows

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 null is returned
See also
svc_get_workflow_access_list()

◆ hasResource()

static boolean com.qoretechnologies.qorus.service.ServiceApi.hasResource ( String  name) throws Throwable
inlinestatic

returns true if the given service file resource exists, false if not

Example:
boolean b = ServiceApi::hasResource(name);
Returns
true if the given service file resource exists, false if not
See also

◆ hasTemplate()

static boolean com.qoretechnologies.qorus.service.ServiceApi.hasTemplate ( String  name) throws Throwable
inlinestatic

returns true if the given service template file resource exists, false if not

Example:
boolean b = ServiceApi::hasTemplate(name);
Returns
true if the given service template file resource exists, false if not
See also

◆ registerSoapHandler()

static void com.qoretechnologies.qorus.service.ServiceApi.registerSoapHandler ( HashMap< String, Object h) throws Throwable
inlinestatic

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

Creates a mapping in the system SoapHandler from the given WSDL to the current service. SOAP operations defined in the WSDL will be mapped directly to Qorus service methods with the same names as the SOAP operations.

Parameters
ha hash with the following keys (only wsdl or wsdl_file is required):
  • wsdl, wsdl_file, or wsdl_resource: a URL to the WSDL, the WSDL string (XSD), a WebService object, or a file resource name giving the WSDL file
  • service: a string giving the name of the SOAP service to map to this service; this key is only necessary to set if the WSDL defines multiple SOAP services
  • uri_path: an optional string giving an optional URI path to use when binding the SOAP service
Exceptions
REGISTER-SOAP-HANDLER-ERRORmissing wsdl or wsdl_file key in argument hash; cannot find service; multiple services defined by WSDL but no service key given in argument hash
See also
svc_register_soap_handler()

◆ renderTemplate()

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.renderTemplate ( String  name,
HashMap< String, Object ctx 
) throws Throwable
inlinestatic

explicitly renders a template file resource given the template argument hash

Example:
HashMap<String, Object> h = ServiceApi::renderTemplate("html/index.qhtml", ctx);
Parameters
namethe template file resource name
ctxthe argument hash to the template code
Returns
a hash with the following keys:
  • code: the HTTP response code corresponding to the code argument
  • body: the rendered template
  • hdr: a hash of headers corresponding to the hdr argument plus the "Content-Type" key set from the template's "Content-Type" value)
Exceptions
TEMPLATE-ERRORthe named template does not exist
See also

◆ saveStateData() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.saveStateData ( HashMap< String, Object data) throws Throwable
inlinestatic

serializes the given hash and stores against the service's state data in SERVICE_STATE_DATA

Parameters
datathe state data to serialize and store against the service's state data in SERVICE_STATE_DATA
See also

◆ saveStateData() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.saveStateData ( ) throws Throwable
inlinestatic

◆ setOption() [1/2]

static void com.qoretechnologies.qorus.service.ServiceApi.setOption ( HashMap< String, Object opts) throws Throwable
inlinestatic

Changes option values on a service.

Parameters
optsa hash of option-value pairs
Exceptions
SERVICE-OPTION-ERRORinvalid option name
See also

◆ setOption() [2/2]

static void com.qoretechnologies.qorus.service.ServiceApi.setOption ( String  option,
Object  value 
) throws Throwable
inlinestatic

Changes a single option value on a service.

Parameters
optionthe option to set
valuethe value to set for the option
Exceptions
SERVICE-OPTION-ERRORinvalid option name
See also

◆ sleep()

static int com.qoretechnologies.qorus.service.ServiceApi.sleep ( int  arg) throws Throwable
inlinestatic

puts the current thread to sleep for a certain number of seconds

If the service is stopping, this method returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this method (or usleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe number of seconds to sleep
Returns
0 if current thread was put to sleep for the full time period; -1 if the sleep was interrupted because the current object is being stopped
Exceptions
STOP-ERRORthe current object is stopping and this method already returned -1 as a warning
See also

◆ startListeners() [1/4]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.startListeners ( String  bind,
String  cert_path,
String  key_path,
String  key_password,
String  name,
int  family 
) throws Throwable
inlinestatic

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

Parameters
bindthe bind address of the new listener; listeners will be started on all possible bind addresses in case more than one interface is resolved from the bind address given
cert_paththe file name of the X.509 certificate in PEM format (only for HTTPS listeners)
key_paththe file name of the private key for the X.509 certificate in PEM format (only for HTTPS listeners)
key_passwordthe optional password for the private key
namean optional name prefix for the listener; the final listener name will have the listener id appended to it and will be returned in the "name" key in each hash element in the return value for each listener started
familyone of the following network family constants:
  • AF_INET: for binding an IPv4 socket
  • AF_INET6: for binding an IPv6 socket
  • AF_UNSPEC: for binding a socket with any available address family
Returns
a list of hashes for each listener started, each hash having the following keys (note that for UNIX domain socket listeners the hostname, hostname_desc, and port keys will not be present):
  • hostname: the hostname of the interface
  • hostname_desc: a descriptive string for the hostname including the address family (ex: "ipv6[localhost]")
  • address: the address of the listener (i.e. "192.168.30.4", etc)
  • address_desc: a descriptive string for the hostname including the address family (ex: "ipv6[::1]")
  • port: the port number
  • family: an integer giving the address family (AF_INET, AF_INET6, AF_UNIX, etc)
  • familystr: a string describing the address family (ex: "ipv6")
  • proto: either "http" or "https"
  • id: the Qorus ID of the listener
  • bind: a string giving the bind address used (ex: "127.0.0.1:8001")
Note
listeners started with this API will be served by global Qorus HTTP handlers; they will not be added as service-specific listeners
See also

◆ startListeners() [2/4]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.startListeners ( String  bind,
String  cert_path,
String  key_path,
String  key_password,
String  name 
) throws Throwable
inlinestatic

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

Parameters
bindthe bind address of the new listener; listeners will be started on all possible bind addresses in case more than one interface is resolved from the bind address given
cert_paththe file name of the X.509 certificate in PEM format (only for HTTPS listeners)
key_paththe file name of the private key for the X.509 certificate in PEM format (only for HTTPS listeners)
key_passwordthe optional password for the private key
namean optional name prefix for the listener; the final listener name will have the listener id appended to it and will be returned in the "name" key in each hash element in the return value for each listener started
Returns
a list of hashes for each listener started, each hash having the following keys (note that for UNIX domain socket listeners the hostname, hostname_desc, and port keys will not be present):
  • hostname: the hostname of the interface
  • hostname_desc: a descriptive string for the hostname including the address family (ex: "ipv6[localhost]")
  • address: the address of the listener (i.e. "192.168.30.4", etc)
  • address_desc: a descriptive string for the hostname including the address family (ex: "ipv6[::1]")
  • port: the port number
  • family: an integer giving the address family (AF_INET, AF_INET6, AF_UNIX, etc)
  • familystr: a string describing the address family (ex: "ipv6")
  • proto: either "http" or "https"
  • id: the Qorus ID of the listener
  • bind: a string giving the bind address used (ex: "127.0.0.1:8001")
Note
listeners started with this API will be served by global Qorus HTTP handlers; they will not be added as service-specific listeners
See also

◆ startListeners() [3/4]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.startListeners ( String  bind,
String  cert_path,
String  key_path,
String  key_password 
) throws Throwable
inlinestatic

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

Parameters
bindthe bind address of the new listener; listeners will be started on all possible bind addresses in case more than one interface is resolved from the bind address given
cert_paththe file name of the X.509 certificate in PEM format (only for HTTPS listeners)
key_paththe file name of the private key for the X.509 certificate in PEM format (only for HTTPS listeners)
key_passwordthe optional password for the private key
Returns
a list of hashes for each listener started, each hash having the following keys (note that for UNIX domain socket listeners the hostname, hostname_desc, and port keys will not be present):
  • hostname: the hostname of the interface
  • hostname_desc: a descriptive string for the hostname including the address family (ex: "ipv6[localhost]")
  • address: the address of the listener (i.e. "192.168.30.4", etc)
  • address_desc: a descriptive string for the hostname including the address family (ex: "ipv6[::1]")
  • port: the port number
  • family: an integer giving the address family (AF_INET, AF_INET6, AF_UNIX, etc)
  • familystr: a string describing the address family (ex: "ipv6")
  • proto: either "http" or "https"
  • id: the Qorus ID of the listener
  • bind: a string giving the bind address used (ex: "127.0.0.1:8001")
Note
listeners started with this API will be served by global Qorus HTTP handlers; they will not be added as service-specific listeners
See also

◆ startListeners() [4/4]

static HashMap<String, Object> [] com.qoretechnologies.qorus.service.ServiceApi.startListeners ( String  bind) throws Throwable
inlinestatic

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

Parameters
bindthe bind address of the new listener; listeners will be started on all possible bind addresses in case more than one interface is resolved from the bind address given
Returns
a list of hashes for each listener started, each hash having the following keys (note that for UNIX domain socket listeners the hostname, hostname_desc, and port keys will not be present):
  • hostname: the hostname of the interface
  • hostname_desc: a descriptive string for the hostname including the address family (ex: "ipv6[localhost]")
  • address: the address of the listener (i.e. "192.168.30.4", etc)
  • address_desc: a descriptive string for the hostname including the address family (ex: "ipv6[::1]")
  • port: the port number
  • family: an integer giving the address family (AF_INET, AF_INET6, AF_UNIX, etc)
  • familystr: a string describing the address family (ex: "ipv6")
  • proto: either "http" or "https"
  • id: the Qorus ID of the listener
  • bind: a string giving the bind address used (ex: "127.0.0.1:8001")
Note
listeners started with this API will be served by global Qorus HTTP handlers; they will not be added as service-specific listeners
See also

◆ stopListener()

static void com.qoretechnologies.qorus.service.ServiceApi.stopListener ( String  name) throws Throwable
inlinestatic

stops a single listener based on its name or bind address; does not return until all connections on the listener have closed

See also

◆ stopListenerId()

static void com.qoretechnologies.qorus.service.ServiceApi.stopListenerId ( int  id) throws Throwable
inlinestatic

stops a single listener based on its listener ID; does not return until all connections on the listener have closed

See also

◆ testAuthorization()

static boolean com.qoretechnologies.qorus.service.ServiceApi.testAuthorization ( String...  args) throws Throwable
inlinestatic

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)

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors, the method returns false

Parameters
argsthe list of permissions to check
Returns
if current user does not have all of the given permissions, returns False, otherwise true.
See also

◆ testAuthorizationArgs()

static boolean com.qoretechnologies.qorus.service.ServiceApi.testAuthorizationArgs ( String []  args) throws Throwable
inlinestatic

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)

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors, the method returns false

Returns
if current user does not have all of the given permissions, returns False, otherwise true.
See also

◆ testAuthorizationOr()

static boolean com.qoretechnologies.qorus.service.ServiceApi.testAuthorizationOr ( String...  args) throws Throwable
inlinestatic

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)

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors, the method returns false

Parameters
argsthe list of permissions to test
Returns
if current user does not have at least one of the given permissions, returns False, otherwise true.
See also

◆ testAuthorizationOrArgs()

static boolean com.qoretechnologies.qorus.service.ServiceApi.testAuthorizationOrArgs ( String []  args) throws Throwable
inlinestatic

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)

If no user information is available (for instance, the call is internal), then authorization is automatically granted. If there are any authorization errors, the method returns false

Returns
if current user does not have at least one of the given permissions, returns False, otherwise true.
See also

◆ testJobAccess() [1/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testJobAccess ( int []  ids) throws Throwable
inlinestatic

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)

Parameters
idsa list of jobids to check
See also
svc_test_job_access()

◆ testJobAccess() [2/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testJobAccess ( int  id) throws Throwable
inlinestatic

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)

Parameters
idthe jobid to check
See also
svc_test_job_access()

◆ testMapperAccess() [1/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testMapperAccess ( int []  ids) throws Throwable
inlinestatic

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)

Parameters
idsa list of mapperids to check
See also
svc_test_mapper_access()

◆ testMapperAccess() [2/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testMapperAccess ( int  id) throws Throwable
inlinestatic

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)

Parameters
idthe mapperid to check
See also
svc_test_mapper_access()

◆ testServiceAccess() [1/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testServiceAccess ( int []  ids) throws Throwable
inlinestatic

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)

Parameters
idsa list of serviceids to check
Exceptions
SERVICE-ACCESS-ERRORno authentication information supplied or user does not have access to the given services
See also
svc_test_service_access()

◆ testServiceAccess() [2/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testServiceAccess ( int  id) throws Throwable
inlinestatic

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)

Parameters
idthe serviceid to check
See also
svc_test_service_access()

◆ testVmapAccess() [1/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testVmapAccess ( int []  ids) throws Throwable
inlinestatic

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)

Parameters
idsa list of value map ids to check
See also
svc_test_vmap_access()

◆ testVmapAccess() [2/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testVmapAccess ( int  id) throws Throwable
inlinestatic

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)

Parameters
idthe value map id to check
See also
svc_test_vmap_access()

◆ testWorkflowAccess() [1/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testWorkflowAccess ( int []  ids) throws Throwable
inlinestatic

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)

Parameters
idsa list of workflowids to check
See also
svc_test_workflow_access()

◆ testWorkflowAccess() [2/2]

static boolean com.qoretechnologies.qorus.service.ServiceApi.testWorkflowAccess ( int  id) throws Throwable
inlinestatic

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)

Parameters
idthe workflowid to check
See also
svc_test_workflow_access()

◆ tryGetResource() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.tryGetResource ( String  name,
HashMap< String, Object ctx,
int  code,
HashMap< String, Object hdr 
) throws Throwable
inlinestatic

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 null is returned.

Example:
*HashMap<String, Object> h = ServiceApi::tryGetResource("image.jpg", cx);
Parameters
namethe name of the resource
ctxthe argument hash to the template code
codethe HTTP response code for the response, if not present then 200 "OK" is assumed
hdrany optional headers for the response (the "Content-Type" header is set from the templates "Content-Type" value automatically)
Returns
null if the resource does not exist or a hash with the following keys:
  • code: the HTTP response code