Go to the source code of this file.
|
int | msiAdmShowDVM (msParam_t *, ruleExecInfo_t *rei) |
|
int | _admShowDVM (ruleExecInfo_t *rei, rulevardef_t *inRuleVarDef, int inx) |
|
int | msiAdmShowFNM (msParam_t *, ruleExecInfo_t *rei) |
|
int | _admShowFNM (ruleExecInfo_t *rei, rulefmapdef_t *inRuleFuncMapDef, int inx) |
|
int | msiAdmReadDVMapsFromFileIntoStruct (msParam_t *inDvmFileNameParam, msParam_t *outCoreDVMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmInsertDVMapsFromStructIntoDB (msParam_t *inDvmBaseNameParam, msParam_t *inCoreDVMapStruct, ruleExecInfo_t *rei) |
|
int | msiGetDVMapsFromDBIntoStruct (msParam_t *inDvmBaseNameParam, msParam_t *inVersionParam, msParam_t *outCoreDVMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmWriteDVMapsFromStructIntoFile (msParam_t *inDvmFileNameParam, msParam_t *inCoreDVMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmReadFNMapsFromFileIntoStruct (msParam_t *inFnmFileNameParam, msParam_t *outCoreFNMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmInsertFNMapsFromStructIntoDB (msParam_t *inFnmBaseNameParam, msParam_t *inCoreFNMapStruct, ruleExecInfo_t *rei) |
|
int | msiGetFNMapsFromDBIntoStruct (msParam_t *inFnmBaseNameParam, msParam_t *inVersionParam, msParam_t *outCoreFNMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmWriteFNMapsFromStructIntoFile (msParam_t *inFnmFileNameParam, msParam_t *inCoreFNMapStruct, ruleExecInfo_t *rei) |
|
int | msiAdmReadMSrvcsFromFileIntoStruct (msParam_t *inMsrvcFileNameParam, msParam_t *outCoreMsrvcStruct, ruleExecInfo_t *rei) |
|
int | msiAdmInsertMSrvcsFromStructIntoDB (msParam_t *, msParam_t *inCoreMsrvcStruct, ruleExecInfo_t *rei) |
|
int | msiGetMSrvcsFromDBIntoStruct (msParam_t *inStatus, msParam_t *outCoreMsrvcStruct, ruleExecInfo_t *rei) |
|
int | msiAdmWriteMSrvcsFromStructIntoFile (msParam_t *inMsrvcFileNameParam, msParam_t *inCoreMsrvcStruct, ruleExecInfo_t *rei) |
|
◆ _admShowDVM()
◆ _admShowFNM()
◆ msiAdmInsertDVMapsFromStructIntoDB()
- Description:\n Writes a DVM structure into the current DVM base
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that reads the contents of a DVM structure and writes them as a new DVM base set in the iCAT.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inDvmBaseNameParam | - a msParam of type STR_MS_T, the name of the target database |
[in] | inCoreDVMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- iCAT tables are modified
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadDVMapsFromFileIntoStruct, msiGetDVMapsFromDBIntoStruct, msiAdmWriteDVMapsFromStructIntoFile
Definition at line 260 of file nre.ruleAdminMS.cpp.
References DVMapStruct_MS_T, i, MsParam::inOutStruct, insertDVMapsIntoDB(), isUserPrivileged(), NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
◆ msiAdmInsertFNMapsFromStructIntoDB()
- Description:\n Writes a FNM structure into the current FNM base
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that reads the contents of a FNM structure and writes them as a new FNM base set in the iCAT.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inFnmBaseNameParam | - a msParam of type STR_MS_T, the name of the target database |
[in] | inCoreFNMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- iCAT tables are modified
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadFNMapsFromFileIntoStruct, msiGetFNMapsFromDBIntoStruct, msiAdmWriteFNMapsFromStructIntoFile
Definition at line 547 of file nre.ruleAdminMS.cpp.
References FNMapStruct_MS_T, i, MsParam::inOutStruct, insertFNMapsIntoDB(), isUserPrivileged(), NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
◆ msiAdmInsertMSrvcsFromStructIntoDB()
- Description:\n Writes a microservice structure into the current microservice base
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that reads the contents of a microservice structure and writes them as a new microservice base set in the iCAT.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | - | a msParam of type STR_MS_T, the name of the target database |
[in] | inCoreMsrvcStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- iCAT tables are modified
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadMSrvcsFromFileIntoStruct, msiGetMSrvcsFromDBIntoStruct, msiAdmWriteMSrvcsFromStructIntoFile
Definition at line 831 of file nre.ruleAdminMS.cpp.
References coreMsrvcStruct, i, MsParam::inOutStruct, insertMSrvcsIntoDB(), isUserPrivileged(), MsrvcStruct_MS_T, NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, and MsParam::type.
◆ msiAdmReadDVMapsFromFileIntoStruct()
- Description:\n Reads a DVM configuration file into a DVM structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
Reads the given file in the configuration directory '/etc/irods' or any file in the server local file system and puts them into a DVM structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inDvmFileNameParam | - a msParam of type STR_MS_T |
[in] | outCoreDVMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmInsertDVMapsFromStructIntoDB, msiGetDVMapsFromDBIntoStruct, msiAdmWriteDVMapsFromStructIntoFile
Definition at line 183 of file nre.ruleAdminMS.cpp.
References DVMapStruct_MS_T, i, MsParam::inOutStruct, isUserPrivileged(), rulevardef_t::MaxNumOfDVars, NULL, RE_TEST_MACRO, readDVarStructFromFile(), RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
◆ msiAdmReadFNMapsFromFileIntoStruct()
- Description:\n Reads a FNM configuration file into a FNM structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
Reads the given file in the configuration directory '/etc/irods' or any file in the server local file system and puts them into a FNM structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inFnmFileNameParam | - a msParam of type STR_MS_T |
[in] | outCoreFNMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmInsertFNMapsFromStructIntoDB, msiGetFNMapsFromDBIntoStruct, msiAdmWriteFNMapsFromStructIntoFile
Definition at line 465 of file nre.ruleAdminMS.cpp.
References FNMapStruct_MS_T, i, MsParam::inOutStruct, isUserPrivileged(), rulefmapdef_t::MaxNumOfFMaps, NULL, RE_TEST_MACRO, readFuncMapStructFromFile(), RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
◆ msiAdmReadMSrvcsFromFileIntoStruct()
- Description:\n Reads a microservice configuration file into a microservice structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
Reads the given file in the configuration directory '/etc/irods' or any file in the server local file system and puts them into a microservice structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inMsrvcFileNameParam | - a msParam of type STR_MS_T |
[in] | outCoreMsrvcStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmInsertMSrvcsFromStructIntoDB, msiGetMSrvcsFromDBIntoStruct, msiAdmWriteMSrvcsFromStructIntoFile
Definition at line 753 of file nre.ruleAdminMS.cpp.
References i, MsParam::inOutStruct, isUserPrivileged(), msrvcStruct_t::MaxNumOfMsrvcs, MsrvcStruct_MS_T, NULL, RE_TEST_MACRO, readMsrvcStructFromFile(), RuleExecInfo::rsComm, STR_MS_T, and MsParam::type.
◆ msiAdmShowDVM()
- Description:\n This is a microservice that reads the data-value-mapping data structure
- in the Rule Engine and pretty-prints that structure to the stdout buffer.
- Module:
- core
- Since
- pre-2.1
- Note
- This microservice uses a dummy parameter.
-
Lists the currently loaded dollar variable mappings from the rule engine memory. The list is written to stdout in ruleExecOut.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | - | is a msParam (not used for anything, a dummy 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. |
- Session Variables Used:
- none
- Session Variables Modified:
- rei->MsParamArray->MsParam->ruleExecOut->stdout is modified
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmShowFNM
Definition at line 55 of file nre.ruleAdminMS.cpp.
References _admShowDVM(), _writeString(), appRuleVarDef, coreRuleVarDef, and i.
◆ msiAdmShowFNM()
- Description:\n This is a microservice that reads the function-name-mapping data structure
- in the Rule Engine and pretty-prints that structure to the stdout buffer.
- Module:
- core
- Since
- pre-2.1
- Note
- This microservice has a dummy parameter.
-
This microservice lists the currently loaded microServices and action name mappings from the rule engine memory. The list is written to stdout in ruleExecOut.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | - | is a msParam (not used for anything, a dummy 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. |
- Session Variables Used:
- none
- Session Variables Modified:
- rei->MsParamArray->MsParam->ruleExecOut->stdout is modified
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmShowDVM
Definition at line 118 of file nre.ruleAdminMS.cpp.
References _admShowFNM(), _writeString(), appRuleFuncMapDef, coreRuleFuncMapDef, and i.
◆ msiAdmWriteDVMapsFromStructIntoFile()
- Description:\n Writes to file the DVMs within a given DVM structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that writes into a given file the contents of a given DVM structure. The file can be in '/etc/irods' or any path on the server local file system.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inDvmFileNameParam | - a msParam of type STR_MS_T, the name of the file to be written |
[in] | inCoreDVMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n A new DVM file is created
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadDVMapsFromFileIntoStruct, msiAdmInsertDVMapsFromStructIntoDB, msiGetDVMapsFromDBIntoStruct
Definition at line 404 of file nre.ruleAdminMS.cpp.
References DVMapStruct_MS_T, i, MsParam::inOutStruct, isUserPrivileged(), NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, MsParam::type, and writeDVMapsIntoFile().
◆ msiAdmWriteFNMapsFromStructIntoFile()
- Description:\n Writes to file the FNMs within a given FNM structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that writes into a given file the contents of a given FNM structure. The file can be in '/etc/irods' or any path on the server local file system.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inFnmFileNameParam | - a msParam of type STR_MS_T, the name of the file to be written |
[in] | inCoreFNMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n A new FNM file is created
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadFNMapsFromFileIntoStruct, msiAdmInsertFNMapsFromStructIntoDB, msiGetFNMapsFromDBIntoStruct
Definition at line 692 of file nre.ruleAdminMS.cpp.
References FNMapStruct_MS_T, i, MsParam::inOutStruct, isUserPrivileged(), NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, MsParam::type, and writeFNMapsIntoFile().
◆ msiAdmWriteMSrvcsFromStructIntoFile()
- Description:\n Writes to file the microservices within a given microservice structure
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that writes into a given file the contents of a given microservice structure. The file can be in '/etc/irods' or any path on the server local file system.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inMsrvcFileNameParam | - a msParam of type STR_MS_T, the name of the file to be written |
[in] | inCoreMsrvcStruct | - a msParam of type MsrvcStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n A new microservice file is created
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadMSrvcsFromFileIntoStruct, msiAdmInsertMSrvcsFromStructIntoDB, msiGetMSrvcsFromDBIntoStruct
Definition at line 975 of file nre.ruleAdminMS.cpp.
References i, MsParam::inOutStruct, isUserPrivileged(), MsrvcStruct_MS_T, NULL, RE_TEST_MACRO, RuleExecInfo::rsComm, STR_MS_T, MsParam::type, and writeMSrvcsIntoFile().
◆ msiGetDVMapsFromDBIntoStruct()
- Description:\n Populates a DVM structure with DVMs from the given base name
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that queries the iCAT for DVM with a given base name and version number and populates a DVM rule structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inDvmBaseNameParam | - a msParam of type STR_MS_T, the name of the base being queried |
[in] | inVersionParam | - a msParam of type STR_MS_T, which is the version string of the base being queried (use 0 for current version) |
[in] | outCoreDVMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadDVMapsFromFileIntoStruct, msiAdmInsertDVMapsFromStructIntoDB, msiAdmWriteDVMapsFromStructIntoFile
Definition at line 323 of file nre.ruleAdminMS.cpp.
References DVMapStruct_MS_T, i, MsParam::inOutStruct, rulevardef_t::MaxNumOfDVars, NULL, RE_TEST_MACRO, readDVMapStructFromDB(), STR_MS_T, and MsParam::type.
◆ msiGetFNMapsFromDBIntoStruct()
- Description:\n Populates a FNM structure with FNMs from the given base name
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that queries the iCAT for FNM with a given base name and version number and populates a FNM rule structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inFnmBaseNameParam | - a msParam of type STR_MS_T, the name of the base being queried |
[in] | inVersionParam | - a msParam of type STR_MS_T, which is the version string of the base being queried (use 0 for current version) |
[in] | outCoreFNMapStruct | - a msParam of type RuleStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadFNMapsFromFileIntoStruct, msiAdmInsertFNMapsFromStructIntoDB, msiAdmWriteFNMapsFromStructIntoFile
Definition at line 610 of file nre.ruleAdminMS.cpp.
References FNMapStruct_MS_T, i, MsParam::inOutStruct, rulefmapdef_t::MaxNumOfFMaps, NULL, RE_TEST_MACRO, readFNMapStructFromDB(), STR_MS_T, and MsParam::type.
◆ msiGetMSrvcsFromDBIntoStruct()
- Description:\n Populates a microservice structure with microservices from the given base name
- Module:
- core
- Since
- after 2.5
- Note
- This microservice requires iRODS administration privileges.
-
This is a microservice that queries the iCAT for microservices with a given base name and version number and populates a microservice rule structure.
- Example Usage:\n See clients/icommands/test/rules/
- Parameters
-
[in] | inStatus | - a msParam of type INT_MS_T or an integer stored in STR_MS_T, normally 1 if microservice is available, 0 otherwise. |
[out] | outCoreMsrvcStruct | - a msParam of type MsrvcStruct_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. |
- Session Variables Used:
- none
- Session Variables Modified:
- none
- iCAT Attributes Used:
- none
- iCAT Attributes Modified:
- none
- Side Effect:\n none
- Returns
- integer
- Return values
-
- Precondition
- none
- Postcondition
- none
- See also
- msiAdmReadMSrvcsFromFileIntoStruct, msiAdmInsertMSrvcsFromStructIntoDB, msiAdmWriteMSrvcsFromStructIntoFile
Definition at line 890 of file nre.ruleAdminMS.cpp.
References i, MsParam::inOutStruct, INT_MS_T, msrvcStruct_t::MaxNumOfMsrvcs, MsrvcStruct_MS_T, NULL, RE_TEST_MACRO, readMsrvcStructFromDB(), STR_MS_T, and MsParam::type.