|
irods
4.3.0
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
 Fossies Dox: irods-4.3.0.tar.gz ("unofficial" and yet experimental doxygen-generated source code documentation)  |
#include "irods/rodsUser.h"#include "irods/rods.h"#include "irods/rcGlobalExtern.h"#include "irods/objInfo.h"#include "irods/reSysDataObjOpr.hpp"#include "irods/reDataObjOpr.hpp"#include "irods/reNaraMetaData.hpp"#include "irods/reIn2p3SysRule.hpp"#include "irods/irods_ms_plugin.hpp"Go to the source code of this file.
Namespaces | |
| namespace | irods |
| int delayExec | ( | msParam_t * | condition, |
| msParam_t * | workflow, | ||
| msParam_t * | recoverWorkFlow, | ||
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 105 of file nre.systemMS.cpp.
References _delayExec(), i, MsParam::inOutStruct, MAX_ACTION_SIZE, and rstrcpy().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAclPolicy | ( | msParam_t * | msParam, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | msParam | - a msParam of type STR_MS_T - can have value 'STRICT' |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| status |
Definition at line 592 of file icatAdminMS.cpp.
References chlGenQueryAccessControlSetup(), irods::error::code(), get_catalog_service_role(), if(), MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_PROVIDER, NULL, irods::error::ok(), PASS, and irods::STRICT_ACL_KW.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAddConditionToGenQuery | ( | msParam_t * | attribute, |
| msParam_t * | opr, | ||
| msParam_t * | value, | ||
| msParam_t * | queryInput, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | attribute | - Required - A STR_MS_T with the iCAT attribute name (see wiki.irods.org/index.php/icatAttributes). |
| [in] | opr | - Required - A STR_MS_T with the operator. |
| [in] | value | - Required - A STR_MS_T with the value. |
| [in,out] | queryInput | - Required - A GenQueryInp_MS_T. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 804 of file genQueryMS.cpp.
References addInxVal(), GenQueryInp_MS_T, getAttrIdFromAttrName(), MsParam::inOutStruct, LOG_ERROR, MAX_NAME_LEN, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, GenQueryInp::sqlCondInp, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAddKeyVal | ( | msParam_t * | inKeyValPair, |
| msParam_t * | key, | ||
| msParam_t * | value, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in,out] | inKeyValPair | - Optional - a KeyValPair_MS_T |
| [in] | key | - Required - A STR_MS_T containing the key |
| [in] | value | - Optional - A STR_MS_T containing the value |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 361 of file keyValPairMS.cpp.
References addKeyVal(), MsParam::inOutStruct, KeyValPair_MS_T, LOG_ERROR, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, RuleExecInfo::status, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAddSelectFieldToGenQuery | ( | msParam_t * | select, |
| msParam_t * | function, | ||
| msParam_t * | queryInput, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | select | - Required - A STR_MS_T with the select field. |
| [in] | function | - Optional - A STR_MS_T with the function. Valid values are [MIN|MAX|SUM|AVG|COUNT] |
| [in,out] | queryInput | - Optional - A GenQueryInp_MS_T. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 695 of file genQueryMS.cpp.
References addInxIval(), GenQueryInp_MS_T, getAttrIdFromAttrName(), getSelVal(), MsParam::inOutStruct, LOG_ERROR, MAX_SQL_ROWS, GenQueryInp::maxRows, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, GenQueryInp::selectInp, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAddUserToGroup | ( | msParam_t * | msParam, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | msParam | - a msParam of type STR_MS_T, the name of the group |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (i) |
Definition at line 314 of file icatAdminMS.cpp.
References chlModGroup(), irods::error::code(), get_catalog_service_role(), i, MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), UserInfo::rodsZone, RuleExecInfo::rsComm, RuleExecInfo::uoio, UserInfo::userName, and UserInfo::userType.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiApplyDCMetadataTemplate | ( | msParam_t * | inpParam, |
| msParam_t * | outParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inpParam | - a STR_MS_T containing the target object's path |
| [out] | outParam | - an INT_MS_T containing the status |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 159 of file miscMS.cpp.
References ModifyAVUMetadataInput::arg0, ModifyAVUMetadataInput::arg1, ModifyAVUMetadataInput::arg2, ModifyAVUMetadataInput::arg3, ModifyAVUMetadataInput::arg4, ModifyAVUMetadataInput::arg5, fillIntInMsParam(), getObjType(), i, LOG_ERROR, NAME_LEN, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, and rsModAVUMetadata().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiAssociateKeyValuePairsToObj | ( | msParam_t * | metadataParam, |
| msParam_t * | objParam, | ||
| msParam_t * | typeParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | metadataParam | - a msParam of type KeyValPair_MS_T |
| [in] | objParam | - a msParam of type STR_MS_T |
| [in] | typeParam | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameters don't match the type from addAVUMetadataFromKVPairs |
Definition at line 429 of file extractAvuMS.cpp.
References addAVUMetadataFromKVPairs(), i, MsParam::inOutStruct, KeyValPair_MS_T, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiAW1 | ( | msParam_t * | mPIn, |
| msParam_t * | mPOut2, | ||
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 40 of file testMS.cpp.
References MsParam::inOutStruct, LOG_NOTICE, rodsLog(), STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiBytesBufToStr | ( | msParam_t * | buf_msp, |
| msParam_t * | str_msp, | ||
| ruleExecInfo_t * | rei | ||
| ) |
testrule{ msiBytesBufToStr(*Buff, *St) writeLine(stdout,*St) } ruleExecOut
| [in] | buf_msp | - a BUF_LEN_MS_T |
| [out] | str_msp | - a STR_MS_T |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 889 of file nre.systemMS.cpp.
References BytesBuf::buf, fillStrInMsParam(), MsParam::inOutStruct, MsParam::inpOutBuf, irods::KW_CFG_MAX_SIZE_FOR_SINGLE_BUFFER, BytesBuf::len, LOG_ERROR, NULL, rodsLog(), and strncpy().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiCheckAccess | ( | msParam_t * | inObjName, |
| msParam_t * | inOperation, | ||
| msParam_t * | outResult, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inObjName | - name of Object. A param of type STR_MS_T |
| [in] | inOperation | - type of Operation that will be performed. A param of type STR_MS_T. |
| [out] | outResult | - result of the operation. 0 for failure and 1 for success. a param of type INT_MS_T. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 263 of file icatGeneralMS.cpp.
References checkPermissionByObjType(), RsComm::clientUser, fillIntInMsParam(), getObjType(), i, MsParam::inOutStruct, MAX_NAME_LEN, NULL, RE_TEST_MACRO, UserInfo::rodsZone, RuleExecInfo::rsComm, STR_MS_T, MsParam::type, and UserInfo::userName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiCheckOwner | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 178 of file icatGeneralMS.cpp.
References DataObjInfo::dataOwnerName, DataObjInfo::dataOwnerZone, RuleExecInfo::doi, UserInfo::rodsZone, RuleExecInfo::uoic, and UserInfo::userName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiCheckPermission | ( | msParam_t * | xperm, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xperm | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 218 of file icatGeneralMS.cpp.
References DataObjInfo::dataAccess, RuleExecInfo::doi, if(), MsParam::inOutStruct, and NULL.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiCloseGenQuery | ( | msParam_t * | genQueryInp_msp, |
| msParam_t * | genQueryOut_msp, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | genQueryInp_msp | - Required - a GenQueryInp_MS_T containing the query parameters and conditions. |
| [in] | genQueryOut_msp | - Required - a GenQueryOut_MS_T to write results to. If its continuation index is 0 the query will be closed. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 391 of file genQueryMS.cpp.
| msiCommit | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (status) |
Definition at line 349 of file icatGeneralMS.cpp.
References chlCommit(), irods::error::code(), get_catalog_service_role(), irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiCreateCollByAdmin | ( | msParam_t * | xparColl, |
| msParam_t * | xchildName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xparColl | - a msParam of type STR_MS_T |
| [in] | xchildName | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (i) |
Definition at line 110 of file icatAdminMS.cpp.
References chlRegCollByAdmin(), irods::error::code(), CollInfo::collName, CollInfo::collOwnerName, CollInfo::collOwnerZone, get_catalog_service_role(), i, MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), UserInfo::rodsZone, RuleExecInfo::rsComm, RuleExecInfo::uoio, and UserInfo::userName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiCreateUser | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| i |
Definition at line 53 of file icatAdminMS.cpp.
References chlRegUserRE(), irods::error::code(), get_catalog_service_role(), i, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), RuleExecInfo::rsComm, and RuleExecInfo::uoio.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiCutBufferInHalf | ( | msParam_t * | mPIn, |
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 53 of file testMS.cpp.
References MsParam::inpOutBuf, BytesBuf::len, LOG_ERROR, NULL, RE_TEST_MACRO, and rodsLog().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiDeleteCollByAdmin | ( | msParam_t * | xparColl, |
| msParam_t * | xchildName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xparColl | - a msParam of type STR_MS_T |
| [in] | xchildName | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (i) |
Definition at line 180 of file icatAdminMS.cpp.
References chlDelCollByAdmin(), irods::error::code(), CollInfo::collName, CollInfo::collOwnerName, CollInfo::collOwnerZone, freeRErrorContent(), get_catalog_service_role(), i, MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, RsComm::rError, rodsLog(), UserInfo::rodsZone, RuleExecInfo::rsComm, RuleExecInfo::uoio, and UserInfo::userName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiDeleteUnusedAVUs | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (status) |
Definition at line 588 of file icatGeneralMS.cpp.
References chlDelUnusedAVUs(), irods::error::code(), get_catalog_service_role(), irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, LOG_NOTICE, irods::error::ok(), PASS, rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiDeleteUser | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| (i) |
Definition at line 258 of file icatAdminMS.cpp.
References chlDelUserRE(), irods::error::code(), get_catalog_service_role(), i, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), RuleExecInfo::rsComm, and RuleExecInfo::uoio.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiDoSomething | ( | msParam_t * | inParam, |
| msParam_t * | outParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [out] | - | A KeyValPair_MS_T (by default). |
| [out] | outParam | - A KeyValPair_MS_T (by default). |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 112 of file testMS.cpp.
References MsParam::inOutStruct, KeyValPair_MS_T, LOG_ERROR, NULL, RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiExecGenQuery | ( | msParam_t * | genQueryInParam, |
| msParam_t * | genQueryOutParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | genQueryInParam | - a msParam of type GenQueryInp_MS_T |
| [out] | genQueryOutParam | - a msParam of type GenQueryOut_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 113 of file genQueryMS.cpp.
| msiExecStrCondQuery | ( | msParam_t * | queryParam, |
| msParam_t * | genQueryOutParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | queryParam | - a msParam of type GenQueryInp_MS_T |
| [out] | genQueryOutParam | - a msParam of type GenQueryOut_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 44 of file genQueryMS.cpp.
References GenQueryInp::continueInx, fillGenQueryInpFromStrCond(), GenQueryOut_MS_T, i, MsParam::inOutStruct, MAX_NAME_LEN, MAX_SQL_ROWS, GenQueryInp::maxRows, NULL, RuleExecInfo::rsComm, rsGenQuery(), strcpy(), and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiExtractTemplateMDFromBuf | ( | msParam_t * | bufParam, |
| msParam_t * | tagParam, | ||
| msParam_t * | metadataParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | bufParam | - a msParam of type BUF_MS_T |
| [in] | tagParam | - a msParam of type TagStruct_MS_T |
| [out] | metadataParam | - a msParam of type KeyValPair_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameter doesn't match the type |
| INVALID_REGEXP | if the tags are not correct |
| from | addKeyVal |
Definition at line 301 of file extractAvuMS.cpp.
References addKeyVal(), BytesBuf::buf, BUF_LEN_MS_T, clearKeyVal(), i, MsParam::inOutStruct, MsParam::inpOutBuf, KeyValPair_MS_T, TagStruct::keyWord, TagStruct::len, BytesBuf::len, LOG_NOTICE, NULL, TagStruct::postTag, TagStruct::preTag, RE_TEST_MACRO, rodsLog(), TagStruct_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiFreeBuffer | ( | msParam_t * | memoryParam, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | memoryParam | - the buffer to free |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 479 of file nre.systemMS.cpp.
References BytesBuf::buf, getMsParamByLabel(), if(), MsParam::inOutStruct, MsParam::inpOutBuf, BytesBuf::len, RuleExecInfo::msParamArray, NULL, RE_TEST_MACRO, ExecCmdOut::stderrBuf, ExecCmdOut::stdoutBuf, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetContInxFromGenQueryOut | ( | msParam_t * | genQueryOutParam, |
| msParam_t * | continueInx, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | genQueryOutParam | - Required - of type GenQueryOut_MS_T. |
| [out] | continueInx | - a INT_MS_T containing the new continuation index (after the query). |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 173 of file genQueryMS.cpp.
References GenQueryOut::continueInx, fillIntInMsParam(), GenQueryOut_MS_T, MsParam::inOutStruct, LOG_ERROR, RE_TEST_MACRO, rodsLog(), and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetDiffTime | ( | msParam_t * | inpParam1, |
| msParam_t * | inpParam2, | ||
| msParam_t * | inpParam3, | ||
| msParam_t * | outParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inpParam1 | - a STR_MS_T containing the start date (system time in seconds) |
| [in] | inpParam2 | - a STR_MS_T containing the end date (system time in seconds) |
| [in] | inpParam3 | - Optional - a STR_MS_T containing the desired output format |
| [out] | outParam | - a STR_MS_T containing the time elapsed between the two dates |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 600 of file nre.systemMS.cpp.
References fillStrInMsParam(), if(), MsParam::inOutStruct, LOG_ERROR, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, and TIME_LEN.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetFormattedSystemTime | ( | msParam_t * | outParam, |
| msParam_t * | inpParam, | ||
| msParam_t * | inpFormatParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [out] | outParam | - a STR_MS_T containing the time |
| [in] | inpParam | - Optional - a STR_MS_T containing the desired output format (human) |
| [in] | inpFormatParam | - Optional - a STR_MS_T containing printf formatting (if inpParam was human) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 1048 of file nre.systemMS.cpp.
References fillStrInMsParam(), getNowStr(), MsParam::inOutStruct, LOG_ERROR, NULL, RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, and TIME_LEN.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetIcatTime | ( | msParam_t * | timeOutParam, |
| msParam_t * | typeInParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [out] | timeOutParam | - a msParam of type STR_MS_T |
| [in] | typeInParam | - a msParam of type STR_MS_T
|
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 45 of file icatGeneralMS.cpp.
References fillStrInMsParam(), getLocalTimeFromRodsTime(), getNowStr(), if(), MsParam::inOutStruct, TIME_LEN, and type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiGetMoreRows | ( | msParam_t * | genQueryInp_msp, |
| msParam_t * | genQueryOut_msp, | ||
| msParam_t * | continueInx, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | genQueryInp_msp | - Required - a GenQueryInp_MS_T containing the query parameters and conditions. |
| [in] | genQueryOut_msp | - Required - a GenQueryOut_MS_T to write results to. If its continuation index is 0 the query will be closed. |
| [out] | continueInx | - a INT_MS_T containing the new continuation index (after the query). |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 288 of file genQueryMS.cpp.
| msiGetObjType | ( | msParam_t * | objParam, |
| msParam_t * | typeParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | objParam | - a msParam of type STR_MS_T, the path of the iRODS object |
| [out] | typeParam | - a msParam of type STR_MS_T, will be set by this microservice |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameter doesn't match the type |
| getObjType |
Definition at line 560 of file extractAvuMS.cpp.
References getObjType(), i, MsParam::inOutStruct, MAX_NAME_LEN, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetSystemTime | ( | msParam_t * | outParam, |
| msParam_t * | inpParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [out] | outParam | - a STR_MS_T containing the time |
| [in] | inpParam | - Optional - a STR_MS_T containing the desired output format |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 690 of file nre.systemMS.cpp.
References fillStrInMsParam(), getLocalTimeFromRodsTime(), getNowStr(), if(), MsParam::inOutStruct, LOG_ERROR, NULL, RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, and TIME_LEN.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGetTaggedValueFromString | ( | msParam_t * | inTagParam, |
| msParam_t * | inStrParam, | ||
| msParam_t * | outValueParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inTagParam | - a msParam of type STR_MS_T |
| [in] | inStrParam | - a msParam of type STR_MS_T |
| [out] | outValueParam | - a msParam of type INT_MS_T |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 199 of file extractAvuMS.cpp.
References fillMsParam(), MsParam::inOutStruct, LOG_NOTICE, NULL, rodsLog(), and STR_MS_T.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiGetValByKey | ( | msParam_t * | _kvp, |
| msParam_t * | _key, | ||
| msParam_t * | _out_value, | ||
| ruleExecInfo_t * | _rei | ||
| ) |
| [in] | _kvp | This msParam is of type KeyValPair_PI which is a KeyValPair List. |
| [in] | _key | This msParam is of type STR_MS_T which is a key. |
| [out] | _out_value | This msParam is of type STR_MS_T which is a value corresponding to key. |
| [in,out] | _rei | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 37 of file keyValPairMS.cpp.
References fillStrInMsParam(), getValByKey(), MsParam::inOutStruct, KeyValPair_MS_T, MsParam::label, LOG_ERROR, RE_TEST_MACRO, rodsLog(), STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiGoodFailure | ( | ruleExecInfo_t * | rei | ) |
| negative | number |
Definition at line 425 of file nre.systemMS.cpp.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiHumanToSystemTime | ( | msParam_t * | inpParam, |
| msParam_t * | outParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inpParam | - a STR_MS_T containing the input date |
| [out] | outParam | - a STR_MS_T containing the timestamp |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 753 of file nre.systemMS.cpp.
References fillStrInMsParam(), localToUnixTime(), LOG_ERROR, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, RuleExecInfo::status, and TIME_LEN.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiListEnabledMS | ( | msParam_t * | outKVPairs, |
| ruleExecInfo_t * | rei | ||
| ) |
| [out] | outKVPairs | - A KeyValPair_MS_T containing the results. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 955 of file nre.systemMS.cpp.
References addKeyVal(), irods::lookup_table< ValueType, KeyType, HashType >::begin(), irods::error::code(), irods::lookup_table< ValueType, KeyType, HashType >::end(), fillMsParam(), KeyValPair_MS_T, irods::KW_CFG_PLUGIN_TYPE_MICROSERVICE, irods::plugin_name_generator::list_plugins(), LOG_ERROR, NULL, irods::error::ok(), PASS, RE_TEST_MACRO, irods::resolve_plugin_path(), rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiMakeGenQuery | ( | msParam_t * | selectListStr, |
| msParam_t * | condStr, | ||
| msParam_t * | genQueryInpParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | selectListStr | - Required - a STR_MS_T containing the parameters. |
| [in] | condStr | - Required - a STR_MS_T containing the conditions |
| [out] | genQueryInpParam | - a GenQueryInp_MS_T containing the parameters and conditions. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 494 of file genQueryMS.cpp.
References _makeQuery(), GenQueryInp::continueInx, fillGenQueryInpFromStrCond(), freeGenQueryInp(), GenQueryInp_MS_T, MsParam::inOutStruct, LOG_ERROR, MAX_NAME_LEN, MAX_SQL_ROWS, GenQueryInp::maxRows, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, RuleExecInfo::status, strcpy(), and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiMakeQuery | ( | msParam_t * | selectListParam, |
| msParam_t * | conditionsParam, | ||
| msParam_t * | queryOutParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | selectListParam | - a STR_MS_T containing the parameters. |
| [in] | conditionsParam | - a STR_MS_T containing the conditions. |
| [out] | queryOutParam | - a STR_MS_T containing the parameters and conditions as sql. |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 240 of file genQueryMS.cpp.
References _makeQuery(), i, MsParam::inOutStruct, STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiModAVUMetadata | ( | msParam_t * | _item_type, |
| msParam_t * | _item_name, | ||
| msParam_t * | _avu_op, | ||
| msParam_t * | _attr_name, | ||
| msParam_t * | _attr_val, | ||
| msParam_t * | _attr_unit, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | item_type | - a msParam of type STR_MS_T |
| [in] | item_name | - a msParam of type STR_MS_T |
| [in] | avu_op | - a msParam of type STR_MS_T |
| [in] | attrNameParam | - a msParam of type STR_MS_T |
| [in] | attrValueParam | - a msParam of type STR_MS_T |
| [in] | attrUnitsParam | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameter doesn't match the type |
| from | rsModAVUMetadata |
Definition at line 712 of file extractAvuMS.cpp.
References ModifyAVUMetadataInput::arg0, ModifyAVUMetadataInput::arg1, ModifyAVUMetadataInput::arg2, ModifyAVUMetadataInput::arg3, ModifyAVUMetadataInput::arg4, ModifyAVUMetadataInput::arg5, parseMspForStr(), RuleExecInfo::rsComm, rsModAVUMetadata(), and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiPrintGenQueryInp | ( | msParam_t * | where, |
| msParam_t * | genQueryInpParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | where | - Required - a STR_MS_T containing the parameters. |
| [in] | genQueryInpParam | - Required - a GenQueryInp_MS_T containing the parameters and conditions. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 590 of file genQueryMS.cpp.
References _writeString(), i, MsParam::inOutStruct, InxIvalPair::inx, InxValPair::inx, MsParam::label, InxIvalPair::len, InxValPair::len, len, LOG_ERROR, MAX_NAME_LEN, NULL, RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, GenQueryInp::selectInp, GenQueryInp::sqlCondInp, InxIvalPair::value, and InxValPair::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiPrintGenQueryOutToBuffer | ( | msParam_t * | queryOut, |
| msParam_t * | format, | ||
| msParam_t * | buffer, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | queryOut | - Required - A GenQueryOut_MS_T. |
| [in] | format | - Optional - A STR_MS_T with a C-style format string, like in iquest. |
| [out] | buffer | - A BUF_LEN_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 915 of file genQueryMS.cpp.
References appendToByteBuf(), fillBufLenInMsParam(), GenQueryOut_MS_T, MsParam::inOutStruct, BytesBuf::len, LOG_ERROR, MAX_NAME_LEN, NULL, parseMspForStr(), printGenQueryOut(), RE_TEST_MACRO, resetMsParam(), rodsLog(), RuleExecInfo::rsComm, RuleExecInfo::status, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiPrintKeyValPair | ( | msParam_t * | where, |
| msParam_t * | inkvpair, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | where | - a msParam of type STR_MS_T which is either stderr or stdout. |
| [in] | inkvpair | - a msParam of type KeyValPair_PI which is a KeyValPair list (structure). |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 111 of file keyValPairMS.cpp.
References i, MsParam::inOutStruct, k, l, NULL, RE_TEST_MACRO, and writeString().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiQuota | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 94 of file icatGeneralMS.cpp.
References chlCalcUsageAndQuota(), irods::error::code(), get_catalog_service_role(), irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_NOTICE, irods::error::ok(), PASS, rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiReadMDTemplateIntoTagStruct | ( | msParam_t * | bufParam, |
| msParam_t * | tagParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | bufParam | - a msParam of type BUF_LEN_MS_T |
| [out] | tagParam | - a return msParam of type TagStruct_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameter doesn't match the type |
| INVALID_REGEXP | if the tags are not correct |
| NO_VALUES_FOUND | if there are no tags identified |
| from | addTagStruct |
Definition at line 59 of file extractAvuMS.cpp.
References addTagStruct(), BytesBuf::buf, BUF_LEN_MS_T, i, MsParam::inOutStruct, MsParam::inpOutBuf, TagStruct::len, BytesBuf::len, LOG_NOTICE, NULL, RE_TEST_MACRO, rodsLog(), TagStruct_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiRemoveKeyValuePairsFromObj | ( | msParam_t * | metadataParam, |
| msParam_t * | objParam, | ||
| msParam_t * | typeParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | metadataParam | - a msParam of type KeyValPair_MS_T |
| [in] | objParam | - a msParam of type STR_MS_T |
| [in] | typeParam | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameter doesn't match the type |
| from | removeAVUMetadataFromKVPairs |
Definition at line 628 of file extractAvuMS.cpp.
References i, MsParam::inOutStruct, KeyValPair_MS_T, RE_TEST_MACRO, removeAVUMetadataFromKVPairs(), RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiRenameCollection | ( | msParam_t * | oldName, |
| msParam_t * | newName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | oldName | - a msParam of type STR_MS_T |
| [in] | newName | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| status |
Definition at line 439 of file icatAdminMS.cpp.
References get_catalog_service_role(), MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, irods::error::ok(), PASS, and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiRenameLocalZone | ( | msParam_t * | oldName, |
| msParam_t * | newName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | oldName | - a msParam of type STR_MS_T |
| [in] | newName | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| status |
Definition at line 378 of file icatAdminMS.cpp.
References chlRenameLocalZone(), irods::error::code(), get_catalog_service_role(), MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiRenameLocalZoneCollection | ( | msParam_t * | _new_zone_name, |
| ruleExecInfo_t * | _rei | ||
| ) |
Renames the local zone collection.
| [in] | _new_zone_name | The new name for the zone collection. The new name must not exist. |
| [in] | _rei | The RuleExecInfo managed by the system. This parameter must be ignored. |
| 0 | On success. |
| Non-zero | Otherwise. |
Definition at line 500 of file icatAdminMS.cpp.
References chlCommit(), chlRenameColl(), chlRollback(), get_catalog_service_role(), MsParam::inOutStruct, irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, RsComm::myEnv, irods::error::ok(), PASS, RodsEnvironment::rodsZone, and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiRollback | ( | ruleExecInfo_t * | rei | ) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 405 of file icatGeneralMS.cpp.
References chlRollback(), irods::error::code(), get_catalog_service_role(), irods::KW_CFG_SERVICE_ROLE_CONSUMER, irods::KW_CFG_SERVICE_ROLE_PROVIDER, LOG_ERROR, irods::error::ok(), PASS, rodsLog(), and RuleExecInfo::rsComm.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSendMail | ( | msParam_t * | xtoAddr, |
| msParam_t * | xsubjectLine, | ||
| msParam_t * | xbody, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xtoAddr | - a msParam of type STR_MS_T which is an address of the receiver. |
| [in] | xsubjectLine | - a msParam of type STR_MS_T which is a subject of the message. |
| [in] | xbody | - a msParam of type STR_MS_T which is a body of the message. |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 45 of file mailMS.cpp.
References checkStringForEmailAddress(), checkStringForSystem(), ERROR, if(), MsParam::inOutStruct, LOG_ERROR, LOG_NOTICE, NULL, and rodsLog().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetACL | ( | msParam_t * | recursiveFlag, |
| msParam_t * | accessLevel, | ||
| msParam_t * | userName, | ||
| msParam_t * | pathName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | recursiveFlag | - a STR_MS_T, either "default" or "recursive". |
| [in] | accessLevel | - a STR_MS_T containing one of the following:
|
| [in] | userName | - a STR_MS_T, the user name or group name who will have ACL changed. |
| [in] | pathName | - a STR_MS_T, the collection or data object that will have its ACL changed. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 472 of file icatGeneralMS.cpp.
References modAccessControlInp_t::accessLevel, if(), MsParam::inOutStruct, LOG_ERROR, LOG_NOTICE, NAME_LEN, NULL, modAccessControlInp_t::path, RE_TEST_MACRO, modAccessControlInp_t::recursiveFlag, RsComm::rError, rodsLog(), rodsLogAndErrorMsg(), UserInfo::rodsZone, RuleExecInfo::rsComm, rsModAccessControl(), RuleExecInfo::status, STR_MS_T, strncpy(), MsParam::type, RuleExecInfo::uoic, modAccessControlInp_t::userName, and modAccessControlInp_t::zone.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetBulkPutPostProcPolicy | ( | msParam_t * | xflag, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xflag | - Required - a msParam of type STR_MS_T.
|
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| POLICY_OFF | or POLICY_ON |
Definition at line 1311 of file reSysDataObjOpr.cpp.
References MsParam::inOutStruct, POLICY_OFF, POLICY_ON, RE_TEST_MACRO, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetKeyValuePairsToObj | ( | msParam_t * | metadataParam, |
| msParam_t * | objParam, | ||
| msParam_t * | typeParam, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | metadataParam | - a msParam of type KeyValPair_MS_T |
| [in] | objParam | - a msParam of type STR_MS_T |
| [in] | typeParam | - a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
| USER_PARAM_TYPE_ERR | when input parameters don't match the type from addAVUMetadataFromKVPairs |
Definition at line 501 of file extractAvuMS.cpp.
References MsParam::inOutStruct, KeyValPair_MS_T, RE_TEST_MACRO, RuleExecInfo::rsComm, setAVUMetadataFromKVPairs(), STR_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetQuota | ( | msParam_t * | type, |
| msParam_t * | name, | ||
| msParam_t * | resource, | ||
| msParam_t * | value, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | type | - a STR_MS_T - Can be either "user" or "group" |
| [in] | name | - a STR_MS_T with the name of the user or group |
| [in] | resource | - Optional - a STR_MS_T with the name of the resource where the quota will apply, or "total" for the quota to be system-wide. |
| [in] | value | - an INT_MST_T or DOUBLE_MS_T or STR_MS_T with the quota (in bytes) |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 669 of file icatAdminMS.cpp.
References generalAdminInp_t::arg0, generalAdminInp_t::arg1, generalAdminInp_t::arg2, generalAdminInp_t::arg3, generalAdminInp_t::arg4, generalAdminInp_t::arg5, generalAdminInp_t::arg6, generalAdminInp_t::arg7, generalAdminInp_t::arg8, generalAdminInp_t::arg9, AuthInfo::authFlag, UserInfo::authInfo, DOUBLE_MS_T, INT_MS_T, LOCAL_PRIV_USER_AUTH, LOG_ERROR, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), RuleExecInfo::rsComm, rsGeneralAdmin(), STR_MS_T, type, RuleExecInfo::uoic, and UserInfo::userName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetReplComment | ( | msParam_t * | inpParam1, |
| msParam_t * | inpParam2, | ||
| msParam_t * | inpParam3, | ||
| msParam_t * | inpParam4, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inpParam1 | - a STR_MS_T with the id of the object (can be null if unknown, the next param will then be used) |
| [in] | inpParam2 | - a msParam of type DataObjInp_MS_T or a STR_MS_T which would be taken as dataObj path |
| [in] | inpParam3 | - a INT which gives the replica number |
| [in] | inpParam4 | - a STR_MS_T containing the comment |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 1197 of file reSysDataObjOpr.cpp.
References addKeyVal(), DATA_COMMENTS_KW, DataObjInfo::dataId, ModDataObjMetaInp::dataObjInfo, IN_PDMO_KW, LOG_ERROR, LOG_NOTICE, NULL, DataObjInfo::objPath, parseMspForPosInt(), parseMspForStr(), RE_TEST_MACRO, ModDataObjMetaInp::regParam, DataObjInfo::replNum, DataObjInfo::rescHier, rodsLog(), RuleExecInfo::rsComm, rsModDataObjMeta(), and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSetResource | ( | msParam_t * | xrescName, |
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | xrescName | - is a msParam of type STR_MS_T |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 140 of file icatGeneralMS.cpp.
References RuleExecInfo::doi, MsParam::inOutStruct, and DataObjInfo::rescName.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiSleep | ( | msParam_t * | secPtr, |
| msParam_t * | microsecPtr, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | secPtr | - secPtr is a msParam of type STR_MS_T which is seconds |
| [in] | microsecPtr | - microsecPrt is a msParam of type STR_MS_T which is microseconds |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 553 of file nre.systemMS.cpp.
References MsParam::inOutStruct, and rodsSleep().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiStrArray2String | ( | msParam_t * | inSAParam, |
| msParam_t * | outStr, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inSAParam | - a msParam of type strArr_MS_T which is an array of strings. |
| [out] | outStr | - a msParam of type STR_MS_T which a string with %-separators. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 304 of file keyValPairMS.cpp.
References i, MsParam::inOutStruct, StrArray::len, RE_TEST_MACRO, StrArray::size, STR_MS_T, MsParam::type, and StrArray::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiString2KeyValPair | ( | msParam_t * | inBufferP, |
| msParam_t * | outKeyValPairP, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inBufferP | - a msParam of type STR_MS_T which is key=value pairs separated by %-sign. |
| [out] | outKeyValPairP | - a msParam of type KeyValPair_MS_T which is a keyValuePair structure. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 176 of file keyValPairMS.cpp.
References addKeyVal(), buf, i, MsParam::inOutStruct, KeyValPair_MS_T, StrArray::len, NULL, parseMultiStr(), RE_TEST_MACRO, StrArray::size, MsParam::type, and StrArray::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiString2StrArray | ( | msParam_t * | inBufferP, |
| msParam_t * | outStrArrayP, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | inBufferP | - a msParam of type STR_MS_T which is key=value pairs separated by %-sign. |
| [out] | outStrArrayP | - a msParam of type StrArray_MS_T which is a structure of array of string. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 246 of file keyValPairMS.cpp.
References buf, i, MsParam::inOutStruct, NULL, parseMultiStr(), RE_TEST_MACRO, STR_MS_T, StrArray_MS_T, and MsParam::type.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| msiStrToBytesBuf | ( | msParam_t * | str_msp, |
| msParam_t * | buf_msp, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | str_msp | - a STR_MS_T |
| [out] | buf_msp | - a BUF_LEN_MS_T |
| [in,out] | - | The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 824 of file nre.systemMS.cpp.
References BytesBuf::buf, fillBufLenInMsParam(), BytesBuf::len, LOG_ERROR, NULL, parseMspForStr(), and rodsLog().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int msiTakeThreeArgumentsAndDoNothing | ( | msParam_t * | arg1, |
| msParam_t * | arg2, | ||
| msParam_t * | arg3, | ||
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 141 of file testMS.cpp.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int print_hello | ( | ruleExecInfo_t * | c | ) |
rodsLog(LOG_NOTICE, "TTTTT Hello\n"); rodsLogAndErrorMsg(LOG_NOTICE, &(rei->rsComm->rError),-1, "VVVVV Hello\n");
Definition at line 4 of file testMS.cpp.
References _writeString(), and RE_TEST_MACRO.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int print_hello_arg | ( | msParam_t * | xs, |
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 30 of file miscMS.cpp.
References MsParam::inOutStruct, and RE_TEST_MACRO.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int recover_msiCreateCollByAdmin | ( | msParam_t * | parColl, |
| msParam_t * | childName, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| int recover_msiCreateUser | ( | ruleExecInfo_t * | rei | ) |
| int recover_print_hello | ( | ruleExecInfo_t * | c | ) |
Definition at line 15 of file testMS.cpp.
References RE_TEST_MACRO.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| int remoteExec | ( | msParam_t * | hostName, |
| msParam_t * | condition, | ||
| msParam_t * | workflow, | ||
| msParam_t * | recoverWorkFlow, | ||
| ruleExecInfo_t * | rei | ||
| ) |
Definition at line 288 of file nre.systemMS.cpp.
References addKeyVal(), ExecMyRuleInp::addr, ALL_MS_PARAM_KW, carryOverMsParam(), clearMsParamArray(), ExecMyRuleInp::condInput, i, MsParam::inOutStruct, ExecMyRuleInp::inpParamArray, KeyValPair::len, LONG_NAME_LEN, META_STR_LEN, RuleExecInfo::msParamArray, ExecMyRuleInp::myRule, NULL, ExecMyRuleInp::outParamDesc, parseHostAddrStr(), replMsParamArray(), RuleExecInfo::rsComm, rsExecMyRule(), and rstrcpy().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| writeBytesBuf | ( | msParam_t * | where, |
| msParam_t * | inBuf, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | where | - a msParam of type STR_MS_T which is the buffer name in ruleExecOut. It can be stdout or stderr. |
| [in] | inBuf | - a msParam of type BUF_LEN_MS_T. |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 161 of file printMS.cpp.
References _writeString(), BytesBuf::buf, MsParam::inOutStruct, MsParam::inpOutBuf, MsParam::label, BytesBuf::len, NULL, and strncpy().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| writeKeyValPairs | ( | msParam_t * | where, |
| msParam_t * | inKVPair, | ||
| msParam_t * | separator, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | where | - a msParam of type STR_MS_T which is the buffer name in ruleExecOut. It can be stdout or stderr. |
| [in] | inKVPair | - a msParam of type KeyValPair_MS_T |
| [in] | separator | - Optional - a msParam of type STR_MS_T, the desired parameter |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 223 of file printMS.cpp.
References _writeString(), i, if(), MsParam::inOutStruct, KeyValPair_MS_T, KeyValPair::keyWord, MsParam::label, KeyValPair::len, LOG_ERROR, MAX_COND_LEN, NULL, parseMspForStr(), RE_TEST_MACRO, rodsLog(), size, RuleExecInfo::status, MsParam::type, and KeyValPair::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
| writePosInt | ( | msParam_t * | where, |
| msParam_t * | inInt, | ||
| ruleExecInfo_t * | rei | ||
| ) |
| [in] | where | - a msParam of type STR_MS_T which is the buffer name in ruleExecOut. |
| [in] | inInt | - the integer to write |
| [in,out] | rei | - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation. |
| 0 | on success |
Definition at line 106 of file printMS.cpp.
References _writeString(), MsParam::inOutStruct, MsParam::label, LONG_NAME_LEN, NULL, and parseMspForPosInt().
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
1.9.5