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.
![]() ![]() |
#include "irods/rods.h"
#include "irods/objMetaOpr.hpp"
#include "irods/dataObjRepl.h"
#include "irods/modDataObjMeta.h"
Go to the source code of this file.
msiDeleteDisallowed | ( | 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 638 of file reSysDataObjOpr.cpp.
References RE_TEST_MACRO, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiNoChkFilePathPerm | ( | 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. |
NO_CHK_PATH_PERM |
Definition at line 718 of file reSysDataObjOpr.cpp.
References NO_CHK_PATH_PERM, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiNoTrashCan | ( | 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. |
NO_TRASH_CAN |
Definition at line 811 of file reSysDataObjOpr.cpp.
References NO_TRASH_CAN, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiOprDisallowed | ( | 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 677 of file reSysDataObjOpr.cpp.
References RE_TEST_MACRO, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetChkFilePathPerm | ( | msParam_t * | xchkType, |
ruleExecInfo_t * | rei | ||
) |
[in] | xchkType | - Required - a msParam of type STR_MS_T which defines the check type to set. Valid values are DO_CHK_PATH_PERM_STR, NO_CHK_PATH_PERM_STR, CHK_NON_VAULT_PATH_PERM_STR and DISALLOW_PATH_REG_STR. |
[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. |
DO_CHK_PATH_PERM,NO_CHK_PATH_PERM,CHK_NON_VAULT_PATH_PERM | or DISALLOW_PATH_REG. |
Definition at line 755 of file reSysDataObjOpr.cpp.
References CHK_NON_VAULT_PATH_PERM, CHK_NON_VAULT_PATH_PERM_STR, DISALLOW_PATH_REG, DISALLOW_PATH_REG_STR, DO_CHK_PATH_PERM, DO_CHK_PATH_PERM_STR, if(), MsParam::inOutStruct, LOG_ERROR, NO_CHK_PATH_PERM, NO_CHK_PATH_PERM_STR, rodsLog(), and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetDataObjAvoidResc | ( | msParam_t * | xavoidResc, |
ruleExecInfo_t * | rei | ||
) |
[in] | xavoidResc | - a msParam of type STR_MS_T - the name of the resource to avoid |
[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 284 of file reSysDataObjOpr.cpp.
References RuleExecInfo::doi, RuleExecInfo::doinp, getWriteFlag(), MsParam::inOutStruct, NULL, DataObjInp::openFlags, RE_TEST_MACRO, requeDataObjInfoByResc(), and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetDataObjPreferredResc | ( | msParam_t * | xpreferredRescList, |
ruleExecInfo_t * | rei | ||
) |
[in] | xpreferredRescList | - a msParam of type STR_MS_T, comma-delimited list of resources |
[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 211 of file reSysDataObjOpr.cpp.
References RuleExecInfo::doi, RuleExecInfo::doinp, getWriteFlag(), i, MsParam::inOutStruct, StrArray::len, DataObjInfo::next, NULL, DataObjInp::openFlags, parseMultiStr(), RE_TEST_MACRO, requeDataObjInfoByResc(), StrArray::size, RuleExecInfo::status, and StrArray::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetDataTypeFromExt | ( | 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 338 of file reSysDataObjOpr.cpp.
References addInxIval(), addInxVal(), addKeyVal(), clearGenQueryInp(), COL_TOKEN_NAME, COL_TOKEN_NAMESPACE, COL_TOKEN_VALUE2, DATA_TYPE_KW, ModDataObjMetaInp::dataObjInfo, RuleExecInfo::doi, ERROR, freeGenQueryOut(), IN_PDMO_KW, LOG_DEBUG, MAX_NAME_LEN, GenQueryInp::maxRows, NULL, DataObjInfo::objPath, RE_TEST_MACRO, ModDataObjMetaInp::regParam, DataObjInfo::rescHier, rodsLog(), GenQueryOut::rowCnt, RuleExecInfo::rsComm, rsGenQuery(), rsModDataObjMeta(), GenQueryInp::selectInp, splitPathByKey(), GenQueryInp::sqlCondInp, GenQueryOut::sqlResult, RuleExecInfo::status, svrCloseQueryOut(), and SqlResult::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetDefaultResc | ( | msParam_t * | xdefaultRescList, |
msParam_t * | xoptionStr, | ||
ruleExecInfo_t * | rei | ||
) |
[in] | xdefaultRescList | - Required - a msParam of type STR_MS_T which is a list of %-delimited resourceNames. It is a resource to use if no resource is input. A "null" means there is no defaultResc. |
[in] | xoptionStr | - a msParam of type STR_MS_T which is an option (preferred, forced, random) with random as default. A "forced" input means the defaultResc will be used regardless of the user input. The forced action only apply to to users with normal privilege. |
[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 59 of file reSysDataObjOpr.cpp.
References irods::error::code(), DataObjInp::condInput, RuleExecInfo::doinp, MsParam::inOutStruct, NAME_LEN, PASS, RE_TEST_MACRO, RuleExecInfo::rescName, RuleExecInfo::rsComm, irods::set_default_resource(), and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetGraftPathScheme | ( | msParam_t * | xaddUserName, |
msParam_t * | xtrimDirCnt, | ||
ruleExecInfo_t * | rei | ||
) |
[in] | xaddUserName | - This msParam specifies whether the userName should be added to the physical path. e.g. $vaultPath/$userName/$logicalPath. "xaddUserName" can have two values - yes or no. |
[in] | xtrimDirCnt | - This msParam specifies the number of leading directory elements of the logical path to trim. Sometimes it may not be desirable to graft the entire logical path. e.g.,for a logicalPath /myZone/home/me/foo/bar, it may be desirable to graft just the part "foo/bar" to the vaultPath. "xtrimDirCnt" should be set to 3 in this case. |
[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 988 of file reSysDataObjOpr.cpp.
References addMsParam(), VaultPathPolicy::addUserName, getMsParamByLabel(), GRAFT_PATH_S, if(), RuleExecInfo::inOutMsParamArray, MsParam::inOutStruct, LOG_ERROR, NULL, RE_TEST_MACRO, rodsLog(), VaultPathPolicy::scheme, RuleExecInfo::status, VaultPathPolicy::trimDirCnt, VAULT_PATH_POLICY, and VaultPathPolicy_MS_T.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetNoDirectRescInp | ( | msParam_t * | xrescList, |
ruleExecInfo_t * | rei | ||
) |
[in] | xrescList | - InpParam is a xrescList of type STR_MS_T which is a list of %-delimited resourceNames e.g., resc1resc2resc3. |
[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 | if user set resource is allowed or user is privileged. |
USER_DIRECT_RESC_INPUT_ERR | if resource is taboo. |
Definition at line 119 of file reSysDataObjOpr.cpp.
References AuthInfo::authFlag, UserInfo::authInfo, BACKUP_RESC_NAME_KW, DataObjInp::condInput, DEF_RESC_NAME_KW, DEST_RESC_NAME_KW, RuleExecInfo::doinp, getValByKey(), i, MsParam::inOutStruct, StrArray::len, LOCAL_PRIV_USER_AUTH, NULL, parseMultiStr(), RsComm::proxyUser, RE_TEST_MACRO, RESC_NAME_KW, RuleExecInfo::rsComm, StrArray::size, RuleExecInfo::status, and StrArray::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetNumThreads | ( | msParam_t * | xsizePerThrInMbStr, |
msParam_t * | xmaxNumThrStr, | ||
msParam_t * | xwindowSizeStr, | ||
ruleExecInfo_t * | rei | ||
) |
[in] | xsizePerThrInMbStr | - The number of threads is computed using: numThreads = fileSizeInMb / sizePerThrInMb + 1 where sizePerThrInMb is an integer value in MBytes. It also accepts the word "default" which sets sizePerThrInMb to a default value of 32. |
[in] | xmaxNumThrStr | - The maximum number of threads to use. It accepts integer value up to 64. It also accepts the word "default" which sets maxNumThr to a default value of 4. |
[in] | xwindowSizeStr | - The TCP window size in Bytes for the parallel transfer. A value of 0 or "default" means a default size of 1,048,576 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 485 of file reSysDataObjOpr.cpp.
References MsParam::inOutStruct, and irods::KW_CFG_DEF_NUMBER_TRANSFER_THREADS.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetPublicUserOpr | ( | msParam_t * | xoprList, |
ruleExecInfo_t * | rei | ||
) |
[in] | xoprList | - Only 2 operations are allowed - "read" - read files; "query" - browse some system level metadata. More than one operation can be input using the character "%" as separator. e.g., readquery. |
[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 850 of file reSysDataObjOpr.cpp.
References AuthInfo::authFlag, UserInfo::authInfo, RsComm::clientUser, i, MsParam::inOutStruct, StrArray::len, LOCAL_PRIV_USER_AUTH, LOG_ERROR, NULL, parseMultiStr(), PUBLIC_USER_AUTH, RE_TEST_MACRO, REMOTE_PRIV_USER_AUTH, rodsLog(), RuleExecInfo::rsComm, setApiPerm(), StrArray::size, RuleExecInfo::status, and StrArray::value.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetRandomScheme | ( | 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 1083 of file reSysDataObjOpr.cpp.
References addMsParam(), getMsParamByLabel(), if(), RuleExecInfo::inOutMsParamArray, MsParam::inOutStruct, NULL, RANDOM_S, RE_TEST_MACRO, VaultPathPolicy::scheme, RuleExecInfo::status, VAULT_PATH_POLICY, and VaultPathPolicy_MS_T.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
msiSetRescQuotaPolicy | ( | 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. |
RESC_QUOTA_OFF | or RESC_QUOTA_ON. |
Definition at line 1145 of file reSysDataObjOpr.cpp.
References MsParam::inOutStruct, RE_TEST_MACRO, RESC_QUOTA_OFF, RESC_QUOTA_ON, RescQuotaPolicy, and RuleExecInfo::status.
Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().
Definition at line 920 of file reSysDataObjOpr.cpp.
References apiTableLookup(), irods::get_server_api_table(), LOCAL_PRIV_USER_AUTH, LOG_ERROR, rodsLog(), and RsApiTable.
Referenced by msiSetPublicUserOpr().