OMQ::UserApi::Service::ServiceApi Class Reference

primary service API class More...

Inheritance diagram for OMQ::UserApi::Service::ServiceApi:

Collaboration diagram for OMQ::UserApi::Service::ServiceApi:

Static Public Member Methods
static	checkAuthorization (...)
	checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized
static	checkAuthorizationArgs (softlist< string > args)
	checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized
static	checkAuthorizationOr (...)
	checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized
static	checkAuthorizationOrArgs (softlist< string > args)
	checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized
static bool	testAuthorization (...)
	tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testAuthorizationArgs (softlist< string > args)
	tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testAuthorizationOr (...)
	tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testAuthorizationOrArgs (softlist< string > args)
	tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static	checkWorkflowAccess (list< auto > ids)
	checks if the current user has access to the given list of workflow IDs; throws an exception if the user is not authorized
static	checkWorkflowAccess (softint id)
	checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized
static bool	testWorkflowAccess (list< auto > ids)
	tests if the current user has access to the given list of workflow IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testWorkflowAccess (softint id)
	tests if the current user has access to the given single workflow ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getWorkflowAccessList ()
	returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getWorkflowAccessHash ()
	returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkWorkflowInstanceAccess (softstring wfiid)
	checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized
static	checkServiceAccess (list< auto > ids)
	checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized
static	checkServiceAccess (softint id)
	checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized
static	checkQueueAccess (softint queueid, string key)
	checks if the current user has access to the given queue entry (as determined through the workflow access list); throws an exception if the user is not authorized
static bool	testServiceAccess (list< auto > ids)
	tests if the current user has access to the given list of serviceids and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testServiceAccess (softint id)
	tests if the current user has access to the given single serviceid and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getServiceAccessList ()
	returns a list of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned
static *hash< auto >	getServiceAccessHash ()
	returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned
static	checkJobAccess (list< auto > ids)
	checks if the current user has access to the given list of job IDs; throws an exception if the user is not authorized
static	checkJobAccess (softint id)
	checks if the current user has access to the given single job ID; throws an exception if the user is not authorized
static bool	testJobAccess (list< auto > ids)
	tests if the current user has access to the given list of job IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testJobAccess (softint id)
	tests if the current user has access to the given single job ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getJobAccessList ()
	returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getJobAccessHash ()
	returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkJobInstanceAccess (softstring jiid)
	checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized
static	checkMapperAccess (list< auto > ids)
	checks if the current user has access to the given list of mapper IDs; throws an exception if the user is not authorized
static	checkMapperAccess (softint id)
	checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized
static bool	testMapperAccess (list< auto > ids)
	tests if the current user has access to the given list of mapper IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testMapperAccess (softint id)
	tests if the current user has access to the given single mapper ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getMapperAccessList ()
	returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getMapperAccessHash ()
	returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkVmapAccess (list< auto > ids)
	checks if the current user has access to the given list of value map IDs; throws an exception if the user is not authorized
static	checkVmapAccess (softint id)
	checks if the current user has access to the given single value map ID; throws an exception if the user is not authorized
static bool	testVmapAccess (list< auto > ids)
	tests if the current user has access to the given list of value map IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testVmapAccess (softint id)
	tests if the current user has access to the given single value map ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getVmapAccessList ()
	returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getVmapAccessHash ()
	returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkFsmAccess (list< softint > ids)
	checks if the current user has access to the given list of Finite State Machines; throws an exception if the user is not authorized
static	checkFsmAccess (string name)
	checks if the current user has access to the given single Finite State Machine; throws an exception if the user is not authorized
static bool	testFsmAccess (list< auto > ids)
	tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testFsmAccess (string name)
	tests if the current user has access to the given single Finite State Machine
static *list< auto >	getFsmAccessList ()
	returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getFsmAccessHash ()
	returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkPipelineAccess (list< auto > ids)
	checks if the current user has access to the given list of data pipelines; throws an exception if the user is not authorized
static	checkPipelineAccess (string name)
	checks if the current user has access to the given single data pipeline; throws an exception if the user is not authorized
static bool	testPipelineAccess (list< auto > ids)
	tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testPipelineAccess (string name)
	tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getPipelineAccessList ()
	returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getPipelineAccessHash ()
	returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkConnectionAccess (int id)
	checks if the current user has access to the given connection; an exception is thrown if not
static	checkConnectionAccess (list< softint > ids)
	checks if the current user has access to the given list of connections; an exception is thrown if not
static bool	testConnectionAccess (list< softint > ids)
	tests if the current user has access to the given list of connections and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testConnectionAccess (int id)
	tests if the current user has access to the given connection and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getConnectionAccessList ()
	returns a list of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getConnectionAccessHash ()
	returns a hash of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserAuthorization (string user)
	checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized
static	checkUserAuthorizationArgs (string user, softlist< string > args)
	checks user authorization for all permissions passed to the method; throws an exception if the user is not authorized
static	checkUserAuthorizationOr (string user)
	checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized
static	checkUserAuthorizationOrArgs (string user, softlist< string > args)
	checks user authorization for at least one of list of permissions passed to the method; throws an exception if the user is not authorized
static bool	testUserAuthorization (string user)
	tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserAuthorizationArgs (string user, softlist< string > args)
	tests user authorization for all of permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserAuthorizationOr (string user)
	tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserAuthorizationOrArgs (string user, softlist< string > args)
	tests user authorization for at least one of the permissions passed to the method and returns True (if authorization is granted) or False (if the user is not authorized)
static	checkUserWorkflowAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of workflow IDs; throws an exception if the user is not authorized
static	checkUserWorkflowAccess (string user, softint id)
	checks if the current user has access to the given single workflow ID; throws an exception if the user is not authorized
static bool	testUserWorkflowAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of workflow IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserWorkflowAccess (string user, softint id)
	tests if the current user has access to the given single workflow ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserWorkflowAccessList (string user)
	returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserWorkflowAccessHash (string user)
	returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserWorkflowInstanceAccess (string user, softstring wfiid)
	checks if the current user has access to the given workflow_instanceid; throws an exception if the user is not authorized
static	checkUserServiceAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of serviceids; throws an exception if the user is not authorized
static	checkUserServiceAccess (string user, softint id)
	checks if the current user has access to the given single serviceid; throws an exception if the user is not authorized
static	checkUserQueueAccess (string user, softint queueid, string key)
	checks if the current user has access to the given queue entry (as determined through the workflow access list); throws an exception if the user is not authorized
static bool	testUserServiceAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of serviceids and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserServiceAccess (string user, softint id)
	tests if the current user has access to the given single serviceid and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserServiceAccessList (string user)
	returns a list of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned
static *hash< auto >	getUserServiceAccessHash (string user)
	returns a hash of service IDs the current user has access to; or, if the current user has access to all services, then NOTHING is returned
static	checkUserJobAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of job IDs; throws an exception if the user is not authorized
static	checkUserJobAccess (string user, softint id)
	checks if the current user has access to the given single job ID; throws an exception if the user is not authorized
static bool	testUserJobAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of job IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserJobAccess (string user, softint id)
	tests if the current user has access to the given single job ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserJobAccessList (string user)
	returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserJobAccessHash (string user)
	returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserJobInstanceAccess (string user, softstring jiid)
	checks if the current user has access to the given job_instanceid; throws an exception if the user is not authorized
static	checkUserMapperAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of mapper IDs; throws an exception if the user is not authorized
static	checkUserMapperAccess (string user, softint id)
	checks if the current user has access to the given single mapper ID; throws an exception if the user is not authorized
static bool	testUserMapperAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of mapper IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserMapperAccess (string user, softint id)
	tests if the current user has access to the given single mapper ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserMapperAccessList (string user)
	returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserMapperAccessHash (string user)
	returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserVmapAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of value map IDs; throws an exception if the user is not authorized
static	checkUserVmapAccess (string user, softint id)
	checks if the current user has access to the given single value map ID; throws an exception if the user is not authorized
static bool	testUserVmapAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of value map IDs and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserVmapAccess (string user, softint id)
	tests if the current user has access to the given single value map ID and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserVmapAccessList (string user)
	returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserVmapAccessHash (string user)
	returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserFsmAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of Finite State Machines; throws an exception if the user is not authorized
static	checkUserFsmAccess (string user, string name)
	checks if the current user has access to the given single Finite State Machine; throws an exception if the user is not authorized
static bool	testUserFsmAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserFsmAccess (string user, string name)
	tests if the current user has access to the given single Finite State Machine and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserFsmAccessList (string user)
	returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserFsmAccessHash (string user)
	returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	checkUserPipelineAccess (string user, list< auto > ids)
	checks if the current user has access to the given list of data pipelines; throws an exception if the user is not authorized
static	checkUserPipelineAccess (string user, string name)
	checks if the current user has access to the given single data pipeline; throws an exception if the user is not authorized
static bool	testUserPipelineAccess (string user, list< auto > ids)
	tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized)
static bool	testUserPipelineAccess (string user, string name)
	tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized)
static *list< auto >	getUserPipelineAccessList (string user)
	returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static *hash< auto >	getUserPipelineAccessHash (string user)
	returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned
static	registerSoapHandler (hash< auto > h)
	registers the current service as a SOAP service and exports its methods that map to SOAP operations in the given WSDL to be called from the Qorus HttpServer with the SOAP protocol
Static Public Member Methods inherited from OMQ::UserApi::UserApi
static *hash< auto >	getUserServiceInfo (string name)
	returns information about the given user service (if it's currently loaded)
static SqlUtil::AbstractTable	getSqlTable (string datasource, string table_name, bool register_dependency=True)
	get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
static SqlUtil::AbstractTable	getSqlTable (AbstractDatasource datasource, string table_name, bool register_dependency=True)
	get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
static hash< auto >	getSqlCacheInfo ()
	get information about cached object
static	clearSqlTableCache (string datasource, *string table_name)
	clears all objects for given datasource from the cache (for example, if database objects have been updated in the dataserver)
static	clearSqlTableCache (AbstractDatasource datasource, *string table_name)
	clears cached objects for given datasource (for example, if database objects have been updated in the dataserver)
static auto	getValueMap (string mapname, string key)
	Gets a lookup value from the value map by a key; the value map must be registered to the current interface.
static list< auto >	getValueMaps ()
	Gets all value maps valid for the current interface.
static bool	postSlaEventSuccess (string sla, number value)
	posts a successful SLA event for SLA monitoring and performance tracking
static bool	postSlaEventError (string sla, number value, string err, string desc)
	posts an unsuccessful SLA event for SLA monitoring and performance tracking
static	flushSlaEvents ()
	flushes all pending SLA events to disk and returns after the data has been committed
static *hash< auto >	getSystemServiceInfo (string name)
	returns information about the given system service (if it's currently loaded)
static *hash< auto >	getServiceInfo (string type, string name)
	returns information about the given service (if it's currently loaded)
static list	getRunningWorkflowList (*string name, *string ver)
	returns a list of hashes giving information about the currently-running workflow execution instances
static hash	getRunningWorkflowInfo (softint id)
	returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not
static softint	createOrder (string name, *string version, hash< auto > params, string status=StatReady)
	creates a workflow order data instance in the database
static softint	createOrder (int wfid, hash< auto > params, string status=StatReady)
	creates a workflow order data instance in the database
static softint	createRemoteOrder (string remote, string name, *string version, hash< auto > params, string status=StatReady, bool register_dependency=True)
	creates a workflow order data instance in a remote Qorus instance
static softint	createRemoteOrder (string remote, int wfid, hash< auto > params, string status=StatReady, bool register_dependency=True)
	creates a workflow order data instance in a remote Qorus instance
static hash< auto >	execSynchronousWorkflow (string name, *string version, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid)
	executes a workflow order synchronously and returns the final status and order ID in a hash
static hash< auto >	execSynchronousWorkflow (int wfid, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid)
	executes a workflow order synchronously and returns the final status and order ID in a hash
static hash< auto >	execSynchronousWorkflowAsync (string name, *string version, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid)
	executes a workflow order synchronously in the background and returns immediately
static hash< auto >	execSynchronousWorkflowAsync (int wfid, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid)
	executes a workflow order synchronously in the background and returns immediately
static int	postUserEvent (string severity, auto info)
	posts an application event of class OMQ::QE_CLASS_USER
static hash	runtimeProperties ()
	returns Qorus runtime properties as a hash
static auto	callNetworkApiArgsWithAuthentication (string user, string pass, string call, softlist< auto > args)
	calls a system RPC API with authentication information (username and password)
static auto	callNetworkApiArgs (string call, *softlist< auto > args)
	calls a system RPC API and returns the respose
static auto	callNetworkApi (string call,...)
	calls a system RPC API and returns the result; the API is called with system permissions (no restrictions)
static auto	callRestApi (string method, string path, *hash< auto > body_args)
	calls a system REST API method and returns the result
static auto	callRestApiWithAuthentication (string user, string pass, string method, string path, *hash< auto > body_args)
	calls a system REST API method with authentication information and returns the result

Public Attributes
const	ServiceCallContextKeys
	keys returned from the cx hash in getCallContext() if present

Static Private:Internal Attributes
static hash< string, hash< auto > >	vpmap
	for saving the request path against a code verifier: verifier -> {path, ts}

Additional Inherited Members
Static Private Member Methods inherited from OMQ::UserApi::UserApi
static QorusProgram	DynamicLogic (True, False, CommonParseOptions|PO_NO_INHERIT_USER_CLASSES|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_INHERIT_USER_CONSTANTS|PO_NO_INHERIT_USER_HASHDECLS|PO_NEW_STYLE|PO_STRICT_ARGS|PO_REQUIRE_TYPES, QorusServerDefines, NOTHING, NOTHING,())
	Program for dynamic logic.
Private Attributes inherited from OMQ::UserApi::UserApi
const	DataProviderRootValues
	data provider root path values
const	DataTypeRootValues
	data type root path values
const	DataProviderPathTypeValues
	data type path provider type values

Detailed Description

primary service API class

Note

In Python available as svcapi

Member Function Documentation

checkAuthorization()

static OMQ::UserApi::Service::ServiceApi::checkAuthorization (   ... )

static

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.

Exceptions

AUTHORIZATION-ERROR

no authentication information supplied or user does not have all required permissions

See also

• testAuthorization()

checkAuthorizationArgs()

static OMQ::UserApi::Service::ServiceApi::checkAuthorizationArgs ( softlist< string >  args )

static

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

args	the list of permissions to check

Exceptions

AUTHORIZATION-ERROR

no authentication information supplied or user does not have all required permissions

See also

• testAuthorization()

checkAuthorizationOr()

static OMQ::UserApi::Service::ServiceApi::checkAuthorizationOr (   ... )

static

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-ERROR

no authentication information supplied or user does not have any of the permissions given

See also

• testAuthorizationOr()

checkAuthorizationOrArgs()

static OMQ::UserApi::Service::ServiceApi::checkAuthorizationOrArgs ( softlist< string >  args )

static

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

args	the list of permissions to check

Exceptions

AUTHORIZATION-ERROR

no authentication information supplied or user does not have any of the permissions given

See also

• testAuthorizationOr()

checkConnectionAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkConnectionAccess ( int  id )

static

checks if the current user has access to the given connection; an exception is thrown if not

Parameters

id	the ID of the connection to check

Exceptions

CONNECTION-ACCESS-ERROR

the user does not have access to the given connection

Since

Qorus 7.0

checkConnectionAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkConnectionAccess ( list< softint >  ids )

static

checks if the current user has access to the given list of connections; an exception is thrown if not

Parameters

ids	a list of connections to check

Exceptions

CONNECTION-ACCESS-ERROR

the user does not have access to one or more of the given connections

Since

Qorus 7.0

checkFsmAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkFsmAccess ( list< softint >  ids )

static

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

Parameters

ids	a list of finite state machine IDs to check

Exceptions

FSM-ACCESS-ERROR

the user does not have access to one or more of the given finite state machines

Since

Qorus 5.0

checkFsmAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkFsmAccess ( string  name )

static

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

Parameters

name	the finite state machine to check

Exceptions

FSM-ACCESS-ERROR	the user does not have access to the given finite state machine
FSM-ARG-ERROR	The given FSM does not exist

Since

Qorus 5.0

checkJobAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkJobAccess ( list< auto >  ids )

static

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

Parameters

ids	a list of jobids to check

Exceptions

JOB-ACCESS-ERROR

the user does not have access to one or more of the given jobs

checkJobAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkJobAccess ( softint  id )

static

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

Parameters

id	the jobid to check

Exceptions

JOB-ACCESS-ERROR

the user does not have access to the given job

checkJobInstanceAccess()

static OMQ::UserApi::Service::ServiceApi::checkJobInstanceAccess ( softstring  jiid )

static

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

Parameters

jiid	the job_instanceid to check

Exceptions

JOB-ACCESS-ERROR

the user does not have access to the given job

checkMapperAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkMapperAccess ( list< auto >  ids )

static

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

Parameters

ids	a list of mapperids to check

Exceptions

MAPPER-ACCESS-ERROR

the user does not have access to one or more of the given mappers

checkMapperAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkMapperAccess ( softint  id )

static

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

Parameters

id	the mapperid to check

Exceptions

MAPPER-ACCESS-ERROR

the user does not have access to the given mapper

checkPipelineAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkPipelineAccess ( list< auto >  ids )

static

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

Parameters

ids	a list of pipelines to check

Exceptions

PIPELINE-ACCESS-ERROR

the user does not have access to one or more of the given pipelines

Since

Qorus 5.0

checkPipelineAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkPipelineAccess ( string  name )

static

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

Parameters

name	the pipeline to check

Exceptions

PIPELINE-ACCESS-ERROR

the user does not have access to the given pipeline

Since

Qorus 5.0

checkQueueAccess()

static OMQ::UserApi::Service::ServiceApi::checkQueueAccess ( softint  queueid, string  key  )

static

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

queueid	the queue ID to check
key	the key value in queue given by the first argument to check

Exceptions

WORKFLOW-ACCESS-ERROR

no authentication information supplied or user does not have access to the given workflow

checkServiceAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkServiceAccess ( list< auto >  ids )

static

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

Parameters

ids	a list of serviceids to check

Exceptions

SERVICE-ACCESS-ERROR

no authentication information supplied or user does not have access to one or more of the given services

checkServiceAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkServiceAccess ( softint  id )

static

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

Parameters

id	the serviceid to check

Exceptions

SERVICE-ACCESS-ERROR

no authentication information supplied or user does not have access to the given service

checkUserAuthorization()

static OMQ::UserApi::Service::ServiceApi::checkUserAuthorization ( string  user )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR	the user is not loaded
AUTHORIZATION-ERROR	no authentication information supplied or user does not have all required permissions

See also

• testAuthorization()

Since

Qorus 5.1.20

checkUserAuthorizationArgs()

static OMQ::UserApi::Service::ServiceApi::checkUserAuthorizationArgs ( string  user, softlist< string >  args  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
args	the list of permissions to check

Exceptions

USER-ERROR	the user is not loaded
AUTHORIZATION-ERROR	no authentication information supplied or user does not have all required permissions

See also

• testAuthorization()

Since

Qorus 5.1.20

checkUserAuthorizationOr()

static OMQ::UserApi::Service::ServiceApi::checkUserAuthorizationOr ( string  user )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR	the user is not loaded
AUTHORIZATION-ERROR	no authentication information supplied or user does not have any of the permissions given

See also

• testAuthorizationOr()

Since

Qorus 5.1.20

checkUserAuthorizationOrArgs()

static OMQ::UserApi::Service::ServiceApi::checkUserAuthorizationOrArgs ( string  user, softlist< string >  args  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
args	the list of permissions to check

Exceptions

USER-ERROR	the user is not loaded
AUTHORIZATION-ERROR	no authentication information supplied or user does not have any of the permissions given

See also

• testAuthorizationOr()

Since

Qorus 5.1.20

checkUserFsmAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserFsmAccess ( string  user, list< auto >  ids  )

static

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

Parameters

ids	a list of finite state machines to check
user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR	the user is not loaded
FSM-ACCESS-ERROR	the user does not have access to one or more of the given finite state machines

Since

Qorus 5.1.20

checkUserFsmAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserFsmAccess ( string  user, string  name  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
name	the finite state machine to check

Exceptions

USER-ERROR	the user is not loaded
FSM-ACCESS-ERROR	the user does not have access to the given finite state machine

Since

Qorus 5.1.20

checkUserJobAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserJobAccess ( string  user, list< auto >  ids  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of jobids to check

Exceptions

USER-ERROR	the user is not loaded
JOB-ACCESS-ERROR	the user does not have access to one or more of the given jobs

Since

Qorus 5.1.20

checkUserJobAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserJobAccess ( string  user, softint  id  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the jobid to check

Exceptions

USER-ERROR	the user is not loaded
JOB-ACCESS-ERROR	the user does not have access to the given job

Since

Qorus 5.1.20

checkUserJobInstanceAccess()

static OMQ::UserApi::Service::ServiceApi::checkUserJobInstanceAccess ( string  user, softstring  jiid  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
jiid	the job_instanceid to check

Exceptions

USER-ERROR	the user is not loaded
JOB-ACCESS-ERROR	the user does not have access to the given job

Since

Qorus 5.1.20

checkUserMapperAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserMapperAccess ( string  user, list< auto >  ids  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of mapperids to check

Exceptions

USER-ERROR	the user is not loaded
MAPPER-ACCESS-ERROR	the user does not have access to one or more of the given mappers

Since

Qorus 5.1.20

checkUserMapperAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserMapperAccess ( string  user, softint  id  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the mapperid to check

Exceptions

USER-ERROR	the user is not loaded
MAPPER-ACCESS-ERROR	the user does not have access to the given mapper

Since

Qorus 5.1.20

checkUserPipelineAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserPipelineAccess ( string  user, list< auto >  ids  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of pipelines to check

Exceptions

USER-ERROR	the user is not loaded
PIPELINE-ACCESS-ERROR	the user does not have access to one or more of the given pipelines

Since

Qorus 5.1.20

checkUserPipelineAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserPipelineAccess ( string  user, string  name  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
name	the pipeline to check

Exceptions

USER-ERROR	the user is not loaded
PIPELINE-ACCESS-ERROR	the user does not have access to the given pipeline

Since

Qorus 5.1.20

checkUserQueueAccess()

static OMQ::UserApi::Service::ServiceApi::checkUserQueueAccess ( string  user, softint  queueid, string  key  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
queueid	the queue ID to check
key	the key value in queue given by the first argument to check

Exceptions

USER-ERROR	the user is not loaded
WORKFLOW-ACCESS-ERROR	no authentication information supplied or user does not have access to the given workflow

Since

Qorus 5.1.20

checkUserServiceAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserServiceAccess ( string  user, list< auto >  ids  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of serviceids to check

Exceptions

USER-ERROR	the user is not loaded
SERVICE-ACCESS-ERROR	no authentication information supplied or user does not have access to one or more of the given services

Since

Qorus 5.1.20

checkUserServiceAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserServiceAccess ( string  user, softint  id  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the serviceid to check

Exceptions

USER-ERROR	the user is not loaded
SERVICE-ACCESS-ERROR	no authentication information supplied or user does not have access to the given service

Since

Qorus 5.1.20

checkUserVmapAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserVmapAccess ( string  user, list< auto >  ids  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of value map ids to check

Exceptions

USER-ERROR	the user is not loaded
VMAP-ACCESS-ERROR	the user does not have access to one or more of the given value maps

Since

Qorus 5.1.20

checkUserVmapAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserVmapAccess ( string  user, softint  id  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the value map id to check

Exceptions

USER-ERROR	the user is not loaded
VMAP-ACCESS-ERROR	the user does not have access to the given value map

Since

Qorus 5.1.20

checkUserWorkflowAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkUserWorkflowAccess ( string  user, list< auto >  ids  )

static

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

Parameters

ids	a list of workflowids to check
user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR	the user is not loaded
WORKFLOW-ACCESS-ERROR	the user does not have access to one or more of the given workflows

Since

Qorus 5.1.20

checkUserWorkflowAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkUserWorkflowAccess ( string  user, softint  id  )

static

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

Parameters

id	the workflowid to check
user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR	the user is not loaded
WORKFLOW-ACCESS-ERROR	the user does not have access to the given workflow

Since

Qorus 5.1.20

checkUserWorkflowInstanceAccess()

static OMQ::UserApi::Service::ServiceApi::checkUserWorkflowInstanceAccess ( string  user, softstring  wfiid  )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
wfiid	the workflow_instanceid to check

Exceptions

USER-ERROR	the user is not loaded
WORKFLOW-ACCESS-ERROR	no authentication information supplied or user does not have access to the given workflow

Since

Qorus 5.1.20

checkVmapAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkVmapAccess ( list< auto >  ids )

static

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

ids	a list of value map ids to check

Exceptions

VMAP-ACCESS-ERROR

the user does not have access to one or more of the given value maps

checkVmapAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkVmapAccess ( softint  id )

static

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

Parameters

id	the value map id to check

Exceptions

VMAP-ACCESS-ERROR

the user does not have access to the given value map

checkWorkflowAccess() [1/2]

static OMQ::UserApi::Service::ServiceApi::checkWorkflowAccess ( list< auto >  ids )

static

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

Parameters

ids	a list of workflowids to check

Exceptions

WORKFLOW-ACCESS-ERROR

the user does not have access to one or more of the given workflows

checkWorkflowAccess() [2/2]

static OMQ::UserApi::Service::ServiceApi::checkWorkflowAccess ( softint  id )

static

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

Parameters

id	the workflowid to check

Exceptions

WORKFLOW-ACCESS-ERROR

the user does not have access to the given workflow

checkWorkflowInstanceAccess()

static OMQ::UserApi::Service::ServiceApi::checkWorkflowInstanceAccess ( softstring  wfiid )

static

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

Parameters

wfiid

the workflow_instanceid to check

Exceptions

WORKFLOW-ACCESS-ERROR

no authentication information supplied or user does not have access to the given workflow

getConnectionAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getConnectionAccessHash ( )

static

returns a hash of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all connections

Returns

a hash of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty hash means that the user has access to no connections; this must be distinguished from a return value of NOTHING, which means that the user has access to all connections

Since

Qorus 7.0

getConnectionAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getConnectionAccessList ( )

static

returns a list of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all connections

Returns

a list of connections the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty list means that the user has access to no connections; this must be distinguished from a return value of NOTHING, which means that the user has access to all connections

Since

Qorus 7.0

getFsmAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getFsmAccessHash ( )

static

returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all finite state machines

Returns

a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty hash means that the user has access to no finite state machines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.0

getFsmAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getFsmAccessList ( )

static

returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all finite state machines

Returns

a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty list means that the user has access to no finite state machines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.0

getJobAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getJobAccessHash ( )

static

returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

getJobAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getJobAccessList ( )

static

returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

getMapperAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getMapperAccessHash ( )

static

returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING 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 NOTHING 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 NOTHING, which means that the user has access to all value maps

getMapperAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getMapperAccessList ( )

static

returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING 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 NOTHING 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 NOTHING, which means that the user has access to all value maps

getPipelineAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getPipelineAccessHash ( )

static

returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all pipelines

Returns

a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty hash means that the user has access to no pipelines; this must be distinguished from a return value of NOTHING, which means that the user has access to all pipelines

Since

Qorus 5.0

getPipelineAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getPipelineAccessList ( )

static

returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all pipelines

Returns

a list of datapipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Note

a return value of an empty list means that the user has access to no pipelines; this must be distinguished from a return value of NOTHING, which means that the user has access to all pipelines

Since

Qorus 5.0

getServiceAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getServiceAccessHash ( )

static

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

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

getServiceAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getServiceAccessList ( )

static

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

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

getUserFsmAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserFsmAccessHash ( string  user )

static

returns a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all finite state machines

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a hash of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Note

a return value of an empty hash means that the user has access to no finite state machines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.1.20

getUserFsmAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserFsmAccessList ( string  user )

static

returns a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all finite state machines

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a list of Finite State Machines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Note

a return value of an empty list means that the user has access to no finite state machines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.1.20

getUserJobAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserJobAccessHash ( string  user )

static

returns a hash of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown NOTHING 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 NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getUserJobAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserJobAccessList ( string  user )

static

returns a list of job IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown NOTHING 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 NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getUserMapperAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserMapperAccessHash ( string  user )

static

returns a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a hash of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

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 NOTHING, which means that the user has access to all value maps

Since

Qorus 5.1.20

getUserMapperAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserMapperAccessList ( string  user )

static

returns a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a list of mapper IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

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 NOTHING, which means that the user has access to all value maps

Since

Qorus 5.1.20

getUserPipelineAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserPipelineAccessHash ( string  user )

static

returns a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all pipelines

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a hash of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Note

a return value of an empty hash means that the user has access to no pipelines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.1.20

getUserPipelineAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserPipelineAccessList ( string  user )

static

returns a list of data pipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING is only returned if the current user has access to all pipelines

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a list of datapipelines the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Note

a return value of an empty list means that the user has access to no pipelines; this must be distinguished from a return value of NOTHING, which means that the user has access to all finite state machines

Since

Qorus 5.1.20

getUserServiceAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserServiceAccessHash ( string  user )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown NOTHING 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 NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getUserServiceAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserServiceAccessList ( string  user )

static

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown NOTHING 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 NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getUserVmapAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserVmapAccessHash ( string  user )

static

returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

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 NOTHING, which means that the user has access to all value maps

Since

Qorus 5.1.20

getUserVmapAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserVmapAccessList ( string  user )

static

returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

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 NOTHING, which means that the user has access to all value maps

Since

Qorus 5.1.20

getUserWorkflowAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getUserWorkflowAccessHash ( string  user )

static

returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getUserWorkflowAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getUserWorkflowAccessList ( string  user )

static

returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

getVmapAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getVmapAccessHash ( )

static

returns a hash of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING 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 NOTHING 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 NOTHING, which means that the user has access to all value maps

getVmapAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getVmapAccessList ( )

static

returns a list of value map IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

NOTHING 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 NOTHING 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 NOTHING, which means that the user has access to all value maps

getWorkflowAccessHash()

static *hash< auto > OMQ::UserApi::Service::ServiceApi::getWorkflowAccessHash ( )

static

returns a hash of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

getWorkflowAccessList()

static *list< auto > OMQ::UserApi::Service::ServiceApi::getWorkflowAccessList ( )

static

returns a list of workflow IDs the current user has access to; or, if the current user has a role with the DEFAULT group, then NOTHING is returned

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

registerSoapHandler()

static OMQ::UserApi::Service::ServiceApi::registerSoapHandler ( hash< auto >  h )

static

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

h

a 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-ERROR

missing wsdl or wsdl_file key in argument hash; cannot find service; multiple services defined by WSDL but no service key given in argument hash

testAuthorization()

static bool OMQ::UserApi::Service::ServiceApi::testAuthorization (   ... )

static

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

testAuthorizationArgs()

static bool OMQ::UserApi::Service::ServiceApi::testAuthorizationArgs ( softlist< string >  args )

static

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

args	the list of permissions to test

Returns

if current user does not have all of the given permissions, returns False, otherwise True.

See also

• checkAuthorization()

testAuthorizationOr()

static bool OMQ::UserApi::Service::ServiceApi::testAuthorizationOr (   ... )

static

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

testAuthorizationOrArgs()

static bool OMQ::UserApi::Service::ServiceApi::testAuthorizationOrArgs ( softlist< string >  args )

static

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

args	the 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()

testConnectionAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testConnectionAccess ( int  id )

static

tests if the current user has access to the given connection and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

id	the connection ID to check

Since

Qorus 7.0

testConnectionAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testConnectionAccess ( list< softint >  ids )

static

tests if the current user has access to the given list of connections and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

ids	a list of connections to check

Since

Qorus 7.0

testFsmAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testFsmAccess ( list< auto >  ids )

static

tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

ids	a list of finite state machines to check

Since

Qorus 5.0

testFsmAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testFsmAccess ( string  name )

static

tests if the current user has access to the given single Finite State Machine

Parameters

name	the finite state machine to check

Returns

True (if authorization is granted) or False (if the user is not authorized)

Exceptions

FSM-ARG-ERROR

The given FSM does not exist

Since

Qorus 5.0

testJobAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testJobAccess ( list< auto >  ids )

static

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

ids	a list of jobids to check

testJobAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testJobAccess ( softint  id )

static

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

id	the jobid to check

testMapperAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testMapperAccess ( list< auto >  ids )

static

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

ids	a list of mapperids to check

testMapperAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testMapperAccess ( softint  id )

static

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

id	the mapperid to check

testPipelineAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testPipelineAccess ( list< auto >  ids )

static

tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

ids	a list of pipelines to check

Since

Qorus 5.0

testPipelineAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testPipelineAccess ( string  name )

static

tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

name	the pipeline to check

Since

Qorus 5.0

testServiceAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testServiceAccess ( list< auto >  ids )

static

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

ids	a list of serviceids to check

Exceptions

SERVICE-ACCESS-ERROR

no authentication information supplied or user does not have access to the given services

testServiceAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testServiceAccess ( softint  id )

static

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

id	the serviceid to check

testUserAuthorization()

static bool OMQ::UserApi::Service::ServiceApi::testUserAuthorization ( string  user )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

if current user does not have all of the given permissions, returns False, otherwise True.

Exceptions

USER-ERROR

the user is not loaded

See also

• checkAuthorization()

Since

Qorus 5.1.20

testUserAuthorizationArgs()

static bool OMQ::UserApi::Service::ServiceApi::testUserAuthorizationArgs ( string  user, softlist< string >  args  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
args	the list of permissions to test

Returns

if current user does not have all of the given permissions, returns False, otherwise True.

Exceptions

USER-ERROR

the user is not loaded

See also

• checkAuthorization()

Since

Qorus 5.1.20

testUserAuthorizationOr()

static bool OMQ::UserApi::Service::ServiceApi::testUserAuthorizationOr ( string  user )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Returns

if current user does not have at least one of the given permissions, returns False, otherwise True.

Exceptions

USER-ERROR

the user is not loaded

See also

• checkAuthorizationOr()

Since

Qorus 5.1.20

testUserAuthorizationOrArgs()

static bool OMQ::UserApi::Service::ServiceApi::testUserAuthorizationOrArgs ( string  user, softlist< string >  args  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
args	the list of permissions to test

Returns

if current user does not have at least one of the given permissions, returns False, otherwise True.

Exceptions

USER-ERROR

the user is not loaded

See also

• checkAuthorizationOr()

Since

Qorus 5.1.20

testUserFsmAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserFsmAccess ( string  user, list< auto >  ids  )

static

tests if the current user has access to the given list of Finite State Machines and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of finite state machines to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserFsmAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserFsmAccess ( string  user, string  name  )

static

tests if the current user has access to the given single Finite State Machine and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
name	the finite state machine to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserJobAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserJobAccess ( string  user, list< auto >  ids  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of jobids to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserJobAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserJobAccess ( string  user, softint  id  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the jobid to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserMapperAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserMapperAccess ( string  user, list< auto >  ids  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of mapperids to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserMapperAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserMapperAccess ( string  user, softint  id  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the mapperid to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserPipelineAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserPipelineAccess ( string  user, list< auto >  ids  )

static

tests if the current user has access to the given list of data pipelines and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of pipelines to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserPipelineAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserPipelineAccess ( string  user, string  name  )

static

tests if the current user has access to the given single data pipeline and returns True (if authorization is granted) or False (if the user is not authorized)

Parameters

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
name	the pipeline to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserServiceAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserServiceAccess ( string  user, list< auto >  ids  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of serviceids to check

Exceptions

USER-ERROR	the user is not loaded
SERVICE-ACCESS-ERROR	no authentication information supplied or user does not have access to the given services

Since

Qorus 5.1.20

testUserServiceAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserServiceAccess ( string  user, softint  id  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the serviceid to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserVmapAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserVmapAccess ( string  user, list< auto >  ids  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
ids	a list of value map ids to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserVmapAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserVmapAccess ( string  user, softint  id  )

static

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

user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown
id	the value map id to check

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserWorkflowAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserWorkflowAccess ( string  user, list< auto >  ids  )

static

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

ids	a list of workflowids to check
user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testUserWorkflowAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testUserWorkflowAccess ( string  user, softint  id  )

static

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

id	the workflowid to check
user	the user to check; if the user is provided by an external RBAC source, the user must already be loaded or a USER-ERROR exception is thrown

Exceptions

USER-ERROR

the user is not loaded

Since

Qorus 5.1.20

testVmapAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testVmapAccess ( list< auto >  ids )

static

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

ids	a list of value map ids to check

testVmapAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testVmapAccess ( softint  id )

static

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

id	the value map id to check

testWorkflowAccess() [1/2]

static bool OMQ::UserApi::Service::ServiceApi::testWorkflowAccess ( list< auto >  ids )

static

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

ids	a list of workflowids to check

testWorkflowAccess() [2/2]

static bool OMQ::UserApi::Service::ServiceApi::testWorkflowAccess ( softint  id )

static

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

id	the workflowid to check

Member Data Documentation

ServiceCallContextKeys

const OMQ::UserApi::Service::ServiceApi::ServiceCallContextKeys

Initial value:

= ("socket", "socket-info", "peer-info", "url", "id", "ssl", "user",
            "client-cert", "hdr", "orig-request-body")

keys returned from the cx hash in getCallContext() if present

Since

Qorus 4.0.3

---

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

• ServiceApi.qc