Qorus Integration Engine®  5.0.3_git
com.qoretechnologies.qorus.job.JobApi Class Reference
Inheritance diagram for com.qoretechnologies.qorus.job.JobApi:
com.qoretechnologies.qorus.UserApi com.qoretechnologies.qorus.OMQ com.qoretechnologies.qorus.job.QorusJob

Static Public Member Methods

static void err (String err, String desc_fmt, Object... args) throws Throwable
 
static void errWithInfo (String err, String desc, Object info, String severity, boolean business) throws Throwable
 
static void errWithInfo (String err, String desc, Object info, String severity) throws Throwable
 
static void errWithInfo (String err, String desc, Object info) throws Throwable
 
static void errWithInfo (String err, Object info) throws Throwable
 
static void warn (String err, String desc_fmt, Object... args) throws Throwable
 
static void warnWithInfo (String err, String desc, Object info, boolean business) throws Throwable
 
static void warnWithInfo (String err, String desc, Object info) throws Throwable
 
static void warnWithInfo (String err, Object info) throws Throwable
 
static void saveInfo (Object info) throws Throwable
 
static void saveInfoPath (String path, Object value) throws Throwable
 saves information against the job instance in the database More...
 
static HashMap< String, ObjectgetInfo () throws Throwable
 
static void saveStateData (HashMap< String, Object > data) throws Throwable
 
static void saveStateDataPath (String path, Object value) throws Throwable
 serializes the given hash and stores against the job's state data in JOB_STATE_DATA More...
 
static HashMap< String, ObjectgetStateData () throws Throwable
 
static void savePersistentStateData (HashMap< String, Object > data) throws Throwable
 
static void savePersistentStateDataPath (String path, Object value) throws Throwable
 serializes the given hash and stores against the job's state data in JOB_PERSISTENT_STATE_DATA More...
 
static void clearPersistentStateData () throws Throwable
 
static HashMap< String, ObjectgetPersistentStateData () throws Throwable
 
static boolean setTrigger (ZonedDateTime ts) 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 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 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 Object getInterfaceConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getInterfaceConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getInterfaceConfigItemValue (String item) throws Throwable
 
static HashMap< String, ObjectgetInterfaceConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectgetInterfaceConfigItemHash () 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
 
static Object executeFsm (String name, Object arg) throws Throwable
 Executes the given Finite State Machine and returns the final output. More...
 
static Object executeFsm (String name) throws Throwable
 Executes the given Finite State Machine and returns the final output. More...
 
static void registerFsmAsObserver (String fsm_name, Observable observable, String event_id) throws Throwable
 Registers the given FSM with the given object as an Observer. More...
 

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_SERVICE_OPTION_CONTROL = "SERVICE-OPTION-CONTROL"
 
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_JOB_OPTION_CONTROL = "JOB-OPTION-CONTROL"
 
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_REMOTE_EXEC_ALL = "REMOTE-EXEC-ALL"
 
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 String QR_SET_FSM_CONFIG = "SET-FSM-CONFIG"
 Finite State Machine System Permission: "SET-FSM-CONFIG". More...
 
static final String QR_SET_PIPELINE_CONFIG = "SET-PIPELINE-CONFIG"
 Pipeline System Permission: "SET-PIPELINE-CONFIG". More...
 
static final String QR_UPLOAD = "UPLOAD"
 #! Remote Command System Permission: "UPLOAD" More...
 
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_NODE_REMOVED = 7002
 Qorus Event Code: NODE_REMOVED. More...
 
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 job API class

Member Function Documentation

◆ clearPersistentStateData()

static void com.qoretechnologies.qorus.job.JobApi.clearPersistentStateData ( ) throws Throwable
inlinestatic

Clears the job's state data in JOB_PERSISTENT_STATE_DATA

Note
unlike job state data, job persistent state data is stored persistently across job runs
See also
getPersistentStateData()
savePersistentStateData()
Since
Qorus 4.1.2

◆ err()

static void com.qoretechnologies.qorus.job.JobApi.err ( String  err,
String  desc_fmt,
Object...  args 
) throws Throwable
inlinestatic

Raises an error in a running job; does not affect the flow of execution in the job code

The error information is stored in the job_errors table with a severity of OMQ.ES_Major and the business flag set to true

Parameters
errthe error code
desc_fmtthe format specifier for the warning description string; following arguments will be included in the description string as combined with vsprintf()
argsthe args for desc_fmt
Since
Qorus 3.1.0
See also
OMQ::UserApi::Job::JobApi::err()
errWithInfo()
warn()
warnWithInfo()

◆ errWithInfo() [1/4]

static void com.qoretechnologies.qorus.job.JobApi.errWithInfo ( String  err,
Object  info 
) throws Throwable
inlinestatic

Raises an error in a running job; does not affect the flow of execution in the job code

The error information is stored to the job_errors table, errors errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings

Parameters
errthe error code
infoadditional information to be saved with the error (data structures are serialized in YAML format and saved in the database)
See also
OMQ::UserApi::Job::JobApi::errWithInfo()
err()
warn()
warnWithInfo()

◆ errWithInfo() [2/4]

static void com.qoretechnologies.qorus.job.JobApi.errWithInfo ( String  err,
String  desc,
Object  info 
) throws Throwable
inlinestatic

Raises an error in a running job; does not affect the flow of execution in the job code

The error information is stored to the job_errors table, errors errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings

Parameters
errthe error code
desca description for the error
infoadditional information to be saved with the error (data structures are serialized in YAML format and saved in the database)
See also
OMQ::UserApi::Job::JobApi::errWithInfo()
err()
warn()
warnWithInfo()

◆ errWithInfo() [3/4]

static void com.qoretechnologies.qorus.job.JobApi.errWithInfo ( String  err,
String  desc,
Object  info,
String  severity 
) throws Throwable
inlinestatic

Raises an error in a running job; does not affect the flow of execution in the job code

The error information is stored to the job_errors table, errors errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings

Parameters
errthe error code
desca description for the error
infoadditional information to be saved with the error (data structures are serialized in YAML format and saved in the database)
severitythe severity of the error, errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings; see Java Error Severity Codes for valid values (default = OMQ.ES_Major)
Note
If the severity is less than or equal to OMQ.ES_Warning, the job instance does not get an OMQ.JS_Error status
See also
OMQ::UserApi::Job::JobApi::errWithInfo()
err()
warn()
warnWithInfo()

◆ errWithInfo() [4/4]

static void com.qoretechnologies.qorus.job.JobApi.errWithInfo ( String  err,
String  desc,
Object  info,
String  severity,
boolean  business 
) throws Throwable
inlinestatic

Raises an error in a running job; does not affect the flow of execution in the job code

The error information is stored to the job_errors table, errors errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings

Parameters
errthe error code
desca description for the error
infoadditional information to be saved with the error (data structures are serialized in YAML format and saved in the database)
severitythe severity of the error, errors with a severity less than or equal to OMQ.ES_Warning are treated as warnings; see Java Error Severity Codes for valid values (default = OMQ.ES_Major)
businessset to true if the error represents a business error
Note
If the severity is less than or equal to OMQ.ES_Warning, the job instance does not get an OMQ.JS_Error status
See also
OMQ::UserApi::Job::JobApi::errWithInfo()
err()
warn()
warnWithInfo()

◆ getConfigItemHash() [1/2]

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

Returns a hash of all configuration items for the current job as a combination of local and global configuration items

Example:
HashMap<String, Object> config = JobApi.getConfigItemHash();
Returns
a hash of all configuration items for the current job; keys are config item names; values are config item values. If there are no config items for the current job, 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
Job Configuration Items

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getConfigItemHash() [2/2]

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

Returns a hash of all configuration items for the current job as a combination of local and global configuration items

Example:
HashMap<String, Object> config = JobApi.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 job; keys are config item names; values are config item values. If there are no config items for the current job, 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
Job Configuration Items

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getConfigItemValue() [1/3]

static Object com.qoretechnologies.qorus.job.JobApi.getConfigItemValue ( String  item) throws Throwable
inlinestatic

Returns the value of the given configuration item for the current job

Example:
Object val = JobApi.getConfigItemValue(item);
Parameters
itemthe name of the job configuration item; job 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 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
Job Configuration Items

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getConfigItemValue() [2/3]

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

Returns the value of the given configuration item for the current job

Example:
Object val = JobApi.getConfigItemValue(item, local_context);
Parameters
itemthe name of the job configuration item; job 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 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
Job Configuration Items

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getConfigItemValue() [3/3]

static Object com.qoretechnologies.qorus.job.JobApi.getConfigItemValue ( String  item,
HashMap< String, Object local_context,
boolean  expand_complex_values 
) throws Throwable
inlinestatic

Returns the value of the given configuration item for the current job

Example:
Object val = JobApi.getConfigItemValue(item, local_context);
Parameters
itemthe name of the job configuration item; job 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 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
Job Configuration Items

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.job.JobApi.getInfo ( ) throws Throwable
inlinestatic

Returns a hash of job information about the current job

Returns
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 (NOTHING 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
Note
the data returned here is different from the data stored by job_save_info()
See also
OMQ::UserApi::Job::JobApi::getInfo()
saveInfo()

◆ getOption() [1/3]

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

Returns the value of all job options

Returns
all job-level options are returned as a hash
See also
OMQ::UserApi::Job::JobApi::getOption()
getOptionArgs()
setOption()

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getOption() [2/3]

static Object com.qoretechnologies.qorus.job.JobApi.getOption ( String  key) throws Throwable
inlinestatic

Returns the value of the named job option

If the option is not set on the job, 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()

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getOption() [3/3]

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

Returns the value of the named job option or options

If the option is not set on the job, 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 job-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 NOTHING
See also
OMQ::UserApi::Job::JobApi::getOption()
setOption()

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ getPersistentStateData()

static HashMap<String, Object> com.qoretechnologies.qorus.job.JobApi.getPersistentStateData ( ) throws Throwable
inlinestatic

Returns any job state data stored with savePersistentStateData()

Returns
any job state data stored with savePersistentStateData()
Note
unlike job state data, job persistent state data is stored persistently across job runs
See also
savePersistentStateData()
clearPersistentStateData()
Since
Qorus 4.1.2

◆ getStateData()

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

Returns any job state data stored with saveStateData()

Returns
any job state data stored with saveStateData()
Note
job state data is automatically cleared when a job instance gets a OMQ.StatComplete status
See also
OMQ::UserApi::Job::JobApi::getStateData()
saveStateData()
svc_save_state_data()
GET /api/latest/jobs/{id_or_name}
PUT /api/latest/jobs/{id_or_name}?action=setStateData

◆ saveInfo()

static void com.qoretechnologies.qorus.job.JobApi.saveInfo ( Object  info) throws Throwable
inlinestatic

Saves information against the job instance in the database

The information is serialized in YAML format and saved in the database in the JOB_INSTANCE row as a part of the job results.

This information is returned in the API as the info key in REST Job Result Hash data, for example in the return value to the REST GET /api/latest/jobresults/{id} call.

Parameters
infothe information to save
Note
the data stored here is different from the data returned by job_info()
See also
OMQ::UserApi::Job::JobApi::saveInfo()
getInfo()

◆ saveInfoPath()

static void com.qoretechnologies.qorus.job.JobApi.saveInfoPath ( String  path,
Object  value 
) throws Throwable
inlinestatic

saves information against the job instance in the database

// will assign {"account": {"id": "123456ABC"}}
JobApi.saveInfoPath("account.id", "123456ABC");
Parameters
paththe path to the data to save
valuethe value to merge into existing info data at the given path

The information is serialized in YAML format and saved in the database in the JOB_INSTANCE row as a part of the job results.

This information is returned in the API as the info key in REST Job Result Hash data, for example in the return value to the REST GET /api/latest/jobresults/{id} call.

Note
the data stored here is different from the data returned by getInfo()
Since
Qorus 5.0
See also

◆ savePersistentStateData()

static void com.qoretechnologies.qorus.job.JobApi.savePersistentStateData ( HashMap< String, Object data) throws Throwable
inlinestatic

Serializes the given hash and stores against the job's state data in JOB_PERSISTENT_STATE_DATA

Parameters
datathe state data to serialize and store against the job's state data in JOB_PERSISTENT_STATE_DATA
Note
unlike job state data, job persistent state data is stored persistently across job runs
See also
getPersistentStateData()
clearPersistentStateData()
Since
Qorus 4.1.2

◆ savePersistentStateDataPath()

static void com.qoretechnologies.qorus.job.JobApi.savePersistentStateDataPath ( String  path,
Object  value 
) throws Throwable
inlinestatic

serializes the given hash and stores against the job's state data in JOB_PERSISTENT_STATE_DATA

// will assign {"account": {"id": "123456ABC"}}
JobApi.savePersistentStateDataPath("account.id", "123456ABC");
Parameters
paththe path to the data to save
valuethe value to merge into existing persistent state data at the given path
Note
unlike job state data, job persistent state data is stored persistently across job runs
See also
Since
Qorus 5.0

◆ saveStateData()

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

Serializes the given hash and stores against the job's state data in JOB_STATE_DATA

Parameters
datathe state data to serialize and store against the job's state data in JOB_STATE_DATA
Note
job state data is automatically cleared when a job instance gets a OMQ.StatComplete status
See also
OMQ::UserApi::Job::JobApi::saveStateData()
getStateData()
svc_get_state_data()
GET /api/latest/jobs/{id_or_name}
PUT /api/latest/jobs/{id_or_name}?action=setStateData

◆ saveStateDataPath()

static void com.qoretechnologies.qorus.job.JobApi.saveStateDataPath ( String  path,
Object  value 
) throws Throwable
inlinestatic

serializes the given hash and stores against the job's state data in JOB_STATE_DATA

# will assign {"account": {"id": "123456ABC"}}
JobApi.saveStateDataPath("account.id", "123456ABC");
Parameters
paththe path to the data to save
valuethe value to merge into existing persistent state data at the given path
Note
job state data is automatically cleared when a job instance gets a OMQ.StatComplete status
See also
Since
Qorus 5.0

◆ setOption() [1/2]

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

Changes option values on a job

If the job has defined job options, and at least one invalid option is passed to the method, an exception will be raised; however all other valid options in the hash will be set before the exception is raised

Parameters
optsa hash of option-value pairs
Exceptions
JOB-OPTION-ERRORinvalid option name
See also
OMQ::UserApi::Job::JobApi::setOption()
getOption()
getOptionArgs()

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ setOption() [2/2]

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

Changes a single option value on a job

If the job has defined job options and an invalid option is passed to the method, an exception will be raised.

Parameters
optionthe option to set
valuethe value to set for the option
Exceptions
JOB-OPTION-ERRORinvalid option name
See also
OMQ::UserApi::Job::JobApi::setOption()
getOption()
getOptionArgs()

Reimplemented from com.qoretechnologies.qorus.UserApi.

◆ setTrigger()

static boolean com.qoretechnologies.qorus.job.JobApi.setTrigger ( ZonedDateTime  ts) throws Throwable
inlinestatic

Sets a one-time custom trigger time for the job; returns true if set, false if ignored

Parameters
tsthe timestamp to trigger the job; must be in the future and before the next trigger time
Returns
true if set, false if ignored; the call will be ignored if the date/time value is in the past or after the next scheduled job trigger time
Note
when this API returns with a true return value, the job's custom trigger time has already been committed to the database
See also
OMQ::UserApi::Job::JobApi::setTrigger()

◆ sleep()

static int com.qoretechnologies.qorus.job.JobApi.sleep ( int  arg) throws Throwable
inlinestatic

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

If the job 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::Job::JobApi::sleep()
usleep()

◆ usleep() [1/2]

static int com.qoretechnologies.qorus.job.JobApi.usleep ( int  arg) throws Throwable
inlinestatic

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

If the job 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::Job::JobApi::usleep()
sleep()

◆ usleep() [2/2]

static int com.qoretechnologies.qorus.job.JobApi.usleep ( QoreRelativeTime  arg) throws Throwable
inlinestatic

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

If the job 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::Job::JobApi::usleep()
sleep()

◆ warn()

static void com.qoretechnologies.qorus.job.JobApi.warn ( String  err,
String  desc_fmt,
Object...  args 
) throws Throwable
inlinestatic

Raises a warning in a running job; does not affect the flow of execution in the job code

The warning information is stored to the job_errors table with a severity of OMQ.ES_Warning and the business flag set to true

Parameters
errthe warning or error code
desc_fmtthe format specifier for the warning description string; following arguments will be included in the description string as combined with vsprintf()
argsthe args for desc_fmt
See also
OMQ::UserApi::Job::JobApi::warn()
job_warn()
warnWithInfo()
err()
errWithInfo()

◆ warnWithInfo() [1/3]

static void com.qoretechnologies.qorus.job.JobApi.warnWithInfo ( String  err,
Object  info 
) throws Throwable
inlinestatic

Raises a warning in a running job; does not affect the flow of execution in the job code

The warning information is stored to the job_errors table with a severity of OMQ.ES_Warning

Parameters
errthe warning or error code
infoadditional information to be saved with the warning (data structures are serialized in YAML format and saved in the database)
See also
OMQ::UserApi::Job::JobApi::warnWithInfo()
warn()
err()
errWithInfo()

◆ warnWithInfo() [2/3]

static void com.qoretechnologies.qorus.job.JobApi.warnWithInfo ( String  err,
String  desc,
Object  info 
) throws Throwable
inlinestatic

Raises a warning in a running job; does not affect the flow of execution in the job code

The warning information is stored to the job_errors table with a severity of OMQ.ES_Warning

Parameters
errthe warning or error code
desca description for the warning
infoadditional information to be saved with the warning (data structures are serialized in YAML format and saved in the database)
See also
OMQ::UserApi::Job::JobApi::warnWithInfo()
warn()
err()
errWithInfo()

◆ warnWithInfo() [3/3]

static void com.qoretechnologies.qorus.job.JobApi.warnWithInfo ( String  err,
String  desc,
Object  info,
boolean  business 
) throws Throwable
inlinestatic

Raises a warning in a running job; does not affect the flow of execution in the job code

The warning information is stored to the job_errors table with a severity of OMQ.ES_Warning

Parameters
errthe warning or error code
desca description for the warning
infoadditional information to be saved with the warning (data structures are serialized in YAML format and saved in the database)
businessset to true if the warning represents a business warning
See also
OMQ::UserApi::Job::JobApi::warnWithInfo()
warn()
err()
errWithInfo()

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