Qorus Integration Engine®  4.1.4.p2_git
com.qoretechnologies.qorus.service.ServiceApi Class Reference
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
 
static void checkAuthorizationArgs (String[] args) throws Throwable
 
static void checkAuthorizationOr (String... args) throws Throwable
 
static void checkAuthorizationOrArgs (String[] args) throws Throwable
 
static boolean testAuthorization (String... args) throws Throwable
 
static boolean testAuthorizationArgs (String[] args) throws Throwable
 
static boolean testAuthorizationOr (String... args) throws Throwable
 
static boolean testAuthorizationOrArgs (String[] args) throws Throwable
 
static void checkWorkflowAccess (int[] ids) throws Throwable
 
static void checkWorkflowAccess (int id) throws Throwable
 
static boolean testWorkflowAccess (int[] ids) throws Throwable
 
static boolean testWorkflowAccess (int id) throws Throwable
 
static int [] getWorkflowAccessList () throws Throwable
 
static HashMap< String, ObjectgetWorkflowAccessHash () throws Throwable
 
static void checkWorkflowInstanceAccess (int wfiid) throws Throwable
 
static void checkServiceAccess (int[] ids) throws Throwable
 
static void checkServiceAccess (int id) throws Throwable
 
static void checkQueueAccess (int queueid, String key) throws Throwable
 
static boolean testServiceAccess (int[] ids) throws Throwable
 
static boolean testServiceAccess (int id) throws Throwable
 
static int [] getServiceAccessList () throws Throwable
 
static HashMap< String, ObjectgetServiceAccessHash () throws Throwable
 
static void checkJobAccess (int[] ids) throws Throwable
 
static void checkJobAccess (int id) throws Throwable
 
static boolean testJobAccess (int[] ids) throws Throwable
 
static boolean testJobAccess (int id) throws Throwable
 
static int [] getJobAccessList () throws Throwable
 
static HashMap< String, ObjectgetJobAccessHash () throws Throwable
 
static void checkJobInstanceAccess (int jiid) throws Throwable
 
static void checkMapperAccess (int[] ids) throws Throwable
 
static void checkMapperAccess (int id) throws Throwable
 
static boolean testMapperAccess (int[] ids) throws Throwable
 
static boolean testMapperAccess (int id) throws Throwable
 
static int [] getMapperAccessList () throws Throwable
 
static HashMap< String, ObjectgetMapperAccessHash () throws Throwable
 
static void checkVmapAccess (int[] ids) throws Throwable
 
static void checkVmapAccess (int id) throws Throwable
 
static boolean testVmapAccess (int[] ids) throws Throwable
 
static boolean testVmapAccess (int id) throws Throwable
 
static int [] getVmapAccessList () throws Throwable
 
static HashMap< String, ObjectgetVmapAccessHash () throws Throwable
 
static void registerSoapHandler (HashMap< String, Object > h) throws Throwable
 
static HashMap< String, ObjectgetHttpCallContext () throws Throwable
 
static HashMap< String, ObjectgetLastEvents (int count) throws Throwable
 
static HashMap< String, ObjectgetLastEventsOr (int count, Object filter, Object and_not) throws Throwable
 
static HashMap< String, ObjectgetLastEventsOr (int count, Object filter) throws Throwable
 
static HashMap< String, ObjectgetLastEventsAnd (int count, Object filter, Object or_not) throws Throwable
 
static HashMap< String, ObjectgetLastEventsAnd (int count, Object filter) throws Throwable
 
static HashMap< String, ObjectwaitForEvents (int min_id, int timeout_ms) throws Throwable
 
static HashMap< String, ObjectwaitForEvents (int min_id) throws Throwable
 
static HashMap< String, ObjectwaitForEvents () throws Throwable
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter, int timeout_ms, Object and_not) throws Throwable
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter, int timeout_ms) throws Throwable
 
static HashMap< String, ObjectwaitForEventsOr (int min_id, Object filter) throws Throwable
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter, int timeout_ms, Object or_not) throws Throwable
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter, int timeout_ms) throws Throwable
 
static HashMap< String, ObjectwaitForEventsAnd (int min_id, Object filter) throws Throwable
 
static HashMap< String, ObjectgetServiceInfo (HashMap< String, Object > cx) throws Throwable
 
static HashMap< String, ObjectgetServiceInfo () throws Throwable
 
static HashMap< String, ObjectgetCallContext () throws Throwable
 
static String getCallContextString (HashMap< String, Object > cx) throws Throwable
 
static String getCallContextString () throws Throwable
 
static Object callApiAsCurrentUser (String call, Object... args) throws Throwable
 
static Object callApiAsCurrentUserArgs (String call, Object[] args) throws Throwable
 
static HashMap< String, ObjectgetServiceInfoAsCurrentUser (String type, String name, HashMap< String, Object > cx) throws Throwable
 
static HashMap< String, ObjectgetServiceInfoAsCurrentUser (String type, String name) throws Throwable
 
static HashMap< String, ObjectgetServiceInfoAsCurrentUser (int id, HashMap< String, Object > cx) throws Throwable
 
static HashMap< String, ObjectgetServiceInfoAsCurrentUser (int id) throws Throwable
 
static HashMap< String, Object > [] getRunningWorkflowListAsCurrentUser (String name, String ver) throws Throwable
 
static HashMap< String, Object > [] getRunningWorkflowListAsCurrentUser (String name) throws Throwable
 
static HashMap< String, ObjectgetActiveJobsAsCurrentUser () throws Throwable
 
static HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx, int code, HashMap< String, Object > hdr) throws Throwable
 
static HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx, int code) throws Throwable
 
static HashMap< String, ObjectgetResource (String name, HashMap< String, Object > ctx) throws Throwable
 
static HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx, int code, HashMap< String, Object > hdr) throws Throwable
 
static HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx, int code) throws Throwable
 
static HashMap< String, ObjecttryGetResource (String name, HashMap< String, Object > ctx) throws Throwable
 
static HashMap< String, ObjectgetResourceHash () throws Throwable
 
static String [] getResourceList () throws Throwable
 
static Object getResourceData (String name, HashMap< String, Object > ctx) throws Throwable
 
static Object getResourceData (String name) throws Throwable
 
static Object tryGetResourceData (String name, HashMap< String, Object > ctx) throws Throwable
 
static Object tryGetResourceData (String name) throws Throwable
 
static boolean hasResource (String name) throws Throwable
 
static HashMap< String, ObjectrenderTemplate (String name, HashMap< String, Object > ctx) throws Throwable
 
static HashMap< String, ObjecttryRenderTemplate (String name, HashMap< String, Object > ctx) throws Throwable
 
static HashMap< String, ObjectgetTemplateHash () throws Throwable
 
static String [] getTemplateList () throws Throwable
 
static boolean hasTemplate (String name) throws Throwable
 
static HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password, String name, int family) throws Throwable
 
static HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password, String name) throws Throwable
 
static HashMap< String, Object > [] startListeners (String bind, String cert_path, String key_path, String key_password) throws Throwable
 
static HashMap< String, Object > [] startListeners (String bind) throws Throwable
 
static void stopListener (String name) throws Throwable
 
static void stopListenerId (int id) throws Throwable
 
static HashMap< String, ObjecttryGetWfStaticData () throws Throwable
 
static HashMap< String, ObjecttryGetWfDynamicData () throws Throwable
 
static HashMap< String, ObjecttryGetWfTempData () throws Throwable
 
static void saveStateData (HashMap< String, Object > data) throws Throwable
 
static void saveStateData () throws Throwable
 
static HashMap< String, ObjectgetStateData () throws Throwable
 
static void setOption (HashMap< String, Object > opts) throws Throwable
 
static void setOption (String option, Object value) throws Throwable
 
static HashMap< String, ObjectgetOption () throws Throwable
 
static HashMap< String, ObjectgetOption (String... args) throws Throwable
 
static Object getOption (String key) throws Throwable
 
static int sleep (int arg) throws Throwable
 
static int usleep (int arg) throws Throwable
 
static int usleep (QoreRelativeTime arg) throws Throwable
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getConfigItemValue (String item) throws Throwable
 
static HashMap< String, ObjectgetConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectgetConfigItemHash () throws Throwable
 
static void setConfigItemChangeCallback (ConfigItemValueCallback callback) throws Throwable
 
- Static Public Member Methods inherited from com.qoretechnologies.qorus.UserApi
static Integer auditUserEvent (String user_event, String info1, String info2) throws Throwable
 
static Integer auditUserEvent (String user_event, String info1) throws Throwable
 
static Integer auditUserEvent (String user_event) throws Throwable
 
static boolean auditCheckEventString (String opt) throws Throwable
 
static boolean auditCheckEvent (int opt) throws Throwable
 
static int auditGetMask () throws Throwable
 
static int postUserEvent (String severity, Object info) throws Throwable
 
static HashMap< String, ObjectruntimeProperties () throws Throwable
 
static Object callNetworkApi (String call, Object... args) throws Throwable
 
static Object callNetworkApiArgs (String call, Object[] args) throws Throwable
 
static Object callNetworkApiArgsWithAuthentication (String user, String pass, String call, Object[] args) throws Throwable
 
static Object callRestApi (String method, String path, HashMap< String, Object > body_args) throws Throwable
 
static Object callRestApi (String method, String path) throws Throwable
 
static Object callRestApiWithAuthentication (String user, String pass, String method, String path, HashMap< String, Object > body_args) throws Throwable
 
static AbstractTable getSqlTable (String datasource, String table_name) throws Throwable
 
static AbstractTable getSqlTable (AbstractDatasource datasource, String table_name) throws Throwable
 
static HashMap< String, ObjectgetSqlCacheInfo () throws Throwable
 
static void clearSqlTableCache (String datasource, String table_name) throws Throwable
 
static void clearSqlTableCache (String datasource) throws Throwable
 
static Object getValueMap (String mapname, String key) throws Throwable
 
static HashMap< String, Object > [] getValueMaps () throws Throwable
 
static boolean postSlaEventSuccess (String sla, float value) throws Throwable
 
static boolean postSlaEventError (String sla, float value, String err, String desc) throws Throwable
 
static void flushSlaEvents () throws Throwable
 
static HashMap< String, ObjectgetSystemServiceInfo (String name) throws Throwable
 
static HashMap< String, ObjectgetServiceInfo (String type, String name) throws Throwable
 
static HashMap< String, Object > [] getRunningWorkflowList (String name, String ver) throws Throwable
 
static HashMap< String, Object > [] getRunningWorkflowList (String name) throws Throwable
 
static HashMap< String, Object > [] getRunningWorkflowList () throws Throwable
 
static HashMap< String, ObjectgetRunningWorkflowInfo (int id) throws Throwable
 
static int createOrder (String name, String version, HashMap< String, Object > params) throws Throwable
 
static int createOrder (String name, String version, HashMap< String, Object > params, String status) throws Throwable
 
static int createOrder (String name, HashMap< String, Object > params) throws Throwable
 
static int createOrder (String name, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params) throws Throwable
 
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
 
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
 
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
 
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
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata) throws Throwable
 
static HashMap< String, ObjectgetQorusOptions () throws Throwable
 
static Object getQorusOptions (String opt) throws Throwable
 
static HashMap< String, ObjectgetQorusOptions (String... opts) throws Throwable
 
static HashMap< String, ObjectgetQorusOptionsArgs (String[] opts) throws Throwable
 
static HashMap< String, ObjectgetQorusOptionInfo () throws Throwable
 
static HashMap< String, ObjectgetQorusOptionInfoArgs (String[] args) throws Throwable
 
static HashMap< String, ObjectgetActiveJobs () throws Throwable
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency, HashMap< String, Object > rtopts) throws Throwable
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 
static Object getUserConnection (String name, boolean connect) throws Throwable
 
static Object getUserConnection (String name) throws Throwable
 
static HashMap< String, ObjectgetUserConnectionTags (String name) throws Throwable
 
static DatasourcePool getDatasourcePool (String name, boolean register_dependency) throws Throwable
 
static DatasourcePool getDatasourcePool (String name) throws Throwable
 
static HashMap< String, ObjectgetDatasourceInfo (String name) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name) throws Throwable
 
static void raiseTransientAlert (String alert, String reason, HashMap< String, Object > info) throws Throwable
 
static void raiseTransientAlert (String alert, String reason) throws Throwable
 
static String qorusGetLocalUrl (String username, String password) throws Throwable
 
static String qorusGetLocalUrl () throws Throwable
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 
static void setOption (String option, Object value) throws Throwable
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 
static Object getOption (String key) throws Throwable
 
static HashMap< String, ObjectgetOption () throws Throwable
 
static HashMap< String, ObjectblockOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata, HashMap< String, Object > orderkeys) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectcancelOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectuncancelOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 
static HashMap< String, ObjectuncancelOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectgetUserContextInfo () throws Throwable
 
static String getContextUserName () throws Throwable
 
static AbstractDataProvider getDataProvider (String path) throws Throwable
 
static AbstractDataProviderType getQorusType (String type_path) throws Throwable
 
static AbstractDataProviderType getTypeFromPath (String path) throws Throwable
 
static Object getGlobalConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getGlobalConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getGlobalConfigItemValue (String item) throws Throwable
 
static Mapper getMapper (String name, HashMap< String, Object > rtopts) throws Throwable
 
static Mapper getMapper (String name) throws Throwable
 
static boolean postSyncEvent (String eventtype, String eventkey) throws Throwable
 
static int getSessionId () throws Throwable
 
static HashMap< String, ObjectgetSystemInfo () throws Throwable
 
static HashMap< String, ObjectpropGet () throws Throwable
 
static HashMap< String, ObjectpropGet (String domain) throws Throwable
 
static HashMap< String, ObjectpropGet (String domain, String key) throws Throwable
 
static String propUpdate (String domain, String key, Object value) throws Throwable
 
static void logFatal (String msg) throws Throwable
 
static void logError (String msg) throws Throwable
 
static void logWarn (String msg) throws Throwable
 
static void logInfo (String msg) throws Throwable
 
static void logDebug (String msg) throws Throwable
 
static void logTrace (String msg) throws Throwable
 
static void logFatal (String msg, Object... args) throws Throwable
 
static void logError (String msg, Object... args) throws Throwable
 
static void logWarn (String msg, Object... args) throws Throwable
 
static void logInfo (String msg, Object... args) throws Throwable
 
static void logDebug (String msg, Object... args) throws Throwable
 
static void logTrace (String msg, Object... args) throws Throwable
 
static int getNextSequenceValue (AbstractDatasource ds, String name) throws Throwable
 
static int getNextSequenceValue (String ds, String name) throws Throwable
 
static String serializeQorusData (Object d) throws Throwable
 
static String serializeQorusDataWithNothing (Object d) throws Throwable
 
static Object deserializeQorusData (String data) throws Throwable
 
static String restartTransaction (String driver, HashMap< String, Object > ex) throws Throwable
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context) throws Throwable
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectbbParseExactlyOneVariable (String str) throws Throwable
 
static HashMap< String, ObjectgetInputData (String field_name, HashMap< String, Object > local_context, HashMap< String, Object > input_data_cfg) throws Throwable
 
static HashMap< String, ObjectgetInputData (HashMap< String, Object > input_data_cfg, HashMap< String, Object > local_context) throws Throwable
 
static void updateOutputData (String field_name, Object output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 
static void updateOutputData (HashMap< String, Object > all_output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 
static String getTextFileFromLocation (String location) throws Throwable
 
static byte [] getBinaryFileFromLocation (String location) throws Throwable
 
static void startCapturingObjects () throws Throwable
 
static void stopCapturingObjects () throws Throwable
 
static void saveObjectInObjectCache (QoreObject obj) throws Throwable
 
static boolean clearObjectFromObjectCache (QoreObject obj) throws Throwable
 
static ZonedDateTime checkObjectCache (QoreObject obj) throws Throwable
 
static int getObjectCacheSize () throws Throwable
 
static int clearObjectCache () throws Throwable
 
static int clearObjectCache (ZonedDateTime cutoff) throws Throwable
 

Additional Inherited Members

- Static Public Attributes inherited from com.qoretechnologies.qorus.OMQ
static final String OT_CONSTANT = "CONSTANT"
 
static final String OT_CLASS = "CLASS"
 
static final String OT_FUNCTION = "FUNCTION"
 
static final String ExecNormal = "NORMAL"
 
static final String ExecAsync = "ASYNC"
 
static final String ExecSubWorkflow = "SUBWORKFLOW"
 
static final String ExecEvent = "EVENT"
 
static final String SSRunning = "running"
 
static final String SSLoaded = "loaded"
 
static final String SLNone = "none"
 
static final String SLRead = "read"
 
static final String SLWrite = "write"
 
static final String SQLStatComplete = "C"
 
static final String SQLStatError = "E"
 
static final String SQLStatWaiting = "W"
 
static final String SQLStatInProgress = "I"
 
static final String SQLStatIncomplete = "N"
 
static final String SQLStatAsyncWaiting = "A"
 
static final String SQLStatEventWaiting = "V"
 
static final String SQLStatRetry = "R"
 
static final String SQLStatCanceled = "X"
 
static final String SQLStatReady = "Y"
 
static final String SQLStatScheduled = "S"
 
static final String SQLStatBlocked = "B"
 
static final int LL_CRITICAL = -1
 
static final int LL_IMPORTANT = 0
 
static final int LL_INFO = 1
 
static final int LL_DETAIL_1 = 2
 
static final int LL_DETAIL_2 = 3
 
static final int LL_DEBUG_1 = 4
 
static final int LL_DEBUG_2 = 5
 
static final int LL_DEBUG_3 = 6
 
static final String WM_Normal = "NORMAL"
 
static final String WM_Recovery = "RECOVERY"
 
static final String StatComplete = "COMPLETE"
 
static final String StatError = "ERROR"
 
static final String StatWaiting = "WAITING"
 
static final String StatInProgress = "IN-PROGRESS"
 
static final String StatIncomplete = "INCOMPLETE"
 
static final String StatAsyncWaiting = "ASYNC-WAITING"
 
static final String StatEventWaiting = "EVENT-WAITING"
 
static final String StatRetry = "RETRY"
 
static final String StatCanceled = "CANCELED"
 
static final String StatReady = "READY"
 
static final String StatScheduled = "SCHEDULED"
 
static final String StatBlocked = "BLOCKED"
 
static final Map< String, StringStatMap
 
static final Map< String, StringSQLStatMap
 
static final String ES_Major = "MAJOR"
 
static final String ES_Warning = "WARNING"
 
static final String CS_Clean = "C"
 
static final String CS_RecoveredAuto = "A"
 
static final String CS_RecoveredManual = "M"
 
static final String QS_Waiting = "WAITING"
 
static final String QS_Received = "RECEIVED"
 
static final String QS_Error = "ERROR"
 
static final String QS_Used = "USED"
 
static final String SQL_QS_Waiting = "W"
 
static final String SQL_QS_Received = "R"
 
static final String SQL_QS_Error = "E"
 
static final String SQL_QS_Used = "X"
 
static final Map< String, StringQSMap
 
static final Map< String, StringSQLQSMap
 
static final String QR_LOGIN = "LOGIN"
 
static final String QR_SHUTDOWN = "SHUTDOWN"
 
static final String QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
 
static final String QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
 
static final String QR_START_WORKFLOW = "START-WORKFLOW"
 
static final String QR_STOP_WORKFLOW = "STOP-WORKFLOW"
 
static final String QR_RESET_WORKFLOW = "RESET-WORKFLOW"
 
static final String QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
 
static final String QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
 
static final String QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
 
static final String QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
 
static final String QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
 
static final String QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
 
static final String QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
 
static final String QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
 
static final String QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
 
static final String QR_SKIP_STEP = "SKIP-STEP"
 
static final String QR_SET_ORDER_INFO = "SET-ORDER-INFO"
 
static final String QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
 
static final String QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
 
static final String QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
 
static final String QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
 
static final String QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 
static final String QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 
static final String QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 
static final String QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 
static final String QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
 
static final String QR_SUBMIT_ORDER = "SUBMIT-ORDER"
 
static final String QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 
static final String QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 
static final String QR_SERVICE_CONTROL = "SERVICE-CONTROL"
 
static final String QR_LOAD_SERVICE = "LOAD-SERVICE"
 
static final String QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
 
static final String QR_RESET_SERVICE = "RESET-SERVICE"
 
static final String QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
 
static final String QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
 
static final String QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
 
static final String QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
 
static final String QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
 
static final String QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
 
static final String QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 
static final String QR_USER_CONTROL = "USER-CONTROL"
 
static final String QR_RELOAD_RBAC = "RELOAD-RBAC"
 
static final String QR_ADD_USER = "ADD-USER"
 
static final String QR_MODIFY_USER = "MODIFY-USER"
 
static final String QR_DELETE_USER = "DELETE-USER"
 
static final String QR_ADD_PERMISSION = "ADD-PERMISSION"
 
static final String QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
 
static final String QR_DELETE_PERMISSION = "DELETE-PERMISSION"
 
static final String QR_ADD_ROLE = "ADD-ROLE"
 
static final String QR_MODIFY_ROLE = "MODIFY-ROLE"
 
static final String QR_DELETE_ROLE = "DELETE-ROLE"
 
static final String QR_OPTION_CONTROL = "OPTION-CONTROL"
 
static final String QR_LOGGER_CONTROL = "LOGGER-CONTROL"
 
static final String QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 
static final String QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 
static final String QR_DELETE_LOGGER = "DELETE-LOGGER"
 
static final String QR_CREATE_LOGGER = "CREATE-LOGGER"
 
static final String QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
 
static final String QR_READ_DATASOURCE = "READ-DATASOURCE"
 
static final String QR_ADD_DATASOURCE = "ADD-DATASOURCE"
 
static final String QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
 
static final String QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
 
static final String QR_RESET_DATASOURCE = "RESET-DATASOURCE"
 
static final String QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
 
static final String QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
 
static final String QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
 
static final String QR_SQLUTIL_READ = "SQLUTIL-READ"
 
static final String QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
 
static final String QR_GROUP_CONTROL = "GROUP-CONTROL"
 
static final String QR_ADD_GROUP = "ADD-GROUP"
 
static final String QR_MODIFY_GROUP = "MODIFY-GROUP"
 
static final String QR_DELETE_GROUP = "DELETE-GROUP"
 
static final String QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
 
static final String QR_SERVER_CONTROL = "SERVER-CONTROL"
 
static final String QR_SET_PROPERTY = "SET-PROPERTY"
 
static final String QR_DELETE_PROPERTY = "DELETE-PROPERTY"
 
static final String QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
 
static final String QR_START_LISTENER = "START-LISTENER"
 
static final String QR_STOP_LISTENER = "STOP-LISTENER"
 
static final String QR_JOB_CONTROL = "JOB-CONTROL"
 
static final String QR_RUN_JOB = "RUN-JOB"
 
static final String QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
 
static final String QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
 
static final String QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
 
static final String QR_RESET_JOB = "RESET-JOB"
 
static final String QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
 
static final String QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 
static final String QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
 
static final String QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
 
static final String QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
 
static final String QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
 
static final String QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
 
static final String QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
 
static final String QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
 
static final String QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
 
static final String QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
 
static final String QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
 
static final String QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 
static final String QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 
static final String QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 
static final String QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
 
static final String QR_FILESYSTEM_READ = "FILESYSTEM-READ"
 
static final String QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
 
static final String QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 
static final String QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 
static final String QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 
static final String QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 
static final String QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 
static final String QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 
static final String QR_CREATE_SLA = "CREATE-SLA"
 
static final String QR_DELETE_SLA = "DELETE-SLA"
 
static final String QR_MODIFY_SLA = "MODIFY-SLA"
 
static final String QR_SLA_CONTROL = "SLA-CONTROL"
 
static final String QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 
static final String QR_REMOTE_DEPLOYMENT = "REMOTE-DEPLOYMENT"
 
static final String QR_REMOTE_DELETE_INTERFACE = "REMOTE-DELETE-INTERFACE"
 
static final String QR_REMOTE_RELEASE = "REMOTE-RELEASE"
 
static final String QR_KILL_PROCESS = "KILL-PROCESS"
 
static final String QR_DATA_PROVIDER_CONTROL = "DATA-PROVIDER-CONTROL"
 
static final String QR_DATA_PROVIDER_CREATE = "DATA-PROVIDER-CREATE"
 
static final String QR_DATA_PROVIDER_READ = "DATA-PROVIDER-READ"
 
static final String QR_DATA_PROVIDER_UPDATE = "DATA-PROVIDER-UPDATE"
 
static final String QR_DATA_PROVIDER_DELETE = "DATA-PROVIDER-DELETE"
 
static final String QR_TYPE_CACHE_CONTROL = "TYPE-CACHE-CONTROL"
 
static final String QR_TYPE_CACHE_RELOAD = "TYPE-CACHE-RELOAD"
 
static final String QR_TYPE_CACHE_CREATE = "TYPE-CACHE-CREATE"
 
static final String QR_TYPE_CACHE_DELETE = "TYPE-CACHE-DELETE"
 
static final int QE_CLASS_SYSTEM = 101
 
static final int QE_CLASS_WORKFLOW = 102
 
static final int QE_CLASS_SERVICE = 103
 
static final int QE_CLASS_USER = 104
 
static final int QE_CLASS_JOB = 105
 
static final int QE_CLASS_ALERT = 106
 
static final int QE_CLASS_GROUP = 107
 
static final int QE_CLASS_CONNECTION = 108
 
static final int QE_CLASS_PROCESS = 109
 
static final int QE_CLASS_CLUSTER = 110
 
static final int QE_CLASS_LOGGER = 111
 
static final int QE_CLASS_CONFIG_ITEM = 112
 
static final Map< Integer, StringQE_MAP_CLASS
 
static final int QEC_SYSTEM_STARTUP = 1001
 
static final int QEC_SYSTEM_SHUTDOWN = 1002
 
static final int QEC_SYSTEM_ERROR = 1003
 
static final int QEC_SYSTEM_HEALTH_CHANGED = 1004
 
static final int QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 
static final int QEC_GROUP_STATUS_CHANGED = 1101
 
static final int QEC_WORKFLOW_START = 2001
 
static final int QEC_WORKFLOW_STOP = 2002
 
static final int QEC_WORKFLOW_CACHE_RESET = 2003
 
static final int QEC_WORKFLOW_DATA_SUBMITTED = 2004
 
static final int QEC_WORKFLOW_DATA_ERROR = 2005
 
static final int QEC_WORKFLOW_DATA_RELEASED = 2006
 
static final int QEC_WORKFLOW_DATA_CACHED = 2007
 
static final int QEC_WORKFLOW_INFO_CHANGED = 2008
 
static final int QEC_WORKFLOW_STATUS_CHANGED = 2009
 
static final int QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 
static final int QEC_WORKFLOW_PERFORMANCE = 2011
 
static final int QEC_WORKFLOW_DATA_LOCKED = 2012
 
static final int QEC_WORKFLOW_DATA_UNLOCKED = 2013
 
static final int QEC_WORKFLOW_DATA_UPDATED = 2014
 
static final int QEC_WORKFLOW_STATS_UPDATED = 2015
 
static final int QEC_WORKFLOW_RECOVERED = 2016
 
static final int QEC_WORKFLOW_UPDATED = 2017
 
static final int QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 
static final int QEC_SERVICE_START = 3001
 
static final int QEC_SERVICE_STOP = 3002
 
static final int QEC_SERVICE_ERROR = 3003
 
static final int QEC_SERVICE_AUTOSTART_CHANGE = 3004
 
static final int QEC_SERVICE_METHOD_PERFORMANCE = 3005
 
static final int QEC_SERVICE_UPDATED = 3006
 
static final int QEC_JOB_START = 4001
 
static final int QEC_JOB_STOP = 4002
 
static final int QEC_JOB_ERROR = 4003
 
static final int QEC_JOB_INSTANCE_START = 4004
 
static final int QEC_JOB_INSTANCE_STOP = 4005
 
static final int QEC_JOB_RECOVERED = 4006
 
static final int QEC_JOB_UPDATED = 4007
 
static final int QEC_CONFIG_ITEM_CHANGED = 4100
 
static final int QEC_ALERT_ONGOING_RAISED = 5006
 
static final int QEC_ALERT_ONGOING_CLEARED = 5007
 
static final int QEC_ALERT_TRANSIENT_RAISED = 5008
 
static final int QEC_CONNECTION_UP = 5101
 
static final int QEC_CONNECTION_DOWN = 5102
 
static final int QEC_CONNECTION_ENABLED_CHANGE = 5103
 
static final int QEC_CONNECTION_CREATED = 5104
 
static final int QEC_CONNECTION_UPDATED = 5105
 
static final int QEC_CONNECTION_DELETED = 5106
 
static final int QEC_CONNECTIONS_RELOADED = 5107
 
static final int QEC_CONNECTION_DEBUG_DATA_CHANGE = 5108
 
static final int QEC_LOGGER_CREATED = 5200
 
static final int QEC_LOGGER_UPDATED = 5201
 
static final int QEC_LOGGER_DELETED = 5202
 
static final int QEC_APPENDER_CREATED = 5203
 
static final int QEC_APPENDER_DELETED = 5204
 
static final int QEC_APPENDER_UPDATED = 5205
 
static final int QEC_PROCESS_STARTED = 6001
 
static final int QEC_PROCESS_STOPPED = 6002
 
static final int QEC_PROCESS_START_ERROR = 6003
 
static final int QEC_PROCESS_MEMORY_CHANGED = 6004
 
static final int QEC_NODE_INFO = 7001
 
static final int QEC_USER_EVENT = 9001
 
static final Map< Integer, StringQE_MAP_EVENT
 
static final int QSE_OK = 0
 
static final int QSE_NO_INSTANCE_KEY = 1
 
static final int QSE_INVALID_DB_MAX_THREADS = 2
 
static final int QSE_DATASOURCE = 3
 
static final int QSE_LOG_ERROR = 4
 
static final int QSE_RBAC_ERROR = 5
 
static final int QSE_EVENT_ERROR = 6
 
static final int QSE_SESSION_ERROR = 7
 
static final int QSE_COMMAND_LINE_ERROR = 8
 
static final int QSE_OPTION_ERROR = 9
 
static final int QSE_VERSION_ONLY = 10
 
static final int QSE_STARTUP_ERROR = 99
 
static final int DefaultOrderPriority = 500
 
static final String JS_Complete = "COMPLETE"
 
static final String JS_InProgress = "IN-PROGRESS"
 
static final String JS_Error = "ERROR"
 
static final String JS_Crash = "CRASH"
 
static final String SQL_JS_Complete = "C"
 
static final String SQL_JS_InProgress = "I"
 
static final String SQL_JS_Error = "E"
 
static final String SQL_JS_Crash = "Z"
 
static final Map< String, StringJSMap
 
static final Map< String, StringSQLJSMap
 
static final int AE_USER_EVENT = 1
 
static final int AE_SYSTEM_STARTUP = 2
 
static final int AE_SYSTEM_SHUTDOWN = 3
 
static final int AE_SYSTEM_RECOVERY_START = 4
 
static final int AE_SYSTEM_RECOVERY_COMPLETE = 5
 
static final int AE_WORKFLOW_STATUS_CHANGE = 6
 
static final int AE_WORKFLOW_START = 7
 
static final int AE_WORKFLOW_STOP = 8
 
static final int AE_SERVICE_START = 9
 
static final int AE_SERVICE_STOP = 10
 
static final int AE_JOB_START = 11
 
static final int AE_JOB_STOP = 12
 
static final int AE_JOB_INSTANCE_START = 13
 
static final int AE_JOB_INSTANCE_STOP = 14
 
static final int AE_API_CALL = 15
 
static final int AE_JOB_RECOVERY = 16
 
static final int AE_WORKFLOW_DATA_CREATED = 17
 
static final int AE_ALERT_ONGOING_RAISED = 18
 
static final int AE_ALERT_ONGOING_CLEARED = 19
 
static final int AE_ALERT_TRANSIENT_RAISED = 20
 
static final int AE_SOURCE_FILE_LOADED = 21
 
static final int AE_GROUP_STATUS_CHANGED = 22
 
static final String AES_USER_EVENT = "USER-EVENT"
 
static final String AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
 
static final String AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
 
static final String AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
 
static final String AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
 
static final String AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
 
static final String AES_WORKFLOW_START = "WORKFLOW-START"
 
static final String AES_WORKFLOW_STOP = "WORKFLOW-STOP"
 
static final String AES_SERVICE_START = "SERVICE-START"
 
static final String AES_SERVICE_STOP = "SERVICE-STOP"
 
static final String AES_JOB_START = "JOB-START"
 
static final String AES_JOB_STOP = "JOB-STOP"
 
static final String AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
 
static final String AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
 
static final String AES_API_CALL = "API-CALL"
 
static final String AES_JOB_RECOVERY = "JOB-RECOVERY"
 
static final String AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
 
static final String AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
 
static final String AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
 
static final String AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
 
static final String AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
 
static final String AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
 
static final Map< Integer, StringAuditEventMap
 
static final Map< String, Integer > AuditEventCodeMap
 
static final String AO_SYSTEM = "system"
 
static final String AO_WORKFLOWS = "workflows"
 
static final String AO_WORKFLOW_DATA = "workflow-data"
 
static final String AO_JOBS = "jobs"
 
static final String AO_JOB_DATA = "job-data"
 
static final String AO_SERVICES = "services"
 
static final String AO_API = "api"
 
static final String AO_USER_EVENTS = "user-events"
 
static final String AO_OLOAD_EVENTS = "oload"
 
static final String AO_ALERT_EVENTS = "alerts"
 
static final String AO_GROUP_EVENTS = "groups"
 
static final int AOC_SYSTEM = (1 << 0)
 
static final int AOC_WORKFLOWS = (1 << 1)
 
static final int AOC_WORKFLOW_DATA = (1 << 2)
 
static final int AOC_JOBS = (1 << 3)
 
static final int AOC_JOB_DATA = (1 << 4)
 
static final int AOC_SERVICES = (1 << 5)
 
static final int AOC_API = (1 << 6)
 
static final int AOC_USER_EVENTS = (1 << 7)
 
static final int AOC_OLOAD_EVENTS = (1 << 8)
 
static final int AOC_ALERT_EVENTS = (1 << 9)
 
static final int AOC_GROUP_EVENTS = (1 << 10)
 
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)
 
static final Map< String, Integer > AuditOptionMap
 
static final Map< Integer, StringAuditCodeMap
 

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
UserApi::callNetworkApiArgsWithAuthentication()
UserApi::callNetworkApiArgs()
UserApi::callNetworkApi()

◆ 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
UserApi::callNetworkApiArgsWithAuthentication()
UserApi::callNetworkApiArgs()
UserApi::callNetworkApi()

◆ 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
testAuthorization()

◆ 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
testAuthorization()

◆ 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
testAuthorizationOr()

◆ 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
testAuthorizationOr()

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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
UserApi::getUserContextInfo() for a similar method available in all user contexts

◆ 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

◆ 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

◆ 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/3]

static Object com.qoretechnologies.qorus.service.ServiceApi.getConfigItemValue ( String  item,
HashMap< String, Object local_context,
boolean  expand_complex_values 
) 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)
expand_complex_valuesif true then lists and hashes will have their string values expanded recursively
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/3]

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() [3/3]

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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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
OMQ::UserApi::Service::ServiceApi::getOption()
setOption()

◆ 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
OMQ::UserApi::Service::ServiceApi::getOption()
setOption()

◆ 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
getResourceData()
getResourceWsdl()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
getResourceData()
getResourceWsdl()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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()
getResourceWsdl()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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()
getResource()
getResourceWsdl()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
getResourceData()
getResource()
getResourceWsdl()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
getResourceHash()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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
saveStateData()
JobApi::getStateData()
JobApi::saveStateData()
GET /api/latest/services/{id_or_name}
PUT /api/latest/services/{id_or_name}?action=setStateData

◆ 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
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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

◆ 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
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ 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
getStateData()
JobApi::saveStateData()
JobApi::getStateData()
GET /api/latest/services/{id_or_name}
PUT /api/latest/services/{id_or_name}?action=setStateData

◆ saveStateData() [2/2]

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

◆ setConfigItemChangeCallback()

static void com.qoretechnologies.qorus.service.ServiceApi.setConfigItemChangeCallback ( ConfigItemValueCallback  callback) throws Throwable
inlinestatic

Set a callback for config item value changes in the service

Example:
class MyService extends QorusService {
private void doSomething(String config_item_name) {
// ...
}
void init() {
ConfigItemValueCallback callback = (String item_name) -> doSomething(item_name);
}
}
Parameters
callbackthe callback in the service; must take a single string argument giving the name of the config item whose value was updated
Note
The callback is executed asynchronously to the update; there can be a lag between the actual update and the delivery of the message from qorus-core to the remote process (if the interface is running remotely), also the callback is always run in a background thread that is unsynchronized with the change of the config item value; keep these facts in mind when writing code that reacts to config item value updates.
Since
Qorus 4.1

◆ 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
OMQ::UserApi::Service::ServiceApi::setOption()
getOption()

◆ 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
OMQ::UserApi::Service::ServiceApi::setOption()
getOption()

◆ 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
OMQ::UserApi::Service::ServiceApi::sleep()
usleep()

◆ 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
stopListener()
stopListenerId()

◆ 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
stopListener()
stopListenerId()

◆ 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
stopListener()
stopListenerId()

◆ 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()
stopListenerId()

◆ 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
startListeners()
stopListenerId()

◆ 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
startListeners()

◆ 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
ServiceApi::testAuthorization()
checkAuthorization()

◆ 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
checkAuthorization()

◆ 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
checkAuthorizationOr()

◆ 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
checkAuthorizationOr()

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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 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)
See also
tryGetResourceData()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ tryGetResource() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.tryGetResource ( 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 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
Returns
null if the resource does not exist or 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)
See also
tryGetResourceData()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ tryGetResource() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.tryGetResource ( 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 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
Returns
null if the resource does not exist or a hash with the following keys:
  • code: the HTTP response code; with 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)
See also
tryGetResourceData()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ tryGetResourceData() [1/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.tryGetResourceData ( 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 null is returned

Example:
*binary img = UserApi::tryGetResourceData("image.jpg", cx);
Parameters
namethe name of the resource
ctxan optional argument hash to the template code
Returns
null if the file resource does not exist or the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned
See also
tryGetResource()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ tryGetResourceData() [2/2]

static Object com.qoretechnologies.qorus.service.ServiceApi.tryGetResourceData ( 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 null is returned

Example:
*binary img = UserApi::tryGetResourceData("image.jpg");
Parameters
namethe name of the resource
Returns
null if the file resource does not exist or the given text or binary file resource as its native type; if a template exists, then the template is rendered and returned
See also
tryGetResource()
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ tryGetWfDynamicData()

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

Return the dynamic data hash for the current workflow order if the service call was made from a workflow order, otherwise return null

◆ tryGetWfStaticData()

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

Return the static data hash for the current workflow order if the service call was made from a workflow order, otherwise return null

◆ tryGetWfTempData()

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

Return the temp data hash for the current workflow order if the service call was made from a workflow order, otherwise return null

◆ tryRenderTemplate()

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

Render a template file resource and returns the rendered template if the template exists, otherwise returns null

Example:
*HashMap<String, Object> h = ServiceApi::tryRenderTemplate(name, ctx);
Parameters
namethe template file resource name
ctxthe argument hash to the template code
Returns
null if the template does not exist or 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)
See also
Service File Resources
bindHttp()
OMQ::AbstractServiceHttpHandler

◆ usleep() [1/2]

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

Puts the current thread to sleep for a certain number of microseconds

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 sleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe number of microseconds to sleep (1 microsecond = 1/1000000 of a second)
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
OMQ::UserApi::Service::ServiceApi::usleep()
sleep()

◆ usleep() [2/2]

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

Puts the current thread to sleep for a certain number of microseconds

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 sleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe amount of time in microseconds to sleep (1 microsecond = 1/1000000 of a second)
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
OMQ::UserApi::Service::ServiceApi::usleep()
sleep()

◆ waitForEvents() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.service.ServiceApi.waitForEvents ( int  min_id,
int  timeout_ms 
) throws Throwable
inlinestatic

Return available system events

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
timeout_msoptional timeout waiting for events; if 0; the method returns immediately
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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEvents() [2/3]

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

Return available system events with no timeout; this method call returns immediately

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEvents() [3/3]

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

Return available system events

by default without any arguments will immediately return all available events in the cache

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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsAnd() [1/3]

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

Return system events that meet all of the given criteria or none of the optional "or not" criteria

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
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
timeout_msoptional timeout waiting for events; if not present or 0; the method returns immediately
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 fourth 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 fourth 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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsAnd() [2/3]

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

Return system events that meet all of the given criteria or none of the optional "or not" criteria

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
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
timeout_msoptional timeout waiting for events; if not present or 0; the method returns immediately
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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsAnd() [3/3]

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

Return system events that meet all of the given criteria

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsOr() [1/3]

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

Return system events that meet any of the given criteria and none of the optional "and not" criteria

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
filterthis argument is the criteria list for "logical or" comparisons to be applied to the events. If a system 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 fourth 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
timeout_msoptional timeout waiting for events; if not present or 0; the method returns immediately
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 fourth 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 fourth 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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsOr() [2/3]

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

Return system events that meet any of the given criteria and none of the optional "and not" criteria

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
filterthis argument is the criteria list for "logical or" comparisons to be applied to the events. If a system 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 fourth 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
timeout_msoptional timeout waiting for events; if not present or 0; the method returns immediately
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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

◆ waitForEventsOr() [3/3]

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

Return system events that meet any of the given criteria; this method returns immediately

Parameters
min_idthe minimum event ID to return; no event wil be returned that has an event ID less than this; the first event ID is always 1 (if min_id <= 1 then all events are returned that meet the given criteria)
filterthis argument is the criteria list for "logical or" comparisons to be applied to the events. If a system 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 fourth 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-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
Note
It is not recommended to use this API in remote services, as high-volume message processing can have a negative impact on a Qorus cluster as a whole

The documentation for this class was generated from the following file: